agora inbox for pgsql-committers@postgresql.org  
help / color / mirror / Atom feed
From: Fujii Masao <fujii@postgresql.org>
To: pgsql-committers@lists.postgresql.org
Subject: pgsql: doc: Clarify wal_sender_shutdown_timeout values
Date: Wed, 05 Aug 2026 02:32:39 +0000
Message-ID: <E1wrRQt-00000000F14-1nyU@gemulon.postgresql.org> (raw)

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@highgo.com>
Reviewed-by: Ian Barwick <barwick@gmail.com>
Reviewed-by: Daniel Gustafsson <daniel@yesql.se>
Reviewed-by: Fujii Masao <masao.fujii@gmail.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(-)



view thread (2+ messages)

Message-ID: <E1wrRQt-00000000F14-1nyU@gemulon.postgresql.org>
Permalink:  ../E1wrRQt-00000000F14-1nyU@gemulon.postgresql.org/
Also on:    postgresql.org/message-id/E1wrRQt-00000000F14-1nyU@gemulon.postgresql.org

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: pgsql-committers@postgresql.org
  Cc: fujii@postgresql.org, pgsql-committers@lists.postgresql.org
  Subject: Re: pgsql: doc: Clarify wal_sender_shutdown_timeout values
  In-Reply-To: <E1wrRQt-00000000F14-1nyU@gemulon.postgresql.org>

* 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