From: Nathan Bossart <nathandbossart@gmail.com>
To: pgsql-hackers@postgresql.org
Subject: fixes for a few GUC descriptions
Date: Thu, 10 Sep 2026 16:41:54 -0500
Message-ID: <aqMkIpRr62cVqtCZ@nathan> (raw)
Some new parameters added since commit 977d865c36 do not follow the GUC
description rules established by that commit. I've attached a patch to fix
them.
--
nathan
From a5a85c3f701631e148fe05613b0ec0b7d83776eb Mon Sep 17 00:00:00 2001
From: Nathan Bossart <nathan@postgresql.org>
Date: Thu, 10 Sep 2026 16:35:45 -0500
Subject: [PATCH v1 1/1] Describe special values in more GUC descriptions.
Commit 977d865c36 established some rules for mentioning special
values (e.g., -1, 0, an empty string) in GUC descriptions. A few
parameters either neglect to mention their special values or
describe them in a way that doesn't follow those rules. Most of
these parameters were added after the aforementioned commit, but
one was simply missed. This commit fixes them.
---
src/backend/utils/misc/guc_parameters.dat | 9 ++++++---
1 file changed, 6 insertions(+), 3 deletions(-)
diff --git a/src/backend/utils/misc/guc_parameters.dat b/src/backend/utils/misc/guc_parameters.datindex 93a434858bf..9f2d739ebc3 100644--- a/src/backend/utils/misc/guc_parameters.dat+++ b/src/backend/utils/misc/guc_parameters.dat@@ -1303,6 +1303,7 @@
{ name => 'idle_replication_slot_timeout', type => 'int', context => 'PGC_SIGHUP', group => 'REPLICATION_SENDING',
short_desc => 'Sets the duration a replication slot can remain idle before it is invalidated.',
+ long_desc => '0 disables the timeout.',
flags => 'GUC_UNIT_S',
variable => 'idle_replication_slot_timeout_secs',
boot_val => '0',
@@ -1389,6 +1390,7 @@
{ name => 'io_max_concurrency', type => 'int', context => 'PGC_POSTMASTER', group => 'RESOURCES_IO',
short_desc => 'Max number of IOs that one process can execute simultaneously.',
+ long_desc => '-1 means use a value based on "shared_buffers" and the maximum number of processes.',
variable => 'io_max_concurrency',
boot_val => '-1',
min => '-1',
@@ -1876,7 +1878,7 @@
{ name => 'log_statement_max_length', type => 'int', context => 'PGC_SUSET', group => 'LOGGING_WHAT',
short_desc => 'Sets the maximum length in bytes of logged statement text.',
- long_desc => '-1 means log statement in full; 0 means log only an ellipsis.',+ long_desc => '-1 means log statements in full. 0 means log only an ellipsis.',
flags => 'GUC_UNIT_BYTE',
variable => 'log_statement_max_length',
boot_val => '-1',
@@ -2368,7 +2370,7 @@
{ name => 'password_expiration_warning_threshold', type => 'int', context => 'PGC_SIGHUP', group => 'CONN_AUTH_AUTH',
short_desc => 'Threshold for password expiration warnings.',
- long_desc => '0 means not to emit these warnings.',+ long_desc => '0 disables these warnings.',
flags => 'GUC_UNIT_S',
variable => 'password_expiration_warning_threshold',
boot_val => '604800',
@@ -3580,7 +3582,7 @@
{ name => 'wal_sender_shutdown_timeout', type => 'int', context => 'PGC_USERSET', group => 'REPLICATION_SENDING',
short_desc => 'Sets the maximum time the server waits during shutdown for all WAL data to be replicated to the receiver.',
- long_desc => '-1 disables the timeout and waits for the receiver to catch up; 0 does not wait for the receiver to catch up.',+ long_desc => '-1 disables the timeout. 0 means do not wait for the receiver to catch up.',
flags => 'GUC_UNIT_MS',
variable => 'wal_sender_shutdown_timeout',
boot_val => '-1',
@@ -3590,6 +3592,7 @@
{ name => 'wal_sender_timeout', type => 'int', context => 'PGC_USERSET', group => 'REPLICATION_SENDING',
short_desc => 'Sets the maximum time to wait for WAL replication.',
+ long_desc => '0 disables the timeout.',
flags => 'GUC_UNIT_MS',
variable => 'wal_sender_timeout',
boot_val => '60 * 1000',
--
2.55.0
Attachments:
[text/plain] v1-0001-Describe-special-values-in-more-GUC-descriptions.patch (3.4K, ../aqMkIpRr62cVqtCZ@nathan/2-v1-0001-Describe-special-values-in-more-GUC-descriptions.patch)
download | inline diff:
From a5a85c3f701631e148fe05613b0ec0b7d83776eb Mon Sep 17 00:00:00 2001
From: Nathan Bossart <nathan@postgresql.org>
Date: Thu, 10 Sep 2026 16:35:45 -0500
Subject: [PATCH v1 1/1] Describe special values in more GUC descriptions.
Commit 977d865c36 established some rules for mentioning special
values (e.g., -1, 0, an empty string) in GUC descriptions. A few
parameters either neglect to mention their special values or
describe them in a way that doesn't follow those rules. Most of
these parameters were added after the aforementioned commit, but
one was simply missed. This commit fixes them.
---
src/backend/utils/misc/guc_parameters.dat | 9 ++++++---
1 file changed, 6 insertions(+), 3 deletions(-)
diff --git a/src/backend/utils/misc/guc_parameters.dat b/src/backend/utils/misc/guc_parameters.datindex 93a434858bf..9f2d739ebc3 100644--- a/src/backend/utils/misc/guc_parameters.dat+++ b/src/backend/utils/misc/guc_parameters.dat@@ -1303,6 +1303,7 @@
{ name => 'idle_replication_slot_timeout', type => 'int', context => 'PGC_SIGHUP', group => 'REPLICATION_SENDING',
short_desc => 'Sets the duration a replication slot can remain idle before it is invalidated.',
+ long_desc => '0 disables the timeout.',
flags => 'GUC_UNIT_S',
variable => 'idle_replication_slot_timeout_secs',
boot_val => '0',
@@ -1389,6 +1390,7 @@
{ name => 'io_max_concurrency', type => 'int', context => 'PGC_POSTMASTER', group => 'RESOURCES_IO',
short_desc => 'Max number of IOs that one process can execute simultaneously.',
+ long_desc => '-1 means use a value based on "shared_buffers" and the maximum number of processes.',
variable => 'io_max_concurrency',
boot_val => '-1',
min => '-1',
@@ -1876,7 +1878,7 @@
{ name => 'log_statement_max_length', type => 'int', context => 'PGC_SUSET', group => 'LOGGING_WHAT',
short_desc => 'Sets the maximum length in bytes of logged statement text.',
- long_desc => '-1 means log statement in full; 0 means log only an ellipsis.',+ long_desc => '-1 means log statements in full. 0 means log only an ellipsis.',
flags => 'GUC_UNIT_BYTE',
variable => 'log_statement_max_length',
boot_val => '-1',
@@ -2368,7 +2370,7 @@
{ name => 'password_expiration_warning_threshold', type => 'int', context => 'PGC_SIGHUP', group => 'CONN_AUTH_AUTH',
short_desc => 'Threshold for password expiration warnings.',
- long_desc => '0 means not to emit these warnings.',+ long_desc => '0 disables these warnings.',
flags => 'GUC_UNIT_S',
variable => 'password_expiration_warning_threshold',
boot_val => '604800',
@@ -3580,7 +3582,7 @@
{ name => 'wal_sender_shutdown_timeout', type => 'int', context => 'PGC_USERSET', group => 'REPLICATION_SENDING',
short_desc => 'Sets the maximum time the server waits during shutdown for all WAL data to be replicated to the receiver.',
- long_desc => '-1 disables the timeout and waits for the receiver to catch up; 0 does not wait for the receiver to catch up.',+ long_desc => '-1 disables the timeout. 0 means do not wait for the receiver to catch up.',
flags => 'GUC_UNIT_MS',
variable => 'wal_sender_shutdown_timeout',
boot_val => '-1',
@@ -3590,6 +3592,7 @@
{ name => 'wal_sender_timeout', type => 'int', context => 'PGC_USERSET', group => 'REPLICATION_SENDING',
short_desc => 'Sets the maximum time to wait for WAL replication.',
+ long_desc => '0 disables the timeout.',
flags => 'GUC_UNIT_MS',
variable => 'wal_sender_timeout',
boot_val => '60 * 1000',
--
2.55.0
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: pgsql-hackers@postgresql.org
Cc: nathandbossart@gmail.com
Subject: Re: fixes for a few GUC descriptions
In-Reply-To: <aqMkIpRr62cVqtCZ@nathan>
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
This inbox is served by DDX for PostgreSQL; see mirroring instructions
for how to clone and mirror all data and code used for this inbox