pgsql: doc: Clarify meaning of "idle" in idle_replication_slot_timeout. - Mailing list pgsql-committers

From Fujii Masao
Subject pgsql: doc: Clarify meaning of "idle" in idle_replication_slot_timeout.
Date
Msg-id E1ua0yD-005fEz-2l@gemulon.postgresql.org
Whole thread Raw
List pgsql-committers
doc: Clarify meaning of "idle" in idle_replication_slot_timeout.

This commit updates the documentation to clarify that "idle" in
idle_replication_slot_timeout means the replication slot is inactive,
that is, not currently used by any replication connection.

Without this clarification, "idle" could be misinterpreted to mean
that the slot is not advancing or that no data is being streamed,
even if a connection exists.

Back-patch to v18 where idle_replication_slot_timeout was added.

Author: Laurenz Albe <laurenz.albe@cybertec.at>
Reviewed-by: David G. Johnston <david.g.johnston@gmail.com>
Reviewed-by: Gunnar Morling <gunnar.morling@googlemail.com>
Reviewed-by: Amit Kapila <amit.kapila16@gmail.com>
Reviewed-by: Fujii Masao <masao.fujii@gmail.com>
Discussion: https://postgr.es/m/CADGJaX_0+FTguWpNSpgVWYQP_7MhoO0D8=cp4XozSQgaZ40Odw@mail.gmail.com
Backpatch-through: 18

Branch
------
master

Details
-------
https://git.postgresql.org/pg/commitdiff/110e6dcaa6595cf71be00808e3df0087d1d2b208

Modified Files
--------------
doc/src/sgml/config.sgml       | 10 ++++++----
doc/src/sgml/system-views.sgml |  2 +-
src/backend/replication/slot.c |  2 +-
3 files changed, 8 insertions(+), 6 deletions(-)


pgsql-committers by date:

Previous
From: Fujii Masao
Date:
Subject: pgsql: Change unit of idle_replication_slot_timeout to seconds.
Next
From: Fujii Masao
Date:
Subject: pgsql: doc: Clarify meaning of "idle" in idle_replication_slot_timeout.