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 <[email protected]>
Reviewed-by: Ian Barwick <[email protected]>
Reviewed-by: Daniel Gustafsson <[email protected]>
Reviewed-by: Fujii Masao <[email protected]>
Discussion: https://postgr.es/m/[email protected]
Backpatch-through: 19

Branch
------
master

Details
-------
https://git.postgresql.org/pg/commitdiff/011bbdb4273feff7c1b2dbdb06692488e8a3ac21

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(-)

Reply via email to