summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorFujii Masao2025-11-07 05:58:53 +0000
committerFujii Masao2025-11-07 05:59:33 +0000
commit2dfda09ad77b1873f51a565041090af37743e576 (patch)
tree2983ba72fb5c2915e246a215479f2497dbaef881
parent20bafb0972882eaf0fb50349fc4023e1e5505a57 (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
-rw-r--r--doc/src/sgml/config.sgml14
1 files changed, 8 insertions, 6 deletions
diff --git a/doc/src/sgml/config.sgml b/doc/src/sgml/config.sgml
index 3a496f61b0e..3465bc4ad07 100644
--- a/doc/src/sgml/config.sgml
+++ b/doc/src/sgml/config.sgml
@@ -1562,7 +1562,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
@@ -1889,6 +1890,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>
@@ -1916,6 +1918,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>
@@ -4038,9 +4041,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>
@@ -6216,8 +6219,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>