Skip to content

Commit 413f50b

Browse files
Sébastien Guimmaragitster
authored andcommitted
command-list.txt: add the common groups block
The ultimate goal is for "git help" to display common commands in groups rather than alphabetically. As a first step, define the groups in a new block, and then assign a group to each common command. Add a block at the beginning of command-list.txt: init start a working area (see also: git help tutorial) worktree work on the current change (see also:[...] info examine the history and state (see also: git [...] history grow, mark and tweak your history remote collaborate (see also: git help workflows) storing information about common commands group, then map each common command to a group: git-add mainporcelain common worktree Helped-by: Eric Sunshine <[email protected]> Helped-by: Junio C Hamano <[email protected]> Helped-by: Emma Jane Hogbin Westby <[email protected]> Signed-off-by: Sébastien Guimmara <[email protected]> Reviewed-by: Eric Sunshine <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent 11c6659 commit 413f50b

File tree

2 files changed

+33
-21
lines changed

2 files changed

+33
-21
lines changed

Documentation/howto/new-command.txt

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,9 @@ your language, document it in the INSTALL file.
9595
that categorizes commands by type, so they can be listed in appropriate
9696
subsections in the documentation's summary command list. Add an entry
9797
for yours. To understand the categories, look at git-commands.txt
98-
in the main directory.
98+
in the main directory. If the new command is part of the typical Git
99+
workflow and you believe it common enough to be mentioned in 'git help',
100+
map this command to a common group in the column [common].
99101

100102
7. Give the maintainer one paragraph to include in the RelNotes file
101103
to describe the new feature; a good place to do so is in the cover

command-list.txt

Lines changed: 30 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,13 @@
1+
# common commands are grouped by themes
2+
# these groups are output by 'git help' in the order declared here.
3+
# map each common command in the command list to one of these groups.
4+
### common groups (do not change this line)
5+
init start a working area (see also: git help tutorial)
6+
worktree work on the current change (see also: git help everyday)
7+
info examine the history and state (see also: git help revisions)
8+
history grow, mark and tweak your common history
9+
remote collaborate (see also: git help workflows)
10+
111
### command list (do not change this line)
212
# command name category [deprecated] [common]
313
git-add mainporcelain common
@@ -6,24 +16,24 @@ git-annotate ancillaryinterrogators
616
git-apply plumbingmanipulators
717
git-archimport foreignscminterface
818
git-archive mainporcelain
9-
git-bisect mainporcelain common
19+
git-bisect mainporcelain common info
1020
git-blame ancillaryinterrogators
11-
git-branch mainporcelain common
21+
git-branch mainporcelain common history
1222
git-bundle mainporcelain
1323
git-cat-file plumbinginterrogators
1424
git-check-attr purehelpers
1525
git-check-ignore purehelpers
1626
git-check-mailmap purehelpers
17-
git-checkout mainporcelain common
27+
git-checkout mainporcelain common history
1828
git-checkout-index plumbingmanipulators
1929
git-check-ref-format purehelpers
2030
git-cherry ancillaryinterrogators
2131
git-cherry-pick mainporcelain
2232
git-citool mainporcelain
2333
git-clean mainporcelain
24-
git-clone mainporcelain common
34+
git-clone mainporcelain common init
2535
git-column purehelpers
26-
git-commit mainporcelain common
36+
git-commit mainporcelain common history
2737
git-commit-tree plumbingmanipulators
2838
git-config ancillarymanipulators
2939
git-count-objects ancillaryinterrogators
@@ -35,14 +45,14 @@ git-cvsimport foreignscminterface
3545
git-cvsserver foreignscminterface
3646
git-daemon synchingrepositories
3747
git-describe mainporcelain
38-
git-diff mainporcelain common
48+
git-diff mainporcelain common history
3949
git-diff-files plumbinginterrogators
4050
git-diff-index plumbinginterrogators
4151
git-diff-tree plumbinginterrogators
4252
git-difftool ancillaryinterrogators
4353
git-fast-export ancillarymanipulators
4454
git-fast-import ancillarymanipulators
45-
git-fetch mainporcelain common
55+
git-fetch mainporcelain common remote
4656
git-fetch-pack synchingrepositories
4757
git-filter-branch ancillarymanipulators
4858
git-fmt-merge-msg purehelpers
@@ -51,7 +61,7 @@ git-format-patch mainporcelain
5161
git-fsck ancillaryinterrogators
5262
git-gc mainporcelain
5363
git-get-tar-commit-id ancillaryinterrogators
54-
git-grep mainporcelain common
64+
git-grep mainporcelain common info
5565
git-gui mainporcelain
5666
git-hash-object plumbingmanipulators
5767
git-help ancillaryinterrogators
@@ -60,17 +70,17 @@ git-http-fetch synchelpers
6070
git-http-push synchelpers
6171
git-imap-send foreignscminterface
6272
git-index-pack plumbingmanipulators
63-
git-init mainporcelain common
73+
git-init mainporcelain common init
6474
git-instaweb ancillaryinterrogators
6575
git-interpret-trailers purehelpers
6676
gitk mainporcelain
67-
git-log mainporcelain common
77+
git-log mainporcelain common info
6878
git-ls-files plumbinginterrogators
6979
git-ls-remote plumbinginterrogators
7080
git-ls-tree plumbinginterrogators
7181
git-mailinfo purehelpers
7282
git-mailsplit purehelpers
73-
git-merge mainporcelain common
83+
git-merge mainporcelain common history
7484
git-merge-base plumbinginterrogators
7585
git-merge-file plumbingmanipulators
7686
git-merge-index plumbingmanipulators
@@ -79,7 +89,7 @@ git-mergetool ancillarymanipulators
7989
git-merge-tree ancillaryinterrogators
8090
git-mktag plumbingmanipulators
8191
git-mktree plumbingmanipulators
82-
git-mv mainporcelain common
92+
git-mv mainporcelain common worktree
8393
git-name-rev plumbinginterrogators
8494
git-notes mainporcelain
8595
git-p4 foreignscminterface
@@ -90,11 +100,11 @@ git-parse-remote synchelpers
90100
git-patch-id purehelpers
91101
git-prune ancillarymanipulators
92102
git-prune-packed plumbingmanipulators
93-
git-pull mainporcelain common
94-
git-push mainporcelain common
103+
git-pull mainporcelain common remote
104+
git-push mainporcelain common remote
95105
git-quiltimport foreignscminterface
96106
git-read-tree plumbingmanipulators
97-
git-rebase mainporcelain common
107+
git-rebase mainporcelain common history
98108
git-receive-pack synchelpers
99109
git-reflog ancillarymanipulators
100110
git-relink ancillarymanipulators
@@ -103,28 +113,28 @@ git-repack ancillarymanipulators
103113
git-replace ancillarymanipulators
104114
git-request-pull foreignscminterface
105115
git-rerere ancillaryinterrogators
106-
git-reset mainporcelain common
116+
git-reset mainporcelain common worktree
107117
git-revert mainporcelain
108118
git-rev-list plumbinginterrogators
109119
git-rev-parse ancillaryinterrogators
110-
git-rm mainporcelain common
120+
git-rm mainporcelain common worktree
111121
git-send-email foreignscminterface
112122
git-send-pack synchingrepositories
113123
git-shell synchelpers
114124
git-shortlog mainporcelain
115-
git-show mainporcelain common
125+
git-show mainporcelain common info
116126
git-show-branch ancillaryinterrogators
117127
git-show-index plumbinginterrogators
118128
git-show-ref plumbinginterrogators
119129
git-sh-i18n purehelpers
120130
git-sh-setup purehelpers
121131
git-stash mainporcelain
122-
git-status mainporcelain common
132+
git-status mainporcelain common info
123133
git-stripspace purehelpers
124134
git-submodule mainporcelain
125135
git-svn foreignscminterface
126136
git-symbolic-ref plumbingmanipulators
127-
git-tag mainporcelain common
137+
git-tag mainporcelain common history
128138
git-unpack-file plumbinginterrogators
129139
git-unpack-objects plumbingmanipulators
130140
git-update-index plumbingmanipulators

0 commit comments

Comments
 (0)