public inbox for [email protected]
help / color / mirror / Atom feedFrom: Fujii Masao <[email protected]>
To: [email protected]
Subject: Two small doc fixes for config.sgml
Date: Mon, 20 Apr 2026 19:02:52 +0900
Message-ID: <CAHGQGwEpMDpB-K8SSUVRRHg6L6z3pLAkekd9aviOS=ns0EC=+Q@mail.gmail.com> (raw)
Hi,
I found two small issues in config.sgml and attached patches for both.
#1
The documentation for jit_debugging_support and jit_profiling_support says
these parameters can only be set at server start. However, both use
the PGC_SU_BACKEND context, which means they can be set at session start
by superusers or users with the appropriate SET privilege, but cannot be
changed within an active session. So, these descriptions should be corrected.
This fix should be backpatched to all supported versions.
#2
config.sgml describes the io_max_workers, io_worker_idle_timeout,
and io_worker_launch_interval GUCs as type "int". Elsewhere, config.sgml
consistently uses "integer" for this type. So those descriptions should be
updated to use "integer" for consistency.
Regards,
--
Fujii Masao
From a6810e7966e7e10df43c9da1687d9e183b9ab70c Mon Sep 17 00:00:00 2001
From: Fujii Masao <[email protected]>
Date: Mon, 20 Apr 2026 17:54:50 +0900
Subject: [PATCH v1] doc: Correct context description for some JIT support GUCs
The documentation for jit_debugging_support and jit_profiling_support
previously stated that these parameters can only be set at server start.
However, both parameters use the PGC_SU_BACKEND context, meaning they
can be set at session start by superusers or users granted the appropriate
SET privilege, but cannot be changed within an active session.
This commit updates the documentation to reflect the actual behavior.
Backpatch to all supported versions.
---
doc/src/sgml/config.sgml | 6 ++++--
1 file changed, 4 insertions(+), 2 deletions(-)
diff --git a/doc/src/sgml/config.sgml b/doc/src/sgml/config.sgml
index d4bd981dfab..2308c87ca22 100644
--- a/doc/src/sgml/config.sgml
+++ b/doc/src/sgml/config.sgml
@@ -10978,7 +10978,8 @@ LOG: CleanUpLock: deleting: lock(0xb7acd844) id(24688,24696,0,0,0,1)
If LLVM has the required functionality, register generated functions
with <productname>GDB</productname>. This makes debugging easier.
The default setting is <literal>off</literal>.
- This parameter can only be set at server start.
+ Only superusers can change this parameter at session start,
+ and it cannot be changed at all within a session.
</para>
</listitem>
</varlistentry>
@@ -11028,7 +11029,8 @@ LOG: CleanUpLock: deleting: lock(0xb7acd844) id(24688,24696,0,0,0,1)
This writes out files to <filename>~/.debug/jit/</filename>; the
user is responsible for performing cleanup when desired.
The default setting is <literal>off</literal>.
- This parameter can only be set at server start.
+ Only superusers can change this parameter at session start,
+ and it cannot be changed at all within a session.
</para>
</listitem>
</varlistentry>
--
2.53.0
Attachments:
[text/plain] v1-0001-pg14-doc-Correct-context-description-for-some-JIT-supp.txt (2.0K, ../CAHGQGwEpMDpB-K8SSUVRRHg6L6z3pLAkekd9aviOS=ns0EC=+Q@mail.gmail.com/2-v1-0001-pg14-doc-Correct-context-description-for-some-JIT-supp.txt)
download | inline diff:
From a6810e7966e7e10df43c9da1687d9e183b9ab70c Mon Sep 17 00:00:00 2001
From: Fujii Masao <[email protected]>
Date: Mon, 20 Apr 2026 17:54:50 +0900
Subject: [PATCH v1] doc: Correct context description for some JIT support GUCs
The documentation for jit_debugging_support and jit_profiling_support
previously stated that these parameters can only be set at server start.
However, both parameters use the PGC_SU_BACKEND context, meaning they
can be set at session start by superusers or users granted the appropriate
SET privilege, but cannot be changed within an active session.
This commit updates the documentation to reflect the actual behavior.
Backpatch to all supported versions.
---
doc/src/sgml/config.sgml | 6 ++++--
1 file changed, 4 insertions(+), 2 deletions(-)
diff --git a/doc/src/sgml/config.sgml b/doc/src/sgml/config.sgml
index d4bd981dfab..2308c87ca22 100644
--- a/doc/src/sgml/config.sgml
+++ b/doc/src/sgml/config.sgml
@@ -10978,7 +10978,8 @@ LOG: CleanUpLock: deleting: lock(0xb7acd844) id(24688,24696,0,0,0,1)
If LLVM has the required functionality, register generated functions
with <productname>GDB</productname>. This makes debugging easier.
The default setting is <literal>off</literal>.
- This parameter can only be set at server start.
+ Only superusers can change this parameter at session start,
+ and it cannot be changed at all within a session.
</para>
</listitem>
</varlistentry>
@@ -11028,7 +11029,8 @@ LOG: CleanUpLock: deleting: lock(0xb7acd844) id(24688,24696,0,0,0,1)
This writes out files to <filename>~/.debug/jit/</filename>; the
user is responsible for performing cleanup when desired.
The default setting is <literal>off</literal>.
- This parameter can only be set at server start.
+ Only superusers can change this parameter at session start,
+ and it cannot be changed at all within a session.
</para>
</listitem>
</varlistentry>
--
2.53.0
[application/octet-stream] v1-0001-doc-Correct-context-description-for-some-JIT-supp.patch (2.1K, ../CAHGQGwEpMDpB-K8SSUVRRHg6L6z3pLAkekd9aviOS=ns0EC=+Q@mail.gmail.com/3-v1-0001-doc-Correct-context-description-for-some-JIT-supp.patch)
download | inline diff:
From 8c8c199aaf4cc6e32c123b339480c1875eeb2a3f Mon Sep 17 00:00:00 2001
From: Fujii Masao <[email protected]>
Date: Mon, 20 Apr 2026 17:54:50 +0900
Subject: [PATCH v1 1/2] doc: Correct context description for some JIT support
GUCs
The documentation for jit_debugging_support and jit_profiling_support
previously stated that these parameters can only be set at server start.
However, both parameters use the PGC_SU_BACKEND context, meaning they
can be set at session start by superusers or users granted the appropriate
SET privilege, but cannot be changed within an active session.
This commit updates the documentation to reflect the actual behavior.
Backpatch to all supported versions.
---
doc/src/sgml/config.sgml | 8 ++++++--
1 file changed, 6 insertions(+), 2 deletions(-)
diff --git a/doc/src/sgml/config.sgml b/doc/src/sgml/config.sgml
index 67da9a1de66..893e2742e61 100644
--- a/doc/src/sgml/config.sgml
+++ b/doc/src/sgml/config.sgml
@@ -13263,7 +13263,9 @@ LOG: CleanUpLock: deleting: lock(0xb7acd844) id(24688,24696,0,0,0,1)
If LLVM has the required functionality, register generated functions
with <productname>GDB</productname>. This makes debugging easier.
The default setting is <literal>off</literal>.
- This parameter can only be set at server start.
+ Only superusers and users with the appropriate <literal>SET</literal>
+ privilege can change this parameter at session start,
+ and it cannot be changed at all within a session.
</para>
</listitem>
</varlistentry>
@@ -13314,7 +13316,9 @@ LOG: CleanUpLock: deleting: lock(0xb7acd844) id(24688,24696,0,0,0,1)
This writes out files to <filename>~/.debug/jit/</filename>; the
user is responsible for performing cleanup when desired.
The default setting is <literal>off</literal>.
- This parameter can only be set at server start.
+ Only superusers and users with the appropriate <literal>SET</literal>
+ privilege can change this parameter at session start,
+ and it cannot be changed at all within a session.
</para>
</listitem>
</varlistentry>
--
2.53.0
[application/octet-stream] v1-0002-doc-Use-integer-for-some-I-O-worker-GUC-type-desc.patch (2.1K, ../CAHGQGwEpMDpB-K8SSUVRRHg6L6z3pLAkekd9aviOS=ns0EC=+Q@mail.gmail.com/4-v1-0002-doc-Use-integer-for-some-I-O-worker-GUC-type-desc.patch)
download | inline diff:
From 9d1cebafb2614324000ee00fdf843c78edbc1416 Mon Sep 17 00:00:00 2001
From: Fujii Masao <[email protected]>
Date: Mon, 20 Apr 2026 13:13:03 +0900
Subject: [PATCH v1 2/2] doc: Use "integer" for some I/O worker GUC type
descriptions
The documentation previously described the io_max_workers,
io_worker_idle_timeout, and io_worker_launch_interval GUCs as
type "int". However, the documentation consistently uses "integer"
for parameters of this type.
This commit updates these parameter descriptions to use "integer"
for consistency.
---
doc/src/sgml/config.sgml | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/doc/src/sgml/config.sgml b/doc/src/sgml/config.sgml
index 893e2742e61..73cc0412330 100644
--- a/doc/src/sgml/config.sgml
+++ b/doc/src/sgml/config.sgml
@@ -2999,7 +2999,7 @@ include_dir 'conf.d'
</listitem>
</varlistentry>
<varlistentry id="guc-io-max-workers" xreflabel="io_max_workers">
- <term><varname>io_max_workers</varname> (<type>int</type>)
+ <term><varname>io_max_workers</varname> (<type>integer</type>)
<indexterm>
<primary><varname>io_max_workers</varname> configuration parameter</primary>
</indexterm>
@@ -3018,7 +3018,7 @@ include_dir 'conf.d'
</listitem>
</varlistentry>
<varlistentry id="guc-io-worker-idle-timeout" xreflabel="io_worker_idle_timeout">
- <term><varname>io_worker_idle_timeout</varname> (<type>int</type>)
+ <term><varname>io_worker_idle_timeout</varname> (<type>integer</type>)
<indexterm>
<primary><varname>io_worker_idle_timeout</varname> configuration parameter</primary>
</indexterm>
@@ -3038,7 +3038,7 @@ include_dir 'conf.d'
</listitem>
</varlistentry>
<varlistentry id="guc-io-worker-launch-interval" xreflabel="io_worker_launch_interval">
- <term><varname>io_worker_launch_interval</varname> (<type>int</type>)
+ <term><varname>io_worker_launch_interval</varname> (<type>integer</type>)
<indexterm>
<primary><varname>io_worker_launch_interval</varname> configuration parameter</primary>
</indexterm>
--
2.53.0
view thread (3+ messages) latest in thread
reply
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Reply to all the recipients using the --to and --cc options:
reply via email
To: [email protected]
Cc: [email protected], [email protected]
Subject: Re: Two small doc fixes for config.sgml
In-Reply-To: <CAHGQGwEpMDpB-K8SSUVRRHg6L6z3pLAkekd9aviOS=ns0EC=+Q@mail.gmail.com>
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
This inbox is served by agora; see mirroring instructions
for how to clone and mirror all data and code used for this inbox