diff options
| author | Fujii Masao <fujii@postgresql.org> | 2025-11-07 14:54:36 +0900 |
|---|---|---|
| committer | Fujii Masao <fujii@postgresql.org> | 2025-11-07 14:54:36 +0900 |
| commit | c32e32f763b4c70cb0a85af9f12ee6badd9c860b (patch) | |
| tree | 33060fe9a61f2da865b908ca2db7d74a7593b857 /doc | |
| parent | 6fba6cb05ddfb177ac1c4efa508707e879fb8bd3 (diff) | |
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
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/src/sgml/config.sgml | 21 |
1 files changed, 12 insertions, 9 deletions
diff --git a/doc/src/sgml/config.sgml b/doc/src/sgml/config.sgml index 5fbe6c6794c..683f7c36f46 100644 --- a/doc/src/sgml/config.sgml +++ b/doc/src/sgml/config.sgml @@ -1760,7 +1760,8 @@ include_dir 'conf.d' <para> Controls whether huge pages are requested for the main shared memory 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 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 @@ -2273,6 +2274,7 @@ include_dir 'conf.d' platform, is generally discouraged because it typically requires non-default kernel settings to allow for large allocations (see <xref linkend="sysvipc"/>). + This parameter can only be set at server start. </para> </listitem> </varlistentry> @@ -2300,6 +2302,7 @@ include_dir 'conf.d' however, it may be useful for debugging, when the <literal>pg_dynshmem</literal> directory is stored on a RAM disk, or when other shared memory facilities are not available. + This parameter can only be set at server start. </para> </listitem> </varlistentry> @@ -2413,6 +2416,7 @@ include_dir 'conf.d' <xref linkend="sql-notify"/> / <xref linkend="sql-listen"/> queue. The default value is 1048576. For 8 KB pages it allows to consume up to 8 GB of disk space. + This parameter can only be set at server start. </para> </listitem> </varlistentry> @@ -2694,9 +2698,7 @@ include_dir 'conf.d' <para> Controls the largest I/O size in operations that combine I/O, and silently limits the user-settable parameter <varname>io_combine_limit</varname>. - This parameter can only be set in - the <filename>postgresql.conf</filename> file or on the server - command line. + This parameter can only be set at server start. If this value is specified without units, it is taken as blocks, that is <symbol>BLCKSZ</symbol> bytes, typically 8kB. 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 taken as bytes. The default is 512kB. + This parameter can only be set at server start. </para> </listitem> </varlistentry> @@ -4692,9 +4695,9 @@ restore_command = 'copy "C:\\server\\archivedir\\%f" "%p"' # Windows </term> <listitem> <para> - Record commit time of transactions. This parameter - can only be set in <filename>postgresql.conf</filename> file or on the server - command line. The default value is <literal>off</literal>. + Record commit time of transactions. + This parameter can only be set at server start. + The default value is <literal>off</literal>. </para> </listitem> </varlistentry> @@ -7043,8 +7046,7 @@ local0.* /var/log/postgresql determines the program name used to identify <productname>PostgreSQL</productname> messages in the log. The default is <literal>PostgreSQL</literal>. - This parameter can only be set in the <filename>postgresql.conf</filename> - file or on the server command line. + This parameter can only be set at server start. </para> </listitem> </varlistentry> @@ -12273,6 +12275,7 @@ dynamic_library_path = '/usr/local/lib/postgresql:$libdir' main data files, <literal>wal</literal> for WAL files, and <literal>wal_init</literal> for WAL files when being initially allocated. + This parameter can only be set at server start. </para> <para> Some operating systems and file systems do not support direct I/O, so |
