From: Tom Lane <tgl@sss.pgh.pa.us>
To: David G. Johnston <david.g.johnston@gmail.com>
Cc: Robert Inder <robert@interactive.co.uk>
Cc: Pg Docs <pgsql-docs@lists.postgresql.org>
Subject: Re: PostgreSQL 12: Cryptic documentation
Date: Sat, 15 Aug 2020 12:38:47 -0400
Message-ID: <904676.1597509527@sss.pgh.pa.us> (raw)
In-Reply-To: <CAKFQuwaM_2ocg33k6esUA6_4dZEkmaEPubQc=QGFpNR3VmmN=w@mail.gmail.com>
References: <159749418850.14322.216503677134569752@wrigleys.postgresql.org>
<CAKFQuwaM_2ocg33k6esUA6_4dZEkmaEPubQc=QGFpNR3VmmN=w@mail.gmail.com>
"David G. Johnston" <david.g.johnston@gmail.com> writes:
> As with most things there is always room for improvement. In this case,
> though, I'm not seeing anything wrong with the direct wording provided.
Also, it's under a heading that says "The following command-line options
control the location and format of the output", which ought to make it
clear that it's not about the source server's WAL dir. (Although I notice
that whoever added the --max-rate parameter didn't read that heading :-()
Still, I see that the main -D parameter is described as "Directory to
write the output to", which seems like a clearer phrasing, so I'm inclined
to similarly reword the description of --waldir.
A more direct criticism of the --waldir description is that it's not
stated what happens if you don't provide that argument.
I notice some shaky grammar and other minor annoyances in this page,
so I'm kind of inclined to make an editorial pass over the whole thing.
regards, tom lane
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Reply to all the recipients using the --to and --cc options:
reply via email
To: pgsql-docs@postgresql.org
Cc: tgl@sss.pgh.pa.us, david.g.johnston@gmail.com, robert@interactive.co.uk, pgsql-docs@lists.postgresql.org
Subject: Re: PostgreSQL 12: Cryptic documentation
In-Reply-To: <904676.1597509527@sss.pgh.pa.us>
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
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