From: Junio C Hamano <gitster@pobox•com>
To: Christian Couder <christian.couder@gmail•com>
Cc: Jonathan Nieder <jrnieder@gmail•com>,
Christian Couder <chriscool@tuxfamily•org>,
git <git@vger•kernel.org>, Josh Triplett <josh@joshtriplett•org>,
Eric Sunshine <sunshine@sunshineco•com>,
Ramsay Jones <ramsay@ramsay1•demon.co.uk>
Subject: Re: [PATCH v9 11/11] Documentation: add documentation for 'git interpret-trailers'
Date: Mon, 07 Apr 2014 09:52:59 -0700 [thread overview]
Message-ID: <xmqq4n25nkt0.fsf@gitster.dls.corp.google.com> (raw)
In-Reply-To: <CAP8UFD38TE=5zxvkDvLRsDTpC6zDo6EN5q_HJMQPbUBcfJVsSg@mail.gmail.com> (Christian Couder's message of "Mon, 7 Apr 2014 11:39:01 +0200")
Christian Couder <christian.couder@gmail•com> writes:
> On Sat, Apr 5, 2014 at 12:42 AM, Junio C Hamano <gitster@pobox•com> wrote:
>> Junio C Hamano <gitster@pobox•com> writes:
>>
>>> Christian Couder <christian.couder@gmail•com> writes:
>>> "The following features are planned but not yet implemented:
>>> - add more tests related to commands
>>> - add examples in documentation
>>> - integration with "git commit""
>>
>> I was planning to merge the series to 'next', but perhaps we should
>> wait at least for the first two items (I do not think the third one
>> is necessary to block the series).
>
> I will send soon a new version of the series with more tests and fixes.
> It will also contains a patch that adds an empty line before the
> trailers in the output if there is not already one.
Ah, yes, that one was mentioned in the reviews, I remember.
> After that I plan to work on adding examples to the documentation.
OK, thanks.
> First accepting both ':' and '=' means one can see the "git
> interpret-trailers" as acting on trailers only. Not just on trailers
> from the intput message and option parameters from the command line.
Sorry, you lost me. What does "acting on trailers only" really
mean? Do you mean the command should/can be run without any command
line options, pick up the existing "Signed-off-by:" and friends in
its input and emit its output, somehow taking these existing ones as
its instruction regarding how to transform the input to its output?
> And second there is also a practical advantage, as the user can
> copy-paste trailers directly from other messages into the command line
> to pass them as arguments to "git interpret-trailers" without the need
> to replace the ':' with '='. Even if this command is not often used
> directly by users, it might simplify scripts using it.
>
> Third there is a technical advantage which is that the code that
> parses arguments from the command line can be the same as the code
> that parses trailers from the input message.
I do not see these two as valid arguments to make the command line
more complex to the end users---who now need to know that only this
command treats its command line in a funny way, accepting a colon in
place of an equal sign.
A different way to sell a colon, e.g.
Consider the instruction sed takes on its command line.
(e.g. "sed 's/frotz/nitfol/' <xyzzy"). In the most general
form, you would always give it as the value of an '-e' option
(e.g. "sed -e 's/frotz/nitfol' <xyzzy"), but you are allowed to
be loose in limited occassions. "Key:value" is like that, and
in the most general form, it actually needs to be spelled as
"-e 'Key:value'".
is possible, but I do not think it is a particularly good analogy,
because what you have as the alternative is "Key=value", and not
"-e 'Key:value'", or "--Key=value" (the last would probably be the
most natural way to express this).
next prev parent reply other threads:[~2014-04-07 16:53 UTC|newest]
Thread overview: 24+ messages / expand[flat|nested] mbox.gz Atom feed top
2014-04-01 19:20 [PATCH v9 00/11] Add interpret-trailers builtin Christian Couder
2014-04-01 19:20 ` [PATCH v9 01/11] trailer: add data structures and basic functions Christian Couder
2014-04-01 19:20 ` [PATCH v9 02/11] trailer: process trailers from stdin and arguments Christian Couder
2014-04-01 19:20 ` [PATCH v9 03/11] trailer: read and process config information Christian Couder
2014-04-01 19:20 ` [PATCH v9 04/11] trailer: process command line trailer arguments Christian Couder
2014-04-01 19:20 ` [PATCH v9 05/11] trailer: parse trailers from stdin Christian Couder
2014-04-01 19:20 ` [PATCH v9 06/11] trailer: put all the processing together and print Christian Couder
2014-04-01 19:20 ` [PATCH v9 07/11] trailer: add interpret-trailers command Christian Couder
2014-04-01 19:20 ` [PATCH v9 08/11] trailer: add tests for "git interpret-trailers" Christian Couder
2014-04-01 22:51 ` Junio C Hamano
2014-04-01 22:54 ` Junio C Hamano
2014-04-02 6:02 ` Christian Couder
2014-04-01 19:20 ` [PATCH v9 09/11] trailer: execute command from 'trailer.<name>.command' Christian Couder
2014-04-01 19:20 ` [PATCH v9 10/11] trailer: add tests for commands in config file Christian Couder
2014-04-01 19:20 ` [PATCH v9 11/11] Documentation: add documentation for 'git interpret-trailers' Christian Couder
2014-04-02 0:39 ` Jonathan Nieder
2014-04-02 6:01 ` Christian Couder
2014-04-04 22:33 ` Junio C Hamano
2014-04-04 22:42 ` Junio C Hamano
2014-04-07 9:39 ` Christian Couder
2014-04-07 16:52 ` Junio C Hamano [this message]
2014-04-07 18:58 ` Christian Couder
2014-04-07 19:34 ` Junio C Hamano
2014-04-07 22:00 ` Junio C Hamano
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=xmqq4n25nkt0.fsf@gitster.dls.corp.google.com \
--to=gitster@pobox$(echo .)com \
--cc=chriscool@tuxfamily$(echo .)org \
--cc=christian.couder@gmail$(echo .)com \
--cc=git@vger$(echo .)kernel.org \
--cc=josh@joshtriplett$(echo .)org \
--cc=jrnieder@gmail$(echo .)com \
--cc=ramsay@ramsay1$(echo .)demon.co.uk \
--cc=sunshine@sunshineco$(echo .)com \
/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