Clarify restrict_nonsystem_relation_kind description.

MasahikoSawada · MasahikoSawada · commit 886549fb105f · 2024-08-30T15:06:02.000-07:00
This change improves the description of the restrict_nonsystem_relation_kind parameter in guc_table.c and the documentation for better clarity. Backpatch to 12, where this GUC parameter was introduced. Reviewed-by: Peter Eisentraut Discussion: https://postgr.es/m/6a96f1af-22b4-4a80-8161-1f26606b9ee2%40eisentraut.org Backpatch-through: 12
diff --git a/doc/src/sgml/config.sgml b/doc/src/sgml/config.sgml
@@ -9394,9 +9394,9 @@ SET XML OPTION { DOCUMENT | CONTENT };
      </term>
      <listitem>
       <para>
-       This variable specifies relation kind to which access is restricted.
-       It contains a comma-separated list of relation kind.  Currently, the
-       supported relation kinds are <literal>view</literal> and
+       Set relation kinds for which access to non-system relations is prohibited.
+       The value takes the form of a comma-separated list of relation kinds.
+       Currently, the supported relation kinds are <literal>view</literal> and
        <literal>foreign-table</literal>.
       </para>
      </listitem>
diff --git a/src/backend/utils/misc/guc.c b/src/backend/utils/misc/guc.c
@@ -4714,7 +4714,7 @@ static struct config_string ConfigureNamesString[] =
 
 	{
 		{"restrict_nonsystem_relation_kind", PGC_USERSET, CLIENT_CONN_STATEMENT,
-			gettext_noop("Sets relation kinds of non-system relation to restrict use"),
+			gettext_noop("Prohibits access to non-system relations of specified kinds."),
 			NULL,
 			GUC_LIST_INPUT | GUC_NOT_IN_SAMPLE
 		},

Original file line number	Diff line number	Diff line change
`@@ -4714,7 +4714,7 @@ static struct config_string ConfigureNamesString[] =`
`4714`	`4714`
`4715`	`4715`	`{`
`4716`	`4716`	`{"restrict_nonsystem_relation_kind", PGC_USERSET, CLIENT_CONN_STATEMENT,`
`4717`		`- gettext_noop("Sets relation kinds of non-system relation to restrict use"),`
	`4717`	`+ gettext_noop("Prohibits access to non-system relations of specified kinds."),`
`4718`	`4718`	`NULL,`
`4719`	`4719`	`GUC_LIST_INPUT \| GUC_NOT_IN_SAMPLE`
`4720`	`4720`	`},`