git/list[1] front-page[2] threads[3] people[4] search[5] about
 

Re: [PATCH 1/3] command-list.txt: group common commands by theme

From
Sébastien Guimmara <sebastien.guimmara@gmail.com>
Date
May 8, 2015, 18:43 UTC
Message-ID
<554D03C9.9030406@gmail.com>
In-Reply-To
<CAPig+cQ2e4c5hYsRbZhgyvLcMPsqshqRUZGNLwhJd57YP9JEFA@mail.gmail.com>
On 05/07/2015 06:50 PM, Eric Sunshine wrote:
Show 26 quoted lines
> On Wed, May 6, 2015 at 4:58 PM, Sébastien Guimmara
> <sebastien.guimmara@gmail.com> wrote:
>> 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:
>>>> 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 ?
>
> I'm not sure to what you are referring here? (Perhaps my comment was
> unclear, or perhaps I'm misreading your response.)
>

I was mistaken, I thought you wanted to reorder the commands alphabetically, which was unnecessary since they were sorted in help.c anyway. But yes, I shall add a comment in command-list.txt

Show 37 quoted lines
> I meant only that the comment above [groups] should say that the order
> of the items in [groups] is the order in which the groups themselves
> are output by "git help".
>
>>>> +[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).
>
> I also think "collaborating" itself is best, but changed it at the
> last second before sending the email.
>
>>>> -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.
>
> Strange. In my editor, all columns are already aligned. Perhaps your
> tab with setting is incorrect? (It should be set to 8.)
>

Actually I only removed the few tabs that were wandering in some lines to replace them by spaces (almost all lines were space aligned, only a few were tab aligned).

Show 34 quoted lines
>>>> -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.
>
> I personally consider "grep" an important beginner command, but that's
> an issue to be argued separately; and it's also why it's a good idea
> to put the removals in their own patch, so people can argue about it
> without holding up the rest of the patches.
>
>>>>    [...]
>>>> -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.
>
> Historically, many Unix tools incorrectly handled files lacking that
> final newline; sometimes by dropping the line altogether, sometimes
> mis-processing it in some way or another. Misbehaviors still exist
> today, often in BSD tools. In fact, just a few days ago, such a
> problem was reported for git-filter-branch[1]. Consequently, retaining
> newline is good insurance against misbehaving tools.
>
> [1]: http://thread.gmane.org/gmane.comp.version-control.git/267828/focus=267957
>
Previous: Johannes SchindelinNext: Eric Sunshine
Message 10 of 38 in “git help: group common commands by theme”
  1. 0/3 git help: group common commands by themeSébastien Guimmara, May 4, 2015
  2. 1/3 command-list.txt: group common commands by themeSébastien Guimmara, May 4, 2015
  3. Eric SunshineMay 6, 2015
  4. Sébastien GuimmaraMay 6, 2015
  5. Eric SunshineMay 7, 2015
  6. Johannes SixtMay 7, 2015
  7. Johannes SchindelinMay 8, 2015
  8. Andreas SchwabMay 8, 2015
  9. Johannes SchindelinMay 8, 2015
  10. Sébastien GuimmaraMay 8, 2015
  11. Eric SunshineMay 8, 2015
  12. 2/3 generate-cmdlist.sh: parse common group commandsSébastien Guimmara, May 4, 2015
  13. Eric SunshineMay 8, 2015
  14. Eric SunshineMay 8, 2015
  15. Sébastien GuimmaraMay 8, 2015
  16. 3/3 git help: group common commands by themeSébastien Guimmara, May 4, 2015
  17. Eric SunshineMay 6, 2015
  18. Sébastien GuimmaraMay 6, 2015
  19. Sébastien GuimmaraMay 8, 2015
  20. Stefan BellerMay 8, 2015
  21. Eric SunshineMay 8, 2015
  22. Sébastien GuimmaraMay 8, 2015
  23. Eric SunshineMay 6, 2015
  24. Sébastien GuimmaraMay 6, 2015
  25. Eric SunshineMay 6, 2015
  26. Junio C HamanoMay 6, 2015
  27. Sébastien GuimmaraMay 8, 2015
  28. Junio C HamanoMay 8, 2015
  29. Matthieu MoyMay 6, 2015
  30. Junio C HamanoMay 6, 2015
  31. Matthieu MoyMay 7, 2015
  32. Junio C HamanoMay 7, 2015
  33. Matthieu MoyMay 8, 2015
  34. Junio C HamanoMay 8, 2015
  35. Emma Jane Hogbin WestbyMay 7, 2015
  36. Sébastien GuimmaraMay 8, 2015
  37. Junio C HamanoMay 8, 2015
  38. Sébastien GuimmaraMay 8, 2015

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.