From: "Sébastien Guimmara" <sebastien.guimmara@gmail.com>
To: Eric Sunshine <sunshine@sunshineco.com>
Cc: "Git List" <git@vger.kernel.org>,
"Junio C Hamano" <gitster@pobox.com>,
"Sébastien Guimmara" <sebastien.guimmara@gmail.com>
Subject: Re: [PATCH 1/3] command-list.txt: group common commands by theme
Date: Wed, 06 May 2015 22:58:44 +0200 [thread overview]
Message-ID: <554A8084.10506@gmail.com> (raw)
In-Reply-To: <CAPig+cTHQikgOvPrjxikUNjQoWCv2hdubJ55OG0SqpGUs_3Pow@mail.gmail.com>
On 05/06/2015 08:57 AM, Eric Sunshine wrote:
> On Mon, May 4, 2015 at 4:28 PM, Sébastien Guimmara
> <sebastien.guimmara@gmail.com> wrote:
>> Declare groups for common commands in the [groups] block,
>> followed by group names and descriptions:
>>
>> [groups]
>> init starting a working area
>> worktree working on the current change
>> remote working with others
>> info examining the history and state
>> history growing, marking and tweaking your history
>>
>> Then, in the [commands] block, map all common commands with a group:
>>
>> [commands]
>> git-add mainporcelain common-worktree
>> git-branch mainporcelain common-history
>> git-checkout mainporcelain common-history
>> [...]
>>
>> command names and groups are then parsed with generate-cmdlist.sh to
>> generate common-commands.h.
>>
>> Those commands are displayed in groups in the output of 'git help'.
>
> It probably also is important to mention that the order of the items
> in [groups] is the order in which groups are output by 'git help'
Yes. I'll add a comment in the file as well as in the commit.
>
> More below.
>
>> Signed-off-by: Sébastien Guimmara <sebastien.guimmara@gmail.com>
>> ---
>> diff --git a/command-list.txt b/command-list.txt
>> index f1eae08..64394ca 100644
>> --- a/command-list.txt
>> +++ b/command-list.txt
>> @@ -1,29 +1,39 @@
>> # List of known git commands.
>> -# command name category [deprecated] [common]
>> -git-add mainporcelain common
>> +# only add group information for common commands
>
> Perhaps mention also that the order of groups here is the order in
> which they are output by 'git help'?
It wouldn't be necessary if we reorder alphabetically the content of
each group, no ?
>
>> +[groups]
>
> Thinking on this a bit more, perhaps [groups] is too generic. Maybe
> [common] or [commongroups] would be more descriptive?
>
>> +init starting a working area
>> +worktree working on the current change
>> +remote working with others
>
> "collaborating with others" perhaps?
Yes, "groups" has been itching a bit. I thought about "theme", but
common just does the job too. "collaborating with others" sounds
redundant to me (but I'm being a grammar nazi here).
>> -git-fast-export ancillarymanipulators
>> -git-fast-import ancillarymanipulators
>> -git-fetch mainporcelain common
>> +git-fast-export ancillarymanipulators
>> +git-fast-import ancillarymanipulators
>
> Unintended whitespace changes for fast-export and fast-import lines? I
> wouldn't have expected to see these lines change in this patch.
>
All whitespace changes were intended to align the commands on the same
column. I realize this should be the object of a separate patch.
>> -git-grep mainporcelain common
>> +git-grep mainporcelain
>
> This change isn't mentioned anywhere, not even in the cover letter.
> Did you intend to drop 'grep' from the common command list?
It's a mistake in the cover letter. I indeed intended to propose to
remove grep and tag from the common commands.
>> [...]
>> -git-write-tree plumbingmanipulators
>> +git-write-tree plumbingmanipulators
>> \ No newline at end of file
>
> Your editor is perhaps dropping the final newline in the file? This is
> an undesirable change. Patch 2/3 exhibits the same problem.
As for the final newline, it was deliberately removed. I was not aware it
was necessary in text files. I'll correct this.
Thank you for the help,
Sébastien
next prev parent reply other threads:[~2015-05-06 20:58 UTC|newest]
Thread overview: 38+ messages / expand[flat|nested] mbox.gz Atom feed top
2015-05-04 20:28 [PATCH 0/3] git help: group common commands by theme Sébastien Guimmara
2015-05-04 20:28 ` [PATCH 1/3] command-list.txt: " Sébastien Guimmara
2015-05-06 6:57 ` Eric Sunshine
2015-05-06 20:58 ` Sébastien Guimmara [this message]
2015-05-07 16:50 ` Eric Sunshine
2015-05-07 19:23 ` Johannes Sixt
2015-05-08 10:11 ` Johannes Schindelin
2015-05-08 12:01 ` Andreas Schwab
2015-05-08 13:02 ` Johannes Schindelin
2015-05-08 18:43 ` Sébastien Guimmara
2015-05-08 19:00 ` Eric Sunshine
2015-05-04 20:28 ` [PATCH 2/3] generate-cmdlist.sh: parse common group commands Sébastien Guimmara
2015-05-08 3:20 ` Eric Sunshine
2015-05-08 3:39 ` Eric Sunshine
2015-05-08 20:55 ` Sébastien Guimmara
2015-05-04 20:28 ` [PATCH 3/3] git help: group common commands by theme Sébastien Guimmara
2015-05-06 3:16 ` Eric Sunshine
2015-05-06 20:31 ` Sébastien Guimmara
2015-05-08 21:08 ` Sébastien Guimmara
2015-05-08 21:17 ` Stefan Beller
2015-05-08 21:19 ` Eric Sunshine
2015-05-08 21:20 ` Sébastien Guimmara
2015-05-06 3:08 ` [PATCH 0/3] " Eric Sunshine
2015-05-06 20:26 ` Sébastien Guimmara
2015-05-06 20:49 ` Eric Sunshine
2015-05-06 3:41 ` Junio C Hamano
2015-05-08 18:00 ` Sébastien Guimmara
2015-05-08 18:53 ` Junio C Hamano
2015-05-06 7:59 ` Matthieu Moy
2015-05-06 17:42 ` Junio C Hamano
2015-05-07 8:42 ` Matthieu Moy
2015-05-07 18:44 ` Junio C Hamano
2015-05-08 8:18 ` Matthieu Moy
2015-05-08 16:19 ` Junio C Hamano
2015-05-07 9:31 ` Emma Jane Hogbin Westby
2015-05-08 18:21 ` Sébastien Guimmara
2015-05-08 18:58 ` Junio C Hamano
2015-05-08 20:08 ` 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=554A8084.10506@gmail.com \
--to=sebastien.guimmara@gmail.com \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=sunshine@sunshineco.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.