pgsql: doc: Clarify pg_combinebackup's --sync-method description

From: Fujii Masao <fujii(at)postgresql(dot)org>
To: pgsql-committers(at)lists(dot)postgresql(dot)org
Subject: pgsql: doc: Clarify pg_combinebackup's --sync-method description
Date: 2026-11-11 00:54:13
Message-ID: E1xQwbN-00000000F9l-1mNd@gemulon.postgresql.org
Views: Whole Thread | Raw Message | Download mbox | Resend email
Thread:
Lists: pgsql-committers

doc: Clarify pg_combinebackup's --sync-method description

The --sync-method documentation, copied from pg_basebackup,
referred to "the plain format", although pg_combinebackup always
produces a plain data directory. It also called the directory being
synchronized the "backup directory", which could be confused with an
input backup directory.

Remove the inapplicable format qualifications and explicitly
identify the output directory as the synchronization target.

Backpatch to v17, where pg_combinebackup was introduced.

Author: Sai Pranav <rajasaipranav0(at)gmail(dot)com>
Reviewed-by: Fujii Masao <masao(dot)fujii(at)gmail(dot)com>
Discussion: https://postgr.es/m/CAPHduZAYBNVWkXAsrXXrb+dD2gKDABcJfcudXQecFdW2WEpDdw@mail.gmail.com
Backpatch-through: 17

Branch
------
REL_19_STABLE

Details
-------
https://git.postgresql.org/pg/commitdiff/25cf49592c6ee8e45c75899e4faa7b9088b54611

Modified Files
--------------
doc/src/sgml/ref/pg_combinebackup.sgml | 11 +++++------
1 file changed, 5 insertions(+), 6 deletions(-)

Browse pgsql-committers by date

  From Date Subject
Next Message Fujii Masao 2026-11-11 00:54:23 pgsql: doc: Remove incorrect libpq environment reference from pg_combin
Previous Message Fujii Masao 2026-11-11 00:54:00 pgsql: doc: Remove incorrect libpq environment reference from pg_combin