pgsql: doc: Fix confusing description of streaming option in START_REPL

From: Fujii Masao <fujii(at)postgresql(dot)org>
To: pgsql-committers(at)lists(dot)postgresql(dot)org
Subject: pgsql: doc: Fix confusing description of streaming option in START_REPL
Date: 2025-07-15 23:35:59
Message-ID: E1ubpBn-006UU2-2M@gemulon.postgresql.org
Views: Whole Thread | Raw Message | Download mbox | Resend email
Thread:
Lists: pgsql-committers

doc: Fix confusing description of streaming option in START_REPLICATION.

Previously, the documentation described the streaming option as a boolean,
which is outdated since it's no longer a boolean as of protocol version 4.
This could confuse users.

This commit updates the description to remove the "boolean" reference and
clearly list the valid values for the streaming option.

Back-patch to v16, where the streaming option changed to a non-boolean.

Author: Euler Taveira <euler(at)eulerto(dot)com>
Reviewed-by: Fujii Masao <masao(dot)fujii(at)gmail(dot)com>
Discussion: https://postgr.es/m/8d21fb98-5c25-4dee-8387-e5a62b01ea7d@app.fastmail.com
Backpatch-through: 16

Branch
------
REL_16_STABLE

Details
-------
https://git.postgresql.org/pg/commitdiff/e92573917a49ce7d8d0cb5f996813500945616ee

Modified Files
--------------
doc/src/sgml/protocol.sgml | 12 +++++++-----
1 file changed, 7 insertions(+), 5 deletions(-)

Browse pgsql-committers by date

  From Date Subject
Next Message Fujii Masao 2025-07-15 23:53:32 pgsql: doc: Document default values for pgoutput options in protocol.sg
Previous Message Fujii Masao 2025-07-15 23:35:46 pgsql: doc: Fix confusing description of streaming option in START_REPL