1
0
mirror of https://github.com/postgres/postgres.git synced 2025-05-06 19:59:18 +03:00

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
This commit is contained in:
Michael Paquier 2021-05-27 14:58:13 +09:00
parent 3f8072be8a
commit 99d6dd3b4d

View File

@ -1382,6 +1382,11 @@ include_dir 'conf.d'
want to set this to a higher value if all software components can want to set this to a higher value if all software components can
support the newer protocol versions. support the newer protocol versions.
</para> </para>
<para>
This parameter can only be set in the <filename>postgresql.conf</filename>
file or on the server command line.
</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -1400,6 +1405,11 @@ include_dir 'conf.d'
useful for testing or if some component has issues working with a useful for testing or if some component has issues working with a
newer protocol. newer protocol.
</para> </para>
<para>
This parameter can only be set in the <filename>postgresql.conf</filename>
file or on the server command line.
</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -1740,6 +1750,9 @@ include_dir 'conf.d'
the value of <xref linkend="guc-maintenance-work-mem"/> should the value of <xref linkend="guc-maintenance-work-mem"/> should
be used instead. The setting has no effect on the behavior of be used instead. The setting has no effect on the behavior of
<command>VACUUM</command> when run in other contexts. <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> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -4448,7 +4461,8 @@ ANY <replaceable class="parameter">num_sync</replaceable> ( <replaceable class="
<varname>max_worker_processes</varname>. <varname>max_worker_processes</varname>.
</para> </para>
<para> <para>
The default value is 4. The default value is 4. This parameter can only be set at server
start.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -4473,7 +4487,9 @@ ANY <replaceable class="parameter">num_sync</replaceable> ( <replaceable class="
<varname>max_logical_replication_workers</varname>. <varname>max_logical_replication_workers</varname>.
</para> </para>
<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> </para>
</listitem> </listitem>
</varlistentry> </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 useful to disable the restart so that the clusterware can gain
control and take any actions it deems appropriate. control and take any actions it deems appropriate.
</para> </para>
<para>
This parameter can only be set in the <filename>postgresql.conf</filename>
file or on the server command line.
</para>
</listitem> </listitem>
</varlistentry> </varlistentry>