Skip to content

Commit ac72a90

Browse files
committed
doc: Fix descriptions of some PGC_POSTMASTER parameters.
The following parameters can only be set at server start because their context is PGC_POSTMASTER, but this information was missing or incorrectly documented. This commit adds or corrects that information for the following parameters: * debug_io_direct * dynamic_shared_memory_type * event_source * huge_pages * io_max_combine_limit * max_notify_queue_pages * shared_memory_type * track_commit_timestamp * wal_decode_buffer_size Backpatched to all supported branches. Author: Karina Litskevich <litskevichkarina@gmail.com> Reviewed-by: Chao Li <lic@highgo.com> Reviewed-by: Fujii Masao <masao.fujii@gmail.com> Discussion: https://postgr.es/m/CAHGQGwGfPzcin-_6XwPgVbWTOUFVZgHF5g9ROrwLUdCTfjy=0A@mail.gmail.com Backpatch-through: 13
1 parent d83da46 commit ac72a90

File tree

1 file changed

+12
-9
lines changed

1 file changed

+12
-9
lines changed

doc/src/sgml/config.sgml

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1760,7 +1760,8 @@ include_dir 'conf.d'
17601760
<para>
17611761
Controls whether huge pages are requested for the main shared memory
17621762
area. Valid values are <literal>try</literal> (the default),
1763-
<literal>on</literal>, and <literal>off</literal>. With
1763+
<literal>on</literal>, and <literal>off</literal>.
1764+
This parameter can only be set at server start. With
17641765
<varname>huge_pages</varname> set to <literal>try</literal>, the
17651766
server will try to request huge pages, but fall back to the default if
17661767
that fails. With <literal>on</literal>, failure to request huge pages
@@ -2273,6 +2274,7 @@ include_dir 'conf.d'
22732274
platform, is generally discouraged because it typically requires
22742275
non-default kernel settings to allow for large allocations (see <xref
22752276
linkend="sysvipc"/>).
2277+
This parameter can only be set at server start.
22762278
</para>
22772279
</listitem>
22782280
</varlistentry>
@@ -2300,6 +2302,7 @@ include_dir 'conf.d'
23002302
however, it may be useful for debugging, when the
23012303
<literal>pg_dynshmem</literal> directory is stored on a RAM disk, or when
23022304
other shared memory facilities are not available.
2305+
This parameter can only be set at server start.
23032306
</para>
23042307
</listitem>
23052308
</varlistentry>
@@ -2413,6 +2416,7 @@ include_dir 'conf.d'
24132416
<xref linkend="sql-notify"/> / <xref linkend="sql-listen"/> queue.
24142417
The default value is 1048576. For 8 KB pages it allows to consume
24152418
up to 8 GB of disk space.
2419+
This parameter can only be set at server start.
24162420
</para>
24172421
</listitem>
24182422
</varlistentry>
@@ -2694,9 +2698,7 @@ include_dir 'conf.d'
26942698
<para>
26952699
Controls the largest I/O size in operations that combine I/O, and silently
26962700
limits the user-settable parameter <varname>io_combine_limit</varname>.
2697-
This parameter can only be set in
2698-
the <filename>postgresql.conf</filename> file or on the server
2699-
command line.
2701+
This parameter can only be set at server start.
27002702
If this value is specified without units, it is taken as blocks,
27012703
that is <symbol>BLCKSZ</symbol> bytes, typically 8kB.
27022704
The maximum possible size depends on the operating system and block
@@ -3967,6 +3969,7 @@ include_dir 'conf.d'
39673969
blocks to prefetch. If this value is specified without units, it is
39683970
taken as bytes.
39693971
The default is 512kB.
3972+
This parameter can only be set at server start.
39703973
</para>
39713974
</listitem>
39723975
</varlistentry>
@@ -4692,9 +4695,9 @@ restore_command = 'copy "C:\\server\\archivedir\\%f" "%p"' # Windows
46924695
</term>
46934696
<listitem>
46944697
<para>
4695-
Record commit time of transactions. This parameter
4696-
can only be set in <filename>postgresql.conf</filename> file or on the server
4697-
command line. The default value is <literal>off</literal>.
4698+
Record commit time of transactions.
4699+
This parameter can only be set at server start.
4700+
The default value is <literal>off</literal>.
46984701
</para>
46994702
</listitem>
47004703
</varlistentry>
@@ -7010,8 +7013,7 @@ local0.* /var/log/postgresql
70107013
determines the program name used to identify
70117014
<productname>PostgreSQL</productname> messages in
70127015
the log. The default is <literal>PostgreSQL</literal>.
7013-
This parameter can only be set in the <filename>postgresql.conf</filename>
7014-
file or on the server command line.
7016+
This parameter can only be set at server start.
70157017
</para>
70167018
</listitem>
70177019
</varlistentry>
@@ -12207,6 +12209,7 @@ dynamic_library_path = '/usr/local/lib/postgresql:$libdir'
1220712209
main data files, <literal>wal</literal> for WAL files, and
1220812210
<literal>wal_init</literal> for WAL files when being initially
1220912211
allocated.
12212+
This parameter can only be set at server start.
1221012213
</para>
1221112214
<para>
1221212215
Some operating systems and file systems do not support direct I/O, so

0 commit comments

Comments
 (0)