Minor GUC cleanups: document krb_server_hostname and custom_variable_classes

tglsfdc · tglsfdc · commit 6fcaaf29dad2 · 2005-08-21T03:39:37.000Z
in postgresql.conf.sample, mark custom_variable_classes as SIGHUP not
POSTMASTER to agree with the documentation (I can't see a reason it has
to be POSTMASTER so I think the docs are right).
diff --git 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.345 2005/08/14 22:19:49 petere Exp $
+$PostgreSQL: pgsql/doc/src/sgml/runtime.sgml,v 1.346 2005/08/21 03:39:26 tgl Exp $
 -->
 
 <chapter Id="runtime">
@@ -1027,20 +1027,6 @@ SET ENABLE_SEQSCAN TO OFF;
       </listitem>
      </varlistentry>
 
-     <varlistentry id="guc-krb-caseins-users" xreflabel="krb_caseins_users">
-      <term><varname>krb_caseins_users</varname> (<type>boolean</type>)</term>
-      <indexterm>
-       <primary><varname>krb_caseins_users</varname> configuration parameter</primary>
-      </indexterm>
-      <listitem>
-       <para>
-        Sets if Kerberos usernames should be treated case-insensitive.
-        The default is <literal>off</> (case sensitive). This parameter
-        can only be set at server start.
-       </para>
-      </listitem>
-     </varlistentry>
-
      <varlistentry id="guc-krb-server-hostname" xreflabel="krb_server_hostname">
       <term><varname>krb_server_hostname</varname> (<type>string</type>)</term>
       <indexterm>
@@ -1061,20 +1047,34 @@ SET ENABLE_SEQSCAN TO OFF;
       </listitem>
      </varlistentry>
 
+     <varlistentry id="guc-krb-caseins-users" xreflabel="krb_caseins_users">
+      <term><varname>krb_caseins_users</varname> (<type>boolean</type>)</term>
+      <indexterm>
+       <primary><varname>krb_caseins_users</varname> configuration parameter</primary>
+      </indexterm>
+      <listitem>
+       <para>
+        Sets if Kerberos usernames should be treated case-insensitively.
+        The default is <literal>off</> (case sensitive). This parameter
+        can only be set at server start.
+       </para>
+      </listitem>
+     </varlistentry>
+
      <varlistentry id="guc-db-user-namespace" xreflabel="db_user_namespace">
       <term><varname>db_user_namespace</varname> (<type>boolean</type>)</term>
       <indexterm>
        <primary><varname>db_user_namespace</> configuration parameter</primary>
       </indexterm>
       <listitem>
        <para>
-        This allows per-database user names.  It is off by default.
+        This enables per-database user names.  It is off by default.
        </para>
 
        <para>
         If this is on, you should create users as <literal>username@dbname</>.
         When <literal>username</> is passed by a connecting client,
-        <literal>@</> and the database name is appended to the user
+        <literal>@</> and the database name are appended to the user
         name and that database-specific user name is looked up by the
         server. Note that when you create users with names containing
         <literal>@</> within the SQL environment, you will need to
diff --git a/src/backend/utils/misc/guc.c b/src/backend/utils/misc/guc.c
@@ -10,7 +10,7 @@
  * Written by Peter Eisentraut <peter_e@gmx.net>.
  *
  * IDENTIFICATION
- *	  $PostgreSQL: pgsql/src/backend/utils/misc/guc.c,v 1.284 2005/08/20 23:26:26 tgl Exp $
+ *	  $PostgreSQL: pgsql/src/backend/utils/misc/guc.c,v 1.285 2005/08/21 03:39:34 tgl Exp $
  *
  *--------------------------------------------------------------------
  */
@@ -2029,7 +2029,7 @@ static struct config_string ConfigureNamesString[] =
 	},
 
 	{
-		{"custom_variable_classes", PGC_POSTMASTER, RESOURCES_KERNEL,
+		{"custom_variable_classes", PGC_SIGHUP, CUSTOM_OPTIONS,
 			gettext_noop("Sets the list of known custom variable classes."),
 			NULL,
 			GUC_LIST_INPUT | GUC_LIST_QUOTE
diff --git a/src/backend/utils/misc/postgresql.conf.sample b/src/backend/utils/misc/postgresql.conf.sample
@@ -32,12 +32,12 @@
 # The default values of these variables are driven from the -D command line
 # switch or PGDATA environment variable, represented here as ConfigDir.
 
-# data_directory = 'ConfigDir'		# use data in another directory
-# hba_file = 'ConfigDir/pg_hba.conf'	# host-based authentication file
-# ident_file = 'ConfigDir/pg_ident.conf	# IDENT configuration file
+#data_directory = 'ConfigDir'		# use data in another directory
+#hba_file = 'ConfigDir/pg_hba.conf'	# host-based authentication file
+#ident_file = 'ConfigDir/pg_ident.conf	# IDENT configuration file
 
 # If external_pid_file is not explicitly set, no extra pid file is written.
-# external_pid_file = '(none)'		# write an extra pid file
+#external_pid_file = '(none)'		# write an extra pid file
 
 
 #---------------------------------------------------------------------------
@@ -66,10 +66,12 @@
 #ssl = off
 #password_encryption = on
 #db_user_namespace = off
+
 # Kerberos
 #krb_server_keyfile = ''
-#krb_caseins_users = off
 #krb_srvname = 'postgres'
+#krb_server_hostname = '(any)'		# if not set, matches any keytab entry
+#krb_caseins_users = off
 
 # - TCP Keepalives -
 # see 'man 7 tcp' for details
@@ -413,3 +415,10 @@
 # - Other Platforms & Clients -
 
 #transform_null_equals = off
+
+
+#---------------------------------------------------------------------------
+# CUSTOMIZED OPTIONS
+#---------------------------------------------------------------------------
+
+#custom_variable_classes = ''		# list of custom variable class names

Original file line number	Diff line number	Diff line change
`@@ -10,7 +10,7 @@`
`10`	`10`	`* Written by Peter Eisentraut <peter_e@gmx.net>.`
`11`	`11`	`*`
`12`	`12`	`* IDENTIFICATION`
`13`		`- * $PostgreSQL: pgsql/src/backend/utils/misc/guc.c,v 1.284 2005/08/20 23:26:26 tgl Exp $`
	`13`	`+ * $PostgreSQL: pgsql/src/backend/utils/misc/guc.c,v 1.285 2005/08/21 03:39:34 tgl Exp $`
`14`	`14`	`*`
`15`	`15`	`*--------------------------------------------------------------------`
`16`	`16`	`*/`
`@@ -2029,7 +2029,7 @@ static struct config_string ConfigureNamesString[] =`
`2029`	`2029`	`},`
`2030`	`2030`
`2031`	`2031`	`{`
`2032`		`- {"custom_variable_classes", PGC_POSTMASTER, RESOURCES_KERNEL,`
	`2032`	`+ {"custom_variable_classes", PGC_SIGHUP, CUSTOM_OPTIONS,`
`2033`	`2033`	`gettext_noop("Sets the list of known custom variable classes."),`
`2034`	`2034`	`NULL,`
`2035`	`2035`	`GUC_LIST_INPUT \| GUC_LIST_QUOTE`