Received: from maia.hub.org (maia-2.hub.org [200.46.204.251]) by mail.postgresql.org (Postfix) with ESMTP id 817D91337B82 for ; Thu, 10 Mar 2011 10:11:08 -0400 (AST) Received: from mail.postgresql.org ([200.46.204.86]) by maia.hub.org (mx1.hub.org [200.46.204.251]) (amavisd-maia, port 10024) with ESMTP id 81391-01 for ; Thu, 10 Mar 2011 14:11:01 +0000 (UTC) X-Greylist: from auto-whitelisted by SQLgrey-1.7.6 Received: from momjian.us (momjian.us [70.90.9.53]) by mail.postgresql.org (Postfix) with ESMTP id C4FD61337BA6 for ; Thu, 10 Mar 2011 10:11:00 -0400 (AST) Received: (from bruce@localhost) by momjian.us (8.11.6/8.11.6) id p2AEArQ08467; Thu, 10 Mar 2011 09:10:53 -0500 (EST) From: Bruce Momjian Message-Id: <201103101410.p2AEArQ08467@momjian.us> Subject: Re: use of '=' in long options documentation In-Reply-To: <201103091658.p29GwKP15108@momjian.us> To: Bruce Momjian Date: Thu, 10 Mar 2011 09:10:53 -0500 (EST) CC: Kevin Grittner , Peter Eisentraut , PostgreSQL-documentation X-Mailer: ELM [version 2.4ME+ PL124 (25)] MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Content-Type: text/plain; charset="US-ASCII" X-Virus-Scanned: Maia Mailguard 1.0.1 X-Spam-Status: No, hits=-1.91 tagged_above=-5 required=5 tests=BAYES_00=-1.9, T_RP_MATCHES_RCVD=-0.01 X-Spam-Level: X-Archive-Number: 201103/57 X-Sequence-Number: 6490 Applied. --------------------------------------------------------------------------- Bruce Momjian wrote: > Kevin Grittner wrote: > > Bruce Momjian 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 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 http://momjian.us EnterpriseDB http://enterprisedb.com + It's impossible for everything to be true. +