From: Junio C Hamano <gitster@pobox•com>
To: Christian Couder <chriscool@tuxfamily•org>
Cc: sunshine@sunshineco•com, git@vger•kernel.org, johan@herland•net,
josh@joshtriplett•org, tr@thomasrast•ch, mhagger@alum•mit.edu,
dan.carpenter@oracle•com, greg@kroah•com, peff@peff•net
Subject: Re: [PATCH v3 17/17] Documentation: add documentation for 'git interpret-trailers'
Date: Mon, 27 Jan 2014 13:20:18 -0800 [thread overview]
Message-ID: <xmqqfvo9nmul.fsf@gitster.dls.corp.google.com> (raw)
In-Reply-To: <20140127.213344.212708599170084659.chriscool@tuxfamily.org> (Christian Couder's message of "Mon, 27 Jan 2014 21:33:44 +0100 (CET)")
Christian Couder <chriscool@tuxfamily•org> writes:
>>> +'git interpret-trailers' [--trim-empty] [--infile=file] [<token[=value]>...]
>>
>> Would it be more consistent with existing documentation to format this as so?
>>
>> [--infile=<file>] [<token>[=<value>]]...
>
> No, it would be very inconsistent:
>
> $ grep '\.\.\.\]' *.txt | wc -l
> 103
> $ grep '\]\.\.\.' *.txt | wc -l
> 0
I have a feeling that you are missing the point Eric is making. The
value given to the --infile option can be anything, i.e. 'file'
there is a placeholder, hence "--infile=<file>" not "--infile=file"
as you wrote.
Also I think "[<token>[=<value>]]..." is the correct way to spell
that there can be 0 or more "<token>[=<value>]". "<token[=value]>"
in the original does not make any sense, as <> is meant to say "this
thing is a placeholder", and we do not try to say, with the string
inside <>, what shape that placeholder takes. In fact '=' part is
_not_ a placeholder but is required syntactically when you want to
supply a value to the token, so the original doubly is incorrect.
I find it a bad taste to allow unbound set of <token> on the LHS of
'=' on the command line, but that is a separate issue in the design,
not in the documentation of the design.
Thanks.
next prev parent reply other threads:[~2014-01-27 21:20 UTC|newest]
Thread overview: 26+ messages / expand[flat|nested] mbox.gz Atom feed top
2014-01-26 16:59 [PATCH v3 00/17] Add interpret-trailers builtin Christian Couder
2014-01-26 16:59 ` [PATCH v3 01/17] Add data structures and basic functions for commit trailers Christian Couder
2014-01-26 16:59 ` [PATCH v3 02/17] trailer: process trailers from file and arguments Christian Couder
2014-01-26 16:59 ` [PATCH v3 03/17] trailer: read and process config information Christian Couder
2014-01-26 16:59 ` [PATCH v3 04/17] trailer: process command line trailer arguments Christian Couder
2014-01-26 16:59 ` [PATCH v3 05/17] strbuf: add strbuf_isspace() Christian Couder
2014-01-26 16:59 ` [PATCH v3 06/17] trailer: parse trailers from input file Christian Couder
2014-01-26 17:00 ` [PATCH v3 07/17] trailer: put all the processing together and print Christian Couder
2014-01-26 17:00 ` [PATCH v3 08/17] trailer: add interpret-trailers command Christian Couder
2014-01-26 17:00 ` [PATCH v3 09/17] trailer: add tests for "git interpret-trailers" Christian Couder
2014-01-26 17:00 ` [PATCH v3 10/17] trailer: if no input file is passed, read from stdin Christian Couder
2014-01-26 17:00 ` [PATCH v3 11/17] trailer: add new_trailer_item() function Christian Couder
2014-01-26 17:00 ` [PATCH v3 12/17] strbuf: add strbuf_replace() Christian Couder
2014-01-26 17:00 ` [PATCH v3 13/17] trailer: execute command from 'trailer.<name>.command' Christian Couder
2014-01-26 17:00 ` [PATCH v3 14/17] trailer: add tests for trailer command Christian Couder
2014-01-26 17:00 ` [PATCH v3 15/17] trailer: set author and committer env variables Christian Couder
2014-01-26 17:00 ` [PATCH v3 16/17] trailer: add tests for commands using " Christian Couder
2014-01-26 17:00 ` [PATCH v3 17/17] Documentation: add documentation for 'git interpret-trailers' Christian Couder
2014-01-27 0:52 ` Eric Sunshine
2014-01-27 20:33 ` Christian Couder
2014-01-27 21:20 ` Junio C Hamano [this message]
2014-01-29 20:01 ` Christian Couder
2014-01-29 20:30 ` Junio C Hamano
2014-02-02 11:22 ` Eric Sunshine
2014-01-27 21:05 ` [PATCH v3 00/17] Add interpret-trailers builtin Junio C Hamano
2014-01-29 19:27 ` Christian Couder
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=xmqqfvo9nmul.fsf@gitster.dls.corp.google.com \
--to=gitster@pobox$(echo .)com \
--cc=chriscool@tuxfamily$(echo .)org \
--cc=dan.carpenter@oracle$(echo .)com \
--cc=git@vger$(echo .)kernel.org \
--cc=greg@kroah$(echo .)com \
--cc=johan@herland$(echo .)net \
--cc=josh@joshtriplett$(echo .)org \
--cc=mhagger@alum$(echo .)mit.edu \
--cc=peff@peff$(echo .)net \
--cc=sunshine@sunshineco$(echo .)com \
--cc=tr@thomasrast$(echo .)ch \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox