docs: Improve pg_settings_get_flags docs.
authorTom Lane
Thu, 3 Nov 2022 23:53:35 +0000 (19:53 -0400)
committerTom Lane
Thu, 3 Nov 2022 23:53:35 +0000 (19:53 -0400)
In the docs, the GUC flags that pg_settings_get_flags() reported were
listed using . But the list was treated as separate lines
in the existing function table and didn't look good. For better view,
this commit separates the list from the table entry for
pg_settings_get_flags() and adds the table for it at the bottom of
the existing function table.

Author: Fujii Masao
Reviewed-by: Alvaro Herrera, Michael Paquier
Discussion: https://postgr.es/m/f093edf9-6e5a-b119-ee50-6a2c97c79ee8@oss.nttdata.com

Back-patch of f2d0c7f18 into v15.
Discussion: https://postgr.es/m/20221103123320[email protected]

doc/src/sgml/func.sgml

index 5ae6176528de10bcc73ab0d83572cc156d316251..0fa2f80b4a3673e1975ffdd582cd3e2d147819d5 100644 (file)
@@ -23915,28 +23915,8 @@ SELECT currval(pg_get_serial_sequence('sometable', 'id'));
         Returns an array of the flags associated with the given GUC, or
         NULL if it does not exist. The result is
         an empty array if the GUC exists but there are no flags to show.
-        Only the most useful flags are exposed, as of the following:
-        
-         
-          EXPLAIN: parameters included in
-          EXPLAIN (SETTINGS) commands.
-         
-         
-          NO_SHOW_ALL: parameters excluded from
-          SHOW ALL commands.
-         
-         
-          NO_RESET_ALL: parameters excluded from
-          RESET ALL commands.
-         
-         
-          NOT_IN_SAMPLE: parameters not included in
-          postgresql.conf by default.
-         
-         
-          RUNTIME_COMPUTED: runtime-computed parameters.
-         
-        
+        Only the most useful flags listed in
+         are exposed.
        
       
 
@@ -24344,6 +24324,46 @@ SELECT collation for ('foo' COLLATE "de_DE");
    
   
 
+  
+   GUC Flags
+   
+    
+     FlagDescription
+    
+    
+     
+      EXPLAIN
+      Parameters with this flag are included in
+       EXPLAIN (SETTINGS) commands.
+      
+     
+     
+      NO_SHOW_ALL
+      Parameters with this flag are excluded from
+       SHOW ALL commands.
+      
+     
+     
+      NO_RESET_ALL
+      Parameters with this flag are excluded from
+       RESET ALL commands.
+      
+     
+     
+      NOT_IN_SAMPLE
+      Parameters with this flag are not included in
+       postgresql.conf by default.
+      
+     
+     
+      RUNTIME_COMPUTED
+      Parameters with this flag are runtime-computed ones.
+      
+     
+    
+   
+  
+
   
     lists functions related to
    database object identification and addressing.