Hi,
On Wed, Oct 25, 2023 at 04:36:41PM +0200, Peter Eisentraut wrote:
> On 19.10.23 11:39, Michael Banck wrote:
> > Hi,
> >
> > I believed that spread (not fast) checkpoints are the default in
> > pg_basebackup, but noticed that --help does not specify which is which -
> > contrary to the reference documentation.
> >
> > So I propose the small attached patch to clarify that.
>
> > printf(_(" -c, --checkpoint=fast|spread\n"
> >- " set fast or spread checkpointing\n"));
> >+ " set fast or spread (default)
> checkpointing\n"));
>
> Could we do like
>
> -c, --checkpoint=fast|spread
> set fast or spread checkpointing
> (default: spread)
>
> This seems to be easier to read.
Yeah, we could do that. But then again the question pops up what to do
about the other option that mentions defaults (-F) and the others which
have a default but it is not spelt out yet (-X, -Z at least) (output is
still from v15, additional options have been added since):
-F, --format=p|t output format (plain (default), tar)
-X, --wal-method=none|fetch|stream
include required WAL files with specified method
-Z, --compress=0-9 compress tar output with given compression level
So, my personal opinion is that we should really document -c because it
is quite user-noticable compared to the others.
So attached is a new version with just your proposed change for now.
Michael
>From 817f71f2eaa8814a30320bc1ef97c1ec8a95f083 Mon Sep 17 00:00:00 2001
From: Michael Banck <[email protected]>
Date: Thu, 19 Oct 2023 11:37:11 +0200
Subject: [PATCH v2] pg_basebackup: Mention that spread checkpoints are the
default in --help
---
src/bin/pg_basebackup/pg_basebackup.c | 1 +
1 file changed, 1 insertion(+)
diff --git a/src/bin/pg_basebackup/pg_basebackup.c b/src/bin/pg_basebackup/pg_basebackup.c
index 1a8cef345d..9957fb4f54 100644
--- a/src/bin/pg_basebackup/pg_basebackup.c
+++ b/src/bin/pg_basebackup/pg_basebackup.c
@@ -408,6 +408,7 @@ usage(void)
printf(_("\nGeneral options:\n"));
printf(_(" -c, --checkpoint=fast|spread\n"
" set fast or spread checkpointing\n"));
+ " (default: spread)\n"));
printf(_(" -C, --create-slot create replication slot\n"));
printf(_(" -l, --label=LABEL set backup label\n"));
printf(_(" -n, --no-clean do not clean up after errors\n"));
--
2.39.2
