doc: Fix description of some GUCs in docs and postgresql.conf.sample
authorMichael Paquier
Thu, 27 May 2021 05:58:09 +0000 (14:58 +0900)
committerMichael Paquier
Thu, 27 May 2021 05:58:09 +0000 (14:58 +0900)
The following parameters have been imprecise, or incorrect, about their
description (PGC_POSTMASTER or PGC_SIGHUP):
- autovacuum_work_mem (docs, as of 9.6~)
- huge_page_size (docs, as of 14~)
- max_logical_replication_workers (docs, as of 10~)
- max_sync_workers_per_subscription (docs, as of 10~)
- min_dynamic_shared_memory (docs, as of 14~)
- recovery_init_sync_method (postgresql.conf.sample, as of 14~)
- remove_temp_files_after_crash (docs, as of 14~)
- restart_after_crash (docs, as of 9.6~)
- ssl_min_protocol_version (docs, as of 12~)
- ssl_max_protocol_version (docs, as of 12~)

This commit adjusts the description of all these parameters to be more
consistent with the practice used for the others.

Revewed-by: Justin Pryzby
Discussion: https://postgr.es/m/[email protected]
Backpatch-through: 9.6

doc/src/sgml/config.sgml

index 136b51bf122d035108ae0d08a7a99eac6241c0e6..ba2f1eabcf0e405a4ba6394fce62fb0e01713482 100644 (file)
@@ -1377,6 +1377,11 @@ include_dir 'conf.d'
         The default is TLSv1.2, which satisfies industry
         best practices as of this writing.
        
+
+       
+        This parameter can only be set in the postgresql.conf
+        file or on the server command line.
+       
       
      
 
@@ -1395,6 +1400,11 @@ include_dir 'conf.d'
         useful for testing or if some component has issues working with a
         newer protocol.
        
+
+       
+        This parameter can only be set in the postgresql.conf
+        file or on the server command line.
+       
       
      
 
@@ -1777,6 +1787,9 @@ include_dir 'conf.d'
         the value of  should
         be used instead.  The setting has no effect on the behavior of
         VACUUM when run in other contexts.
+        This parameter can only be set in the
+        postgresql.conf file or on the server command
+        line.
        
       
      
@@ -4611,7 +4624,8 @@ ANY num_sync ( 
         max_worker_processes.
        
        
-        The default value is 4.
+        The default value is 4. This parameter can only be set at server
+        start.
        
       
      
@@ -4636,7 +4650,9 @@ ANY num_sync ( 
         max_logical_replication_workers.
        
        
-        The default value is 2.
+        The default value is 2. This parameter can only be set in the
+        postgresql.conf file or on the server command
+        line.
        
       
      
@@ -9479,6 +9495,11 @@ dynamic_library_path = 'C:\tools\postgresql;H:\my_project\lib;$libdir'
         useful to disable the restart so that the clusterware can gain
         control and take any actions it deems appropriate.
        
+
+       
+        This parameter can only be set in the postgresql.conf
+        file or on the server command line.
+