doc bug for continuous archiving

From: Jeff Janes <jeff(dot)janes(at)gmail(dot)com>
To: pgsql-docs(at)postgresql(dot)org
Subject: doc bug for continuous archiving
Date: 2020-10-07 21:34:49
Message-ID: CAMkU=1yORNa80450afEYsphadTA2WCRgWf3BYaqgJY14=F4kDg@mail.gmail.com
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: 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

Responses

Browse pgsql-docs by date

  From Date Subject
Next Message David G. Johnston 2020-10-07 21:47:06 Re: doc bug for continuous archiving
Previous Message David G. Johnston 2020-10-07 20:54:34 Re: 42.6.8.1. Obtaining Information About An Error