pg.ddx.io pgsql-docs@postgresql.org mailing list archive
help / color / mirror / Atom feedCorresponding documentation page does not mention about `spread` mode
3+ messages / 3 participants
[nested] [flat]
* Corresponding documentation page does not mention about `spread` mode
@ 2023-10-03 19:25 PG Doc comments form <noreply@postgresql.org>
2023-10-03 21:56 ` Re: Corresponding documentation page does not mention about `spread` mode David G. Johnston <david.g.johnston@gmail.com>
0 siblings, 1 reply; 3+ messages in thread
From: PG Doc comments form @ 2023-10-03 19:25 UTC (permalink / raw)
To: pgsql-docs@lists.postgresql.org; +Cc: konkove@gmail.com
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.
^ permalink raw reply [nested|flat] 3+ messages in thread
* Re: Corresponding documentation page does not mention about `spread` mode
2023-10-03 19:25 Corresponding documentation page does not mention about `spread` mode PG Doc comments form <noreply@postgresql.org>
@ 2023-10-03 21:56 ` David G. Johnston <david.g.johnston@gmail.com>
2023-10-03 22:44 ` Re: Corresponding documentation page does not mention about `spread` mode Tom Lane <tgl@sss.pgh.pa.us>
0 siblings, 1 reply; 3+ messages in thread
From: David G. Johnston @ 2023-10-03 21:56 UTC (permalink / raw)
To: konkove@gmail.com; pgsql-docs@lists.postgresql.org
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.
^ permalink raw reply [nested|flat] 3+ messages in thread
* Re: Corresponding documentation page does not mention about `spread` mode
2023-10-03 19:25 Corresponding documentation page does not mention about `spread` mode PG Doc comments form <noreply@postgresql.org>
2023-10-03 21:56 ` Re: Corresponding documentation page does not mention about `spread` mode David G. Johnston <david.g.johnston@gmail.com>
@ 2023-10-03 22:44 ` Tom Lane <tgl@sss.pgh.pa.us>
0 siblings, 0 replies; 3+ messages in thread
From: Tom Lane @ 2023-10-03 22:44 UTC (permalink / raw)
To: David G. Johnston <david.g.johnston@gmail.com>; +Cc: konkove@gmail.com; pgsql-docs@lists.postgresql.org
"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
^ permalink raw reply [nested|flat] 3+ messages in thread
end of thread, other threads:[~2023-10-03 22:44 UTC | newest]
Thread overview: 3+ messages (download: mbox mbox.gz follow: Atom feed)
-- links below jump to the message on this page --
2023-10-03 19:25 Corresponding documentation page does not mention about `spread` mode PG Doc comments form <noreply@postgresql.org>
2023-10-03 21:56 ` David G. Johnston <david.g.johnston@gmail.com>
2023-10-03 22:44 ` Tom Lane <tgl@sss.pgh.pa.us>
This inbox is served by DDX for PostgreSQL; see mirroring instructions
for how to clone and mirror all data and code used for this inbox