[PATCH] doc: Fix pg_combinebackup's description of --sync-method

From: Raja Sai pranav <rajasaipranav0(at)gmail(dot)com>
To: pgsql-hackers(at)lists(dot)postgresql(dot)org
Cc: robertmhaas(at)gmail(dot)com
Subject: [PATCH] doc: Fix pg_combinebackup's description of --sync-method
Date: 2026-11-04 17:42:57
Message-ID: CAPHduZAYBNVWkXAsrXXrb+dD2gKDABcJfcudXQecFdW2WEpDdw@mail.gmail.com
Views: Whole Thread | Raw Message | Download mbox | Resend email
Thread:
Lists: pgsql-hackers

Hi,

The --sync-method entry on the pg_combinebackup reference page was copied
from pg_basebackup and still says "When the plain format is used" twice,
but pg_combinebackup has no format option: it always writes a plain data
directory. It also says the "backup directory" is synchronized, which is
ambiguous for a tool whose inputs are backup directories; what it syncs is
the output directory (sync_pgdata() on opt.output), always following the
WAL directory and tablespace symbolic links.

The attached patch drops the two references to the plain format and says
"output directory". The text is the same on REL_17_STABLE and
REL_18_STABLE, and the patch applies to both; the docs build and validate.

Regards,
Sai Pranav

Attachment Content-Type Size
v1-0001-doc-Fix-pg_combinebackup-s-description-of-sync-me.patch text/x-patch 2.3 KB

Browse pgsql-hackers by date

  From Date Subject
Next Message Raja Sai pranav 2026-11-04 17:47:27 Re: Re: Add a hint to the "WAL summaries are required" errors
Previous Message Greg Burd 2026-11-04 17:38:49 Re: nbtree: opt-in leaf key prefix compression