1
0
mirror of https://github.com/postgres/postgres.git synced 2025-11-07 19:06:32 +03:00

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
This commit is contained in:
Fujii Masao
2025-11-07 14:54:36 +09:00
parent 6fba6cb05d
commit c32e32f763

View File

@@ -1760,7 +1760,8 @@ include_dir 'conf.d'
<para> <para>
Controls whether huge pages are requested for the main shared memory Controls whether huge pages are requested for the main shared memory
area. Valid values are <literal>try</literal> (the default), area. Valid values are <literal>try</literal> (the default),
<literal>on</literal>, and <literal>off</literal>. With <literal>on</literal>, and <literal>off</literal>.
This parameter can only be set at server start. With
<varname>huge_pages</varname> set to <literal>try</literal>, the <varname>huge_pages</varname> set to <literal>try</literal>, the
server will try to request huge pages, but fall back to the default if server will try to request huge pages, but fall back to the default if
that fails. With <literal>on</literal>, failure to request huge pages that fails. With <literal>on</literal>, failure to request huge pages
@@ -2273,6 +2274,7 @@ include_dir 'conf.d'
platform, is generally discouraged because it typically requires platform, is generally discouraged because it typically requires
non-default kernel settings to allow for large allocations (see <xref non-default kernel settings to allow for large allocations (see <xref
linkend="sysvipc"/>). linkend="sysvipc"/>).
This parameter can only be set at server start.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@@ -2300,6 +2302,7 @@ include_dir 'conf.d'
however, it may be useful for debugging, when the however, it may be useful for debugging, when the
<literal>pg_dynshmem</literal> directory is stored on a RAM disk, or when <literal>pg_dynshmem</literal> directory is stored on a RAM disk, or when
other shared memory facilities are not available. other shared memory facilities are not available.
This parameter can only be set at server start.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@@ -2413,6 +2416,7 @@ include_dir 'conf.d'
<xref linkend="sql-notify"/> / <xref linkend="sql-listen"/> queue. <xref linkend="sql-notify"/> / <xref linkend="sql-listen"/> queue.
The default value is 1048576. For 8 KB pages it allows to consume The default value is 1048576. For 8 KB pages it allows to consume
up to 8 GB of disk space. up to 8 GB of disk space.
This parameter can only be set at server start.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@@ -2694,9 +2698,7 @@ include_dir 'conf.d'
<para> <para>
Controls the largest I/O size in operations that combine I/O, and silently Controls the largest I/O size in operations that combine I/O, and silently
limits the user-settable parameter <varname>io_combine_limit</varname>. limits the user-settable parameter <varname>io_combine_limit</varname>.
This parameter can only be set in This parameter can only be set at server start.
the <filename>postgresql.conf</filename> file or on the server
command line.
If this value is specified without units, it is taken as blocks, If this value is specified without units, it is taken as blocks,
that is <symbol>BLCKSZ</symbol> bytes, typically 8kB. that is <symbol>BLCKSZ</symbol> bytes, typically 8kB.
The maximum possible size depends on the operating system and block The maximum possible size depends on the operating system and block
@@ -3967,6 +3969,7 @@ include_dir 'conf.d'
blocks to prefetch. If this value is specified without units, it is blocks to prefetch. If this value is specified without units, it is
taken as bytes. taken as bytes.
The default is 512kB. The default is 512kB.
This parameter can only be set at server start.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@@ -4692,9 +4695,9 @@ restore_command = 'copy "C:\\server\\archivedir\\%f" "%p"' # Windows
</term> </term>
<listitem> <listitem>
<para> <para>
Record commit time of transactions. This parameter Record commit time of transactions.
can only be set in <filename>postgresql.conf</filename> file or on the server This parameter can only be set at server start.
command line. The default value is <literal>off</literal>. The default value is <literal>off</literal>.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@@ -7043,8 +7046,7 @@ local0.* /var/log/postgresql
determines the program name used to identify determines the program name used to identify
<productname>PostgreSQL</productname> messages in <productname>PostgreSQL</productname> messages in
the log. The default is <literal>PostgreSQL</literal>. the log. The default is <literal>PostgreSQL</literal>.
This parameter can only be set in the <filename>postgresql.conf</filename> This parameter can only be set at server start.
file or on the server command line.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@@ -12273,6 +12275,7 @@ dynamic_library_path = '/usr/local/lib/postgresql:$libdir'
main data files, <literal>wal</literal> for WAL files, and main data files, <literal>wal</literal> for WAL files, and
<literal>wal_init</literal> for WAL files when being initially <literal>wal_init</literal> for WAL files when being initially
allocated. allocated.
This parameter can only be set at server start.
</para> </para>
<para> <para>
Some operating systems and file systems do not support direct I/O, so Some operating systems and file systems do not support direct I/O, so