From: Tom Lane <tgl@sss.pgh.pa.us>
To: Bruce Momjian <bruce@momjian.us>
Cc: PostgreSQL-documentation <pgsql-docs@postgresql.org>
Subject: Re: Improve initdb and pg_controldata manual pages
Date: Wed, 09 Mar 2011 10:57:48 -0500
Message-ID: <25000.1299686268@sss.pgh.pa.us> (raw)
In-Reply-To: <201103091551.p29FpW126215@momjian.us>
References: <201103091551.p29FpW126215@momjian.us>
Bruce Momjian <bruce@momjian.us> writes:
> Well, looking at the detailed option list, it looks fine:
> -D directory
> --pgdata=directory
> It is only at the top where we see the problem because -D/--pgdata is a
> required argument and there are necesary spaces because we are showing
> both -D and --pgdata followed by a single argument. The original patch
> creator added '=' to be consistent with the syntax used below.
> The bottom line is that there are many doc cases where this is used:
> -D directory
> --pgdata directory
> (no '='), so we should decide what we want in the docs.
Right. I think it's fine if the syntax summary shows only those cases,
especially if the detailed option list shows that "=" is possible too.
What is important to me is that the summary not suggest illegal syntaxes
to people.
> Does professionally produced documentation have as many inconsistencies?
Hard to say. We have the problem that our docs were made by a lot of
people over a long period of time, so inconsistencies are a fact of
life. "Pro" documentation might be more consistent if it's written by a
smaller group of people over a shorter period of time...
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, bruce@momjian.us
Subject: Re: Improve initdb and pg_controldata manual pages
In-Reply-To: <25000.1299686268@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