Corresponding documentation page does not mention about `spread` mode

Started by PG Bug reporting formover 2 years ago3 messagesdocs
Jump to latest
#1PG Bug reporting form
noreply@postgresql.org

The following documentation comment has been logged on the website:

Page: https://www.postgresql.org/docs/16/app-pgbasebackup.html
Description:

Hello.

On [this
page](https://www.postgresql.org/docs/current/app-pgbasebackup.html)
`spread` is mentioned:

-c {fast|spread}
--checkpoint={fast|spread}

Sets checkpoint mode to fast (immediate) or spread (the default) (see
Section 26.3.3).

But mentioned section 26.3.3 does not describe `spread` mode:
https://www.postgresql.org/docs/current/continuous-archiving.html#BACKUP-LOWLEVEL-BASE-BACKUP

It seems https://www.postgresql.org/docs/current/app-pgbasebackup.html
should be updated.

#2David G. Johnston
david.g.johnston@gmail.com
In reply to: PG Bug reporting form (#1)
Re: Corresponding documentation page does not mention about `spread` mode

On Tue, Oct 3, 2023 at 2:48 PM PG Doc comments form <noreply@postgresql.org>
wrote:

On [this
page](https://www.postgresql.org/docs/current/app-pgbasebackup.html)
`spread` is mentioned:

-c {fast|spread}
--checkpoint={fast|spread}

Sets checkpoint mode to fast (immediate) or spread (the default) (see
Section 26.3.3).

But mentioned section 26.3.3 does not describe `spread` mode:

https://www.postgresql.org/docs/current/continuous-archiving.html#BACKUP-LOWLEVEL-BASE-BACKUP

It does, though it is phrased in terms of "fast => false" meaning "spread"
whereas "fast => true" means "immediate".

But since the CLI wanted a label instead of true/false it had to call the
default "not fast" mode something and it chose "spread".

Not saying this couldn't be made more clear/better but it is accurate and
complete.

David J.

#3Tom Lane
tgl@sss.pgh.pa.us
In reply to: David G. Johnston (#2)
Re: Corresponding documentation page does not mention about `spread` mode

"David G. Johnston" <david.g.johnston@gmail.com> writes:

On Tue, Oct 3, 2023 at 2:48 PM PG Doc comments form <noreply@postgresql.org>
wrote:

But mentioned section 26.3.3 does not describe `spread` mode:

It does, though it is phrased in terms of "fast => false" meaning "spread"
whereas "fast => true" means "immediate".
But since the CLI wanted a label instead of true/false it had to call the
default "not fast" mode something and it chose "spread".
Not saying this couldn't be made more clear/better but it is accurate and
complete.

Perhaps a parenthetical remark like "(pg_basebackup refers to this as
'spread' mode)" would help?

regards, tom lane