From: Bruce Momjian <bruce@momjian.us>
To: Bruce Momjian <bruce@momjian.us>
Cc: Kevin Grittner <Kevin.Grittner@wicourts.gov>
Cc: Peter Eisentraut <peter_e@gmx.net>
Cc: PostgreSQL-documentation <pgsql-docs@postgresql.org>
Subject: Re: use of '=' in long options documentation
Date: Thu, 10 Mar 2011 09:10:53 -0500 (EST)
Message-ID: <201103101410.p2AEArQ08467@momjian.us> (raw)
In-Reply-To: <201103091658.p29GwKP15108@momjian.us>
Applied.
---------------------------------------------------------------------------
Bruce Momjian wrote:
> Kevin Grittner wrote:
> > Bruce Momjian <bruce@momjian.us> wrote:
> > > Peter Eisentraut wrote:
> > >> On tis, 2011-03-08 at 22:32 -0500, Bruce Momjian wrote:
> > >>> Looking at our ref pages, I see some manual pages specify long
> > >>> options that take arguments using '=', e.g. initdb.sgml:
> > >>>
> > >>> --long-opt=opt
> > >>>
> > >>> and some do not, e.g. pg_dump.sgml:
> > >>>
> > >>> --long-opt opt
> > >>>
> > >>> So, which should we use, for consistency?
> > >>
> > >> Using = is more common usage, I think.
> > >
> > > Yeah! Someone chimed in with a vote! I will update the docs, but
> > > not adjust any summary that has a space after the equals, e.g.
> > > initdb.
> >
> > I agree that using = is more common; but also that anything
> > suggesting that a space after the = should be avoided. I think it's
> > preferable to show the = when possible without misleading, and omit
> > it when it would mislead. Accuracy should trump consistency here
> > IMO. I think it's OK to omit in summary and show in detail.
>
> OK, agreed. I am working on a patch and will post it for review.
>
> --
> Bruce Momjian <bruce@momjian.us> http://momjian.us
> EnterpriseDB http://enterprisedb.com
>
> + It's impossible for everything to be true. +
>
> --
> Sent via pgsql-docs mailing list (pgsql-docs@postgresql.org)
> To make changes to your subscription:
> http://www.postgresql.org/mailpref/pgsql-docs
--
Bruce Momjian <bruce@momjian.us> http://momjian.us
EnterpriseDB http://enterprisedb.com
+ It's impossible for everything to be true. +
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: bruce@momjian.us, Kevin.Grittner@wicourts.gov, peter_e@gmx.net
Subject: Re: use of '=' in long options documentation
In-Reply-To: <201103101410.p2AEArQ08467@momjian.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