public inbox for git@vger.kernel.org 
 help / color / mirror / Atom feed

From: Junio C Hamano <gitster@pobox•com>
To: "Sébastien Guimmara" <sebastien.guimmara@gmail•com>
Cc: git@vger•kernel.org
Subject: Re: [PATCH v7 1/5] command-list.txt: prepare with [commands] header
Date: Fri, 15 May 2015 13:44:05 -0700	[thread overview]
Message-ID: <xmqqmw15fu5m.fsf@gitster.dls.corp.google.com> (raw)
In-Reply-To: <5556582C.3010409@gmail.com> ("Sébastien Guimmara"'s message of "Fri, 15 May 2015 22:33:48 +0200")

Sébastien Guimmara  <sebastien.guimmara@gmail•com> writes:

>> This is largely just a "taste" thing, but with all these backslashes
>> in the supporting infrastructure you had to add in Makefiles and
>> scripts, don't you think the choice of the way you designed the
>> format to use '[commands]' was a rather poor one?  After all, all
>> you need is a clear separator line for a block of commands and
>> another block of groups, and there wasn't a reason why you needed to
>> use square brackets for that, and the sed scripts are suffering from
>> that poor choice.
>>
>> You could for example have used the existing "# List of known git
>> commands" as such a signal to tell that all the no comment lines
>> below are commands.
>
> I tend to think that relying on comments as marks for parsers is brittle,
> but indeed square brackets get in the way of sed regexes. I'll think of
> something better. Thanks.

Heh, we, and more importantly our users, already rely on a marker in
comments when writing their commit log messages ;-)

I would not be opposed to a new header that is outside comment, but
I do not think the marker line that is also a comment is "brittle"
and would not be opposed to that, either.

    # do not molest the next line
    ### command list
    # name category
    git-add mainporcelain
    ...

would be perfectly acceptable.

I was just pointing out that you did not even have to have patch
1/5.

Thanks.

next prev parent reply	other threads:[~2015-05-15 20:44 UTC|newest]

Thread overview: 23+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2015-05-15 18:34 [PATCH v7 0/5] git help: group common commands by theme Sébastien Guimmara
2015-05-15 18:35 ` [PATCH v7 1/5] command-list.txt: prepare with [commands] header Sébastien Guimmara
2015-05-15 20:26   ` Junio C Hamano
2015-05-15 20:33     ` Sébastien Guimmara
2015-05-15 20:44       ` Junio C Hamano [this message]
2015-05-15 20:52         ` Eric Sunshine
2015-05-15 22:26           ` Junio C Hamano
2015-05-15 23:55             ` Eric Sunshine
2015-05-18 16:25               ` Sébastien Guimmara
2015-05-15 21:15   ` Eric Sunshine
2015-05-16  9:44   ` Philip Oakley
2015-05-16  9:44     ` Sébastien Guimmara
2015-05-15 18:35 ` [PATCH v7 2/5] command-list.txt: add a [common] block Sébastien Guimmara
2015-05-15 21:31   ` Eric Sunshine
2015-05-15 18:35 ` [PATCH v7 3/5] generate-cmdlist: parse common group commands Sébastien Guimmara
2015-05-15 21:34   ` Eric Sunshine
2015-05-15 18:35 ` [PATCH v7 4/5] command-list.txt: drop the common tag Sébastien Guimmara
2015-05-15 21:41   ` Eric Sunshine
2015-05-15 18:35 ` [PATCH v7 5/5] help.c: output the typical Git workflow Sébastien Guimmara
2015-05-15 21:45   ` Eric Sunshine
2015-05-15 20:41 ` [PATCH v7 0/5] git help: group common commands by theme Eric Sunshine
2015-05-15 20:48   ` Junio C Hamano
2015-05-15 20:50     ` Sébastien Guimmara

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=xmqqmw15fu5m.fsf@gitster.dls.corp.google.com \
    --to=gitster@pobox$(echo .)com \
    --cc=git@vger$(echo .)kernel.org \
    --cc=sebastien.guimmara@gmail$(echo .)com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox