Re: use of '=' in long options documentation

From: "Kevin Grittner" <Kevin(dot)Grittner(at)wicourts(dot)gov>
To: "Peter Eisentraut" <peter_e(at)gmx(dot)net>, "Bruce Momjian" <bruce(at)momjian(dot)us>
Cc: "PostgreSQL-documentation" <pgsql-docs(at)postgresql(dot)org>
Subject: Re: use of '=' in long options documentation
Date: 2011-03-09 16:55:13
Message-ID: 4D775C91020000250003B6E7@gw.wicourts.gov
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-docs

Bruce Momjian <bruce(at)momjian(dot)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.

-Kevin

In response to

Responses

Browse pgsql-docs by date

  From Date Subject
Next Message Bruce Momjian 2011-03-09 16:58:20 Re: use of '=' in long options documentation
Previous Message Bruce Momjian 2011-03-09 16:47:00 Re: use of '=' in long options documentation