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

[PATCH v3 15/16] help: move git-diff and git-reset to different groups

From
Nguyễn Thái Ngọc Duy <pclouds@gmail.com>
Date
Apr 25, 2019, 09:45 UTC
Message-ID
<20190425094600.15673-16-pclouds@gmail.com>
In-Reply-To
<20190425094600.15673-1-pclouds@gmail.com>

The third column in command-list.txt determines what group a common command is printed in 'git help'.

"git reset" is currently in the "work on the current change (see also: git help everyday)" group. While it's true that "git reset" can manipulate the index and can be in this group, its unique functionality is resetting HEAD, which should be the "grow, mark, tweak history" group.

Moving it there will also avoid the confusion because both 'restore' and 'reset' are in the same group, next to each other.

While looking at the 'group, mark, tweak history', I realize "git diff" should not be there. All the commands in this group is about _changing_ the commit history while "git diff" is a read-only operation. It fits better in the "examine the history and state" group (especially when "git status", its close friend, is already there).

This is what we have after the reorganization:
    work on the current change (see also: git help everyday)
       add       Add file contents to the index
       mv        Move or rename a file, a directory, or a symlink
       restore   Restore working tree files
       rm        Remove files from the working tree and from the index
    examine the history and state (see also: git help revisions)
       bisect    Use binary search to find the commit that introduced a bug
       diff      Show changes between commits, commit and working tree, etc
       grep      Print lines matching a pattern
       log       Show commit logs
       show      Show various types of objects
       status    Show the working tree status
    grow, mark and tweak your common history
       branch    List, create, or delete branches
       commit    Record changes to the repository
       merge     Join two or more development histories together
       rebase    Reapply commits on top of another base tip
       reset     Reset current HEAD to the specified state
       switch    Switch branches
       tag       Create, list, delete or verify a tag object signed with GPG
Signed-off-by: Nguyễn Thái Ngọc Duy <pclouds@gmail.com>
---
 command-list.txt | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/command-list.txt b/command-list.txt
index cf8dccb439..a9ac72bef4 100644
--- a/command-list.txt
+++ b/command-list.txt
@@ -81,7 +81,7 @@ git-cvsimport                           foreignscminterface
 git-cvsserver                           foreignscminterface
 git-daemon                              synchingrepositories
 git-describe                            mainporcelain
-git-diff                                mainporcelain           history
+git-diff                                mainporcelain           info
 git-diff-files                          plumbinginterrogators
 git-diff-index                          plumbinginterrogators
 git-diff-tree                           plumbinginterrogators
@@ -150,7 +150,7 @@ git-repack                              ancillarymanipulators           complete
 git-replace                             ancillarymanipulators           complete
 git-request-pull                        foreignscminterface             complete
 git-rerere                              ancillaryinterrogators
-git-reset                               mainporcelain           worktree
+git-reset                               mainporcelain           history
 git-restore                             mainporcelain           worktree
 git-revert                              mainporcelain
 git-rev-list                            plumbinginterrogators
-- 
2.21.0.854.ge34a79f761
Previous: Nguyễn Thái Ngọc DuyNext: Nguyễn Thái Ngọc Duy
Message 91 of 97 in “And new command "restore"”
  1. 00/11 And new command "restore"Nguyễn Thái Ngọc Duy, Mar 8, 2019
  2. 01/11 checkout: split part of it to new command 'restore'Nguyễn Thái Ngọc Duy, Mar 8, 2019
  3. Elijah NewrenMar 8, 2019
  4. Duy NguyenMar 9, 2019
  5. Elijah NewrenMar 9, 2019
  6. Duy NguyenApr 9, 2019
  7. Duy NguyenMar 25, 2019
  8. Elijah NewrenMar 25, 2019
  9. Johannes SchindelinMar 13, 2019
  10. 02/11 restore: take tree-ish from --source option insteadNguyễn Thái Ngọc Duy, Mar 8, 2019
  11. Elijah NewrenMar 9, 2019
  12. Eric SunshineMar 10, 2019
  13. 03/11 restore: make pathspec mandatoryNguyễn Thái Ngọc Duy, Mar 8, 2019
  14. Elijah NewrenMar 9, 2019
  15. 04/11 restore: disable overlay mode by defaultNguyễn Thái Ngọc Duy, Mar 8, 2019
  16. Elijah NewrenMar 9, 2019
  17. 05/11 checkout: factor out worktree checkout codeNguyễn Thái Ngọc Duy, Mar 8, 2019
  18. 06/11 restore: add --worktree and --indexNguyễn Thái Ngọc Duy, Mar 8, 2019
  19. Elijah NewrenMar 9, 2019
  20. Eric SunshineMar 10, 2019
  21. Duy NguyenMar 13, 2019
  22. Junio C HamanoMar 13, 2019
  23. 07/11 restore: default to --source=HEAD when only --index is specifiedNguyễn Thái Ngọc Duy, Mar 8, 2019
  24. Elijah NewrenMar 9, 2019
  25. 08/11 restore: support --patchNguyễn Thái Ngọc Duy, Mar 8, 2019
  26. Elijah NewrenMar 9, 2019
  27. 09/11 t: add tests for restoreNguyễn Thái Ngọc Duy, Mar 8, 2019
  28. Andrei RybakMar 9, 2019
  29. Johannes SchindelinMar 13, 2019
  30. Duy NguyenMar 13, 2019
  31. Johannes SchindelinMar 13, 2019
  32. Duy NguyenMar 14, 2019
  33. Junio C HamanoMar 14, 2019
  34. Junio C HamanoMar 14, 2019
  35. 10/11 completion: support restoreNguyễn Thái Ngọc Duy, Mar 8, 2019
  36. Elijah NewrenMar 9, 2019
  37. Duy NguyenMar 11, 2019
  38. Duy NguyenMar 11, 2019
  39. Elijah NewrenMar 11, 2019
  40. 11/11 doc: promote "git restore"Nguyễn Thái Ngọc Duy, Mar 8, 2019
  41. Elijah NewrenMar 9, 2019
  42. Randall S. BeckerMar 11, 2019
  43. Duy NguyenMar 11, 2019
  44. Junio C HamanoMar 13, 2019
  45. Duy NguyenApr 11, 2019
  46. Duy NguyenMar 10, 2019
  47. Jacob KellerMar 10, 2019
  48. Elijah NewrenMar 11, 2019
  49. Junio C HamanoMar 13, 2019
  50. Duy NguyenMar 14, 2019
  51. 00/16 Add new command 'restore'Nguyễn Thái Ngọc Duy, Apr 11, 2019
  52. 01/16 checkout: split part of it to new command 'restore'Nguyễn Thái Ngọc Duy, Apr 11, 2019
  53. 02/16 restore: take tree-ish from --source option insteadNguyễn Thái Ngọc Duy, Apr 11, 2019
  54. 03/16 restore: make pathspec mandatoryNguyễn Thái Ngọc Duy, Apr 11, 2019
  55. 04/16 restore: disable overlay mode by defaultNguyễn Thái Ngọc Duy, Apr 11, 2019
  56. 05/16 checkout: factor out worktree checkout codeNguyễn Thái Ngọc Duy, Apr 11, 2019
  57. 06/16 restore: add --worktree and --stagedNguyễn Thái Ngọc Duy, Apr 11, 2019
  58. 07/16 restore: reject invalid combinations with --stagedNguyễn Thái Ngọc Duy, Apr 11, 2019
  59. 08/16 restore: default to --source=HEAD when only --staged is specifiedNguyễn Thái Ngọc Duy, Apr 11, 2019
  60. 09/16 restore: replace --force with --ignore-unmergedNguyễn Thái Ngọc Duy, Apr 11, 2019
  61. 10/16 restore: support --patchNguyễn Thái Ngọc Duy, Apr 11, 2019
  62. 11/16 t: add tests for restoreNguyễn Thái Ngọc Duy, Apr 11, 2019
  63. 12/16 completion: support restoreNguyễn Thái Ngọc Duy, Apr 11, 2019
  64. 13/16 user-manual.txt: prefer 'merge --abort' over 'reset --hard'Nguyễn Thái Ngọc Duy, Apr 11, 2019
  65. 14/16 doc: promote "git restore"Nguyễn Thái Ngọc Duy, Apr 11, 2019
  66. 15/16 rm: add --staged as alias for --cachedNguyễn Thái Ngọc Duy, Apr 11, 2019
  67. 16/16 help: move git-diff and git-reset to different groupsNguyễn Thái Ngọc Duy, Apr 11, 2019
  68. Junio C HamanoApr 12, 2019
  69. Duy NguyenApr 13, 2019
  70. Duy NguyenApr 17, 2019
  71. Junio C HamanoApr 18, 2019
  72. Duy NguyenApr 18, 2019
  73. Johannes SchindelinApr 18, 2019
  74. Duy NguyenApr 18, 2019
  75. 00/16 Add new command 'restore'Nguyễn Thái Ngọc Duy, Apr 25, 2019
  76. 01/16 checkout: split part of it to new command 'restore'Nguyễn Thái Ngọc Duy, Apr 25, 2019
  77. 02/16 restore: take tree-ish from --source option insteadNguyễn Thái Ngọc Duy, Apr 25, 2019
  78. 03/16 restore: make pathspec mandatoryNguyễn Thái Ngọc Duy, Apr 25, 2019
  79. 04/16 restore: disable overlay mode by defaultNguyễn Thái Ngọc Duy, Apr 25, 2019
  80. 05/16 checkout: factor out worktree checkout codeNguyễn Thái Ngọc Duy, Apr 25, 2019
  81. 06/16 restore: add --worktree and --stagedNguyễn Thái Ngọc Duy, Apr 25, 2019
  82. 07/16 restore: reject invalid combinations with --stagedNguyễn Thái Ngọc Duy, Apr 25, 2019
  83. 08/16 restore: default to --source=HEAD when only --staged is specifiedNguyễn Thái Ngọc Duy, Apr 25, 2019
  84. 09/16 restore: replace --force with --ignore-unmergedNguyễn Thái Ngọc Duy, Apr 25, 2019
  85. 10/16 restore: support --patchNguyễn Thái Ngọc Duy, Apr 25, 2019
  86. 11/16 t: add tests for restoreNguyễn Thái Ngọc Duy, Apr 25, 2019
  87. SZEDER GáborJun 13, 2019
  88. 12/16 completion: support restoreNguyễn Thái Ngọc Duy, Apr 25, 2019
  89. 13/16 user-manual.txt: prefer 'merge --abort' over 'reset --hard'Nguyễn Thái Ngọc Duy, Apr 25, 2019
  90. 14/16 doc: promote "git restore"Nguyễn Thái Ngọc Duy, Apr 25, 2019
  91. 15/16 help: move git-diff and git-reset to different groupsNguyễn Thái Ngọc Duy, Apr 25, 2019
  92. 16/16 Declare both git-switch and git-restore experimentalNguyễn Thái Ngọc Duy, Apr 25, 2019
  93. Emily ShafferMay 7, 2019
  94. Junio C HamanoMay 7, 2019
  95. Duy NguyenMay 7, 2019
  96. Emily ShafferMay 7, 2019
  97. Duy NguyenMay 8, 2019

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.