read-only GUC variables - supporting doc changes - Mailing list pgsql-patches

From Joe Conway
Subject read-only GUC variables - supporting doc changes
Date
Msg-id 3FD16174.1050200@joeconway.com
Whole thread Raw
Responses Re: read-only GUC variables - supporting doc changes
List pgsql-patches
The attached is the supporting documentation for the read-only GUC
variable changes. Comments?

Thanks,

Joe
Index: doc/src/sgml/catalogs.sgml
===================================================================
RCS file: /opt/src/cvs/pgsql-server/doc/src/sgml/catalogs.sgml,v
retrieving revision 2.80
diff -c -r2.80 catalogs.sgml
*** doc/src/sgml/catalogs.sgml    29 Nov 2003 19:51:36 -0000    2.80
--- doc/src/sgml/catalogs.sgml    6 Dec 2003 02:11:37 -0000
***************
*** 4051,4056 ****
--- 4051,4074 ----
        <entry>current value of the parameter</entry>
       </row>
       <row>
+       <entry><structfield>category</structfield></entry>
+       <entry><type>text</type></entry>
+       <entry></entry>
+       <entry>logical group of the parameter</entry>
+      </row>
+      <row>
+       <entry><structfield>short_desc</structfield></entry>
+       <entry><type>text</type></entry>
+       <entry></entry>
+       <entry>a brief description of the parameter</entry>
+      </row>
+      <row>
+       <entry><structfield>extra_desc</structfield></entry>
+       <entry><type>text</type></entry>
+       <entry></entry>
+       <entry>additional, more detailed, information about the parameter</entry>
+      </row>
+      <row>
        <entry><structfield>context</structfield></entry>
        <entry><type>text</type></entry>
        <entry></entry>
Index: doc/src/sgml/runtime.sgml
===================================================================
RCS file: /opt/src/cvs/pgsql-server/doc/src/sgml/runtime.sgml,v
retrieving revision 1.224
diff -c -r1.224 runtime.sgml
*** doc/src/sgml/runtime.sgml    1 Dec 2003 22:07:56 -0000    1.224
--- doc/src/sgml/runtime.sgml    6 Dec 2003 03:40:15 -0000
***************
*** 2517,2522 ****
--- 2517,2603 ----
      </sect3>
     </sect2>

+    <sect2 id="runtime-config-compiler">
+     <title>Compiled-in Options</title>
+
+     <para>
+      The following options are available read-only, and are determined
+      at source code compile time.  As such, they have been excluded from the
+      sample <filename>postgresql.conf</> file.  They determine various aspects
+      of <productname>PostgreSQL</productname> behavior that may be of interest
+      to certain applications, particularly administrative front-ends.
+     </para>
+
+     <variablelist>
+
+      <varlistentry>
+       <term><varname>block_size</varname> (<type>integer</type>)</term>
+       <listitem>
+        <para>
+         Shows the size of a disk block.  It is determined by the value
+         of <literal>BLCKSZ</> when building the server. The default
+         value is 8192 bytes.  Each data file (heap or index) is divided
+         into disk blocks which may be thought of as the unit of I/O.
+         A <productname>PostgreSQL</productname> buffer contains exactly
+         one disk block.  A <productname>PostgreSQL</productname> disk page
+         is an abstraction layered on top of a disk block.  Specifically,
+         while a disk block can be unformatted, a disk page is always a
+         formatted page.  The <varname>shared_buffers</varname> setting is
+         influenced by <varname>block_size</varname>.  See
+         <xref linkend="runtime-config-resource"> for information.
+        </para>
+       </listitem>
+      </varlistentry>
+
+      <varlistentry>
+       <term><varname>integer_datetimes</varname> (<type>boolean</type>)</term>
+       <listitem>
+        <para>
+         Shows <literal>on</literal> if <productname>PostgreSQL</productname>
+         was built with support for 64-bit integer dates and times.  It is
+         set by configuring with <literal>--enable-integer-datetimes</literal>.
+         The default value is <literal>off</literal>.
+        </para>
+       </listitem>
+      </varlistentry>
+
+      <varlistentry>
+       <term><varname>max_function_args</varname> (<type>integer</type>)</term>
+       <listitem>
+        <para>
+         Shows the maximum number of function arguments. It is determined by
+         the value of <literal>FUNC_MAX_ARGS</> when building the server. The
+         default value is 32.
+        </para>
+       </listitem>
+      </varlistentry>
+
+      <varlistentry>
+       <term><varname>max_identifier_length</varname> (<type>integer</type>)</term>
+       <listitem>
+        <para>
+         Shows the maximum identifier length. It is determined as one less than
+         the value of <literal>NAMEDATALEN</> when building the server. The
+         default value of NAMEDATALEN is 64; therefore the default
+         <varname>max_identifier_length</varname> is 63.
+        </para>
+       </listitem>
+      </varlistentry>
+
+      <varlistentry>
+       <term><varname>max_index_keys</varname> (<type>integer</type>)</term>
+       <listitem>
+        <para>
+         Shows the maximum number of index keys. It is determined by
+         the value of <literal>INDEX_MAX_KEYS</> when building the server. The
+         default value is 32.
+        </para>
+       </listitem>
+      </varlistentry>
+
+     </variablelist>
+    </sect2>
+
     <sect2 id="runtime-config-developer">
      <title>Developer Options</title>


pgsql-patches by date:

Previous
From: David Fetter
Date:
Subject: YA Doc patch
Next
From: Tom Lane
Date:
Subject: Re: read-only GUC variables - supporting doc changes