From f0943278c17fd60f41b86a61aefbf2a2b97cd49e Mon Sep 17 00:00:00 2001
From: Joe Conway <mail@joeconway.com>
Date: Sat, 6 Dec 2003 23:10:23 +0000
Subject: [PATCH] Documentation update for previously committed changes:
read-only GUC variables and pg_settings view.
---
doc/src/sgml/catalogs.sgml | 20 +++++++++-
doc/src/sgml/runtime.sgml | 77 +++++++++++++++++++++++++++++++++++++-
2 files changed, 95 insertions(+), 2 deletions(-)
diff --git a/doc/src/sgml/catalogs.sgml b/doc/src/sgml/catalogs.sgml
index 3cd9922a0ca..892502bb276 100644
--- a/doc/src/sgml/catalogs.sgml
+++ b/doc/src/sgml/catalogs.sgml
@@ -1,6 +1,6 @@
<!--
Documentation of the system catalogs, directed toward PostgreSQL developers
- $PostgreSQL: pgsql/doc/src/sgml/catalogs.sgml,v 2.80 2003/11/29 19:51:36 pgsql Exp $
+ $PostgreSQL: pgsql/doc/src/sgml/catalogs.sgml,v 2.81 2003/12/06 23:10:21 joe Exp $
-->
<chapter id="catalogs">
@@ -4050,6 +4050,24 @@
<entry></entry>
<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>
diff --git a/doc/src/sgml/runtime.sgml b/doc/src/sgml/runtime.sgml
index 009fcfb8551..49f48ca3be3 100644
--- a/doc/src/sgml/runtime.sgml
+++ b/doc/src/sgml/runtime.sgml
@@ -1,5 +1,5 @@
<!--
-$PostgreSQL: pgsql/doc/src/sgml/runtime.sgml,v 1.225 2003/12/04 21:24:56 petere Exp $
+$PostgreSQL: pgsql/doc/src/sgml/runtime.sgml,v 1.226 2003/12/06 23:10:23 joe Exp $
-->
<Chapter Id="runtime">
@@ -2517,6 +2517,81 @@ dynamic_library_path = '/usr/local/lib/postgresql:/home/my_project/lib:$libdir'
</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. 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>