Re: use of '=' in long options documentation - Mailing list pgsql-docs

From Kevin Grittner
Subject Re: use of '=' in long options documentation
Date
Msg-id 4D775C91020000250003B6E7@gw.wicourts.gov
Whole thread Raw
In response to Re: use of '=' in long options documentation  (Bruce Momjian <bruce@momjian.us>)
Responses Re: use of '=' in long options documentation  (Bruce Momjian <bruce@momjian.us>)
List pgsql-docs
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.

-Kevin

pgsql-docs by date:

Previous
From: Bruce Momjian
Date:
Subject: Re: use of '=' in long options documentation
Next
From: Bruce Momjian
Date:
Subject: Re: use of '=' in long options documentation