doc bug for continuous archiving - Mailing list pgsql-docs

From Jeff Janes
Subject doc bug for continuous archiving
Date
Msg-id CAMkU=1yORNa80450afEYsphadTA2WCRgWf3BYaqgJY14=F4kDg@mail.gmail.com
Whole thread Raw
Responses Re: doc bug for continuous archiving  ("David G. Johnston" <david.g.johnston@gmail.com>)
List pgsql-docs
Quoting the docs:

https://www.postgresql.org/docs/13/continuous-archiving.html

"As with base backups, the easiest way to produce a standalone hot backup is to use the pg_basebackup tool. If you include the -X parameter when calling it, all the write-ahead log required to use the backup will be included in the backup automatically, and no special action is required to restore the backup."

This makes it sound like -X is a switch option, when in fact it demands an argument.  The statement made is incorrect if the supplied argument is "none", but  is correct for the other two options.  Should this be changed to spell out which options it applies to (or maybe which option it does not apply to).

I think this has been wrong ever since the capitalized -X was introduced in 9.2.  Maybe it was intended to discuss -x, not -X ?

Cheers,

Jeff

pgsql-docs by date:

Previous
From: "David G. Johnston"
Date:
Subject: Re: 42.6.8.1. Obtaining Information About An Error
Next
From: "David G. Johnston"
Date:
Subject: Re: doc bug for continuous archiving