Skip to content

Commit 17bf6f1

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 <[email protected]> Reviewed-by: Chao Li <[email protected]> Reviewed-by: Fujii Masao <[email protected]> Discussion: https://postgr.es/m/CAHGQGwGfPzcin-_6XwPgVbWTOUFVZgHF5g9ROrwLUdCTfjy=0A@mail.gmail.com Backpatch-through: 13
1 parent b841c91 commit 17bf6f1

File tree

1 file changed

+11
-6
lines changed

1 file changed

+11
-6
lines changed

doc/src/sgml/config.sgml

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1683,7 +1683,8 @@ include_dir 'conf.d'
16831683
<para>
16841684
Controls whether huge pages are requested for the main shared memory
16851685
area. Valid values are <literal>try</literal> (the default),
1686-
<literal>on</literal>, and <literal>off</literal>. With
1686+
<literal>on</literal>, and <literal>off</literal>.
1687+
This parameter can only be set at server start. With
16871688
<varname>huge_pages</varname> set to <literal>try</literal>, the
16881689
server will try to request huge pages, but fall back to the default if
16891690
that fails. With <literal>on</literal>, failure to request huge pages
@@ -2196,6 +2197,7 @@ include_dir 'conf.d'
21962197
platform, is generally discouraged because it typically requires
21972198
non-default kernel settings to allow for large allocations (see <xref
21982199
linkend="sysvipc"/>).
2200+
This parameter can only be set at server start.
21992201
</para>
22002202
</listitem>
22012203
</varlistentry>
@@ -2223,6 +2225,7 @@ include_dir 'conf.d'
22232225
however, it may be useful for debugging, when the
22242226
<literal>pg_dynshmem</literal> directory is stored on a RAM disk, or when
22252227
other shared memory facilities are not available.
2228+
This parameter can only be set at server start.
22262229
</para>
22272230
</listitem>
22282231
</varlistentry>
@@ -2298,6 +2301,7 @@ include_dir 'conf.d'
22982301
<xref linkend="sql-notify"/> / <xref linkend="sql-listen"/> queue.
22992302
The default value is 1048576. For 8 KB pages it allows to consume
23002303
up to 8 GB of disk space.
2304+
This parameter can only be set at server start.
23012305
</para>
23022306
</listitem>
23032307
</varlistentry>
@@ -3882,6 +3886,7 @@ include_dir 'conf.d'
38823886
blocks to prefetch. If this value is specified without units, it is
38833887
taken as bytes.
38843888
The default is 512kB.
3889+
This parameter can only be set at server start.
38853890
</para>
38863891
</listitem>
38873892
</varlistentry>
@@ -4571,9 +4576,9 @@ restore_command = 'copy "C:\\server\\archivedir\\%f" "%p"' # Windows
45714576
</term>
45724577
<listitem>
45734578
<para>
4574-
Record commit time of transactions. This parameter
4575-
can only be set in <filename>postgresql.conf</filename> file or on the server
4576-
command line. The default value is <literal>off</literal>.
4579+
Record commit time of transactions.
4580+
This parameter can only be set at server start.
4581+
The default value is <literal>off</literal>.
45774582
</para>
45784583
</listitem>
45794584
</varlistentry>
@@ -6853,8 +6858,7 @@ local0.* /var/log/postgresql
68536858
determines the program name used to identify
68546859
<productname>PostgreSQL</productname> messages in
68556860
the log. The default is <literal>PostgreSQL</literal>.
6856-
This parameter can only be set in the <filename>postgresql.conf</filename>
6857-
file or on the server command line.
6861+
This parameter can only be set at server start.
68586862
</para>
68596863
</listitem>
68606864
</varlistentry>
@@ -11488,6 +11492,7 @@ dynamic_library_path = 'C:\tools\postgresql;H:\my_project\lib;$libdir'
1148811492
main data files, <literal>wal</literal> for WAL files, and
1148911493
<literal>wal_init</literal> for WAL files when being initially
1149011494
allocated.
11495+
This parameter can only be set at server start.
1149111496
</para>
1149211497
<para>
1149311498
Some operating systems and file systems do not support direct I/O, so

0 commit comments

Comments
 (0)