aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMichael Paquier <michael@paquier.xyz>2021-05-27 14:58:13 +0900
committerMichael Paquier <michael@paquier.xyz>2021-05-27 14:58:13 +0900
commit99d6dd3b4d94d9d4b8036e733ca5fbd4f95b31fd (patch)
treec801c51f1620540714b261e326752aba2c744ce0
parent3f8072be8a71b5bd3dc838a4ba03ccdaff2d975e (diff)
downloadpostgresql-99d6dd3b4d94d9d4b8036e733ca5fbd4f95b31fd.tar.gz
postgresql-99d6dd3b4d94d9d4b8036e733ca5fbd4f95b31fd.zip
doc: Fix description of some GUCs in docs and postgresql.conf.sample
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/YK2ltuLpe+FbRXzA@paquier.xyz Backpatch-through: 9.6
-rw-r--r--doc/src/sgml/config.sgml25
1 files changed, 23 insertions, 2 deletions
diff --git a/doc/src/sgml/config.sgml b/doc/src/sgml/config.sgml
index ecd9843a68b..224e4d05ee9 100644
--- a/doc/src/sgml/config.sgml
+++ b/doc/src/sgml/config.sgml
@@ -1382,6 +1382,11 @@ include_dir 'conf.d'
want to set this to a higher value if all software components can
support the newer protocol versions.
</para>
+
+ <para>
+ This parameter can only be set in the <filename>postgresql.conf</filename>
+ file or on the server command line.
+ </para>
</listitem>
</varlistentry>
@@ -1400,6 +1405,11 @@ include_dir 'conf.d'
useful for testing or if some component has issues working with a
newer protocol.
</para>
+
+ <para>
+ This parameter can only be set in the <filename>postgresql.conf</filename>
+ file or on the server command line.
+ </para>
</listitem>
</varlistentry>
@@ -1740,6 +1750,9 @@ include_dir 'conf.d'
the value of <xref linkend="guc-maintenance-work-mem"/> should
be used instead. The setting has no effect on the behavior of
<command>VACUUM</command> when run in other contexts.
+ This parameter can only be set in the
+ <filename>postgresql.conf</filename> file or on the server command
+ line.
</para>
</listitem>
</varlistentry>
@@ -4448,7 +4461,8 @@ ANY <replaceable class="parameter">num_sync</replaceable> ( <replaceable class="
<varname>max_worker_processes</varname>.
</para>
<para>
- The default value is 4.
+ The default value is 4. This parameter can only be set at server
+ start.
</para>
</listitem>
</varlistentry>
@@ -4473,7 +4487,9 @@ ANY <replaceable class="parameter">num_sync</replaceable> ( <replaceable class="
<varname>max_logical_replication_workers</varname>.
</para>
<para>
- The default value is 2.
+ The default value is 2. This parameter can only be set in the
+ <filename>postgresql.conf</filename> file or on the server command
+ line.
</para>
</listitem>
</varlistentry>
@@ -9143,6 +9159,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.
</para>
+
+ <para>
+ This parameter can only be set in the <filename>postgresql.conf</filename>
+ file or on the server command line.
+ </para>
</listitem>
</varlistentry>