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

Re: [PATCH 0/3] git help: group common commands by theme

From
Eric Sunshine <sunshine@sunshineco.com>
Date
May 6, 2015, 03:08 UTC
Message-ID
<CAPig+cT9X-nXhQyjDtzLzm-A2LWLaCDThR9_xh=G049SqKHccw@mail.gmail.com>
In-Reply-To
<cover.1430770308.git.sebastien.guimmara@gmail.com>

On Mon, May 4, 2015 at 4:28 PM, Sébastien Guimmara <sebastien.guimmara@gmail.com> wrote:

Show 25 quoted lines
> This v4 includes the following suggestions:
>
> In command-list.txt:
> - Add a [groups] block containing names and description for groups:
>
>    [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
>
> - Add a [commands] header on top of the known command list, and
>   group names as a third column.
>
>    [commands]
>    git-add            mainporcelain                common-worktree
>    git-am             mainporcelain
>    git-annotate       ancillaryinterrogators
>    git-apply          plumbingmanipulators
>    git-archimport     foreignscminterface
>    git-archive        mainporcelain
>    git-bisect         mainporcelain
>    git-blame          ancillaryinterrogators
>    git-branch         mainporcelain                common-history

Thanks, this version is looking better. I, personally, still find the redundant "command-" prefix ugly and would just as soon see it go away. I'll make some suggestions about that when reviewing patch 2/3.

More below.
Show 33 quoted lines
> This produces the following output of $ git help:
>
> [...]
> The most commonly used git commands are:
>
>    * starting a working area:
>       clone      Clone a repository into a new directory
>       init       Create an empty Git repository or reinitialize [...]
>
>    * working on the current change:
>       add        Add file contents to the index
>       reset      Reset current HEAD to the specified state
>
>    * working with others:
>       fetch      Download objects and refs from another repository
>       pull       Fetch from and integrate with another repository [...]
>       push       Update remote refs along with associated objects
>
>    * examining the history and state:
>       log        Show commit logs
>       status     Show the working tree status
>
>    * growing, marking and tweaking your history:
>       branch     List, create, or delete branches
>       checkout   Checkout a branch or paths to the working tree
>       commit     Record changes to the repository
>       diff       Show changes between commits, commit and working [...]
>       merge      Join two or more development histories together
> [...]
>
> I removed from the list of common commands: rebase, rm, mv, bisect
> because [1] they are not really common to an unfamiliar user, [2] to
> save vertical space occupied by group headers.

Please perform the removals in a separate (preparatory) patch. Not only is it difficult to spot the removals mixed in with the primary changes of 1/3, but they are not even mentioned in the commit message of that patch. More generally, the removals are a logically distinct change from assigning groupings to the common commands, thus deserve their own patch.

Previous: Sébastien GuimmaraNext: Sébastien Guimmara
Message 23 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.