pgsql: doc: Clarify wal_sender_shutdown_timeout values

From: Fujii Masao <fujii(at)postgresql(dot)org>
To: pgsql-committers(at)lists(dot)postgresql(dot)org
Subject: pgsql: doc: Clarify wal_sender_shutdown_timeout values
Date: 2026-08-05 02:32:39
Message-ID: E1wrRQt-00000000F14-1nyU@gemulon.postgresql.org
Views: Whole Thread | Raw Message | Download mbox | Resend email
Thread:
Lists: pgsql-committers

doc: Clarify wal_sender_shutdown_timeout values

Clarify how special wal_sender_shutdown_timeout values affect shutdown
waiting. A value of -1 disables the shutdown timeout and lets the
WAL sender wait for the receiver to catch up, while 0 causes immediate
termination without waiting for catch-up. Positive values bound how long
shutdown waits, so document that they should be high enough for WAL data
to be replicated under normal circumstances.

Update the main documentation, the GUC long description, and
postgresql.conf.sample consistently. While here, fix nearby paragraph
indentation and spacing.

Backpatch to v19, where wal_sender_shutdown_timeout was introduced.

Author: Chao Li <lic(at)highgo(dot)com>
Reviewed-by: Ian Barwick <barwick(at)gmail(dot)com>
Reviewed-by: Daniel Gustafsson <daniel(at)yesql(dot)se>
Reviewed-by: Fujii Masao <masao(dot)fujii(at)gmail(dot)com>
Discussion: https://postgr.es/m/AF4FE756-A220-4DA7-87B7-A126F3F307FD@gmail.com
Backpatch-through: 19

Branch
------
REL_19_STABLE

Details
-------
https://git.postgresql.org/pg/commitdiff/1aaca5ab8ffb7f9387dce2a2de128eff006ac1c4

Modified Files
--------------
doc/src/sgml/config.sgml | 32 +++++++++++++++++----------
src/backend/utils/misc/guc_parameters.dat | 2 +-
src/backend/utils/misc/postgresql.conf.sample | 4 +++-
3 files changed, 24 insertions(+), 14 deletions(-)

Browse pgsql-committers by date

  From Date Subject
Next Message Fujii Masao 2026-08-05 02:38:49 pgsql: Clarify wraparound warning percentage messages
Previous Message Fujii Masao 2026-08-05 02:32:25 pgsql: doc: Clarify wal_sender_shutdown_timeout values