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 <sunshine@sunshineco.com> Helped-by: Junio C Hamano <gitster@pobox.com> Helped-by: Emma Jane Hogbin Westby <emma.westby@gmail.com> Signed-off-by: Sébastien Guimmara <sebastien.guimmara@gmail.com> Reviewed-by: Eric Sunshine <sunshine@sunshineco.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Sébastien Guimmara committed
May 21, 2015 at 19:39 UTC
413f50b901f5f5addd7404516cdd3e8ee8a4ac25
2 files changed
+33
-21
Documentation/howto/new-command.txt
+3
-1
@@ -95,7 +95,9 @@ your language, document it in the INSTALL file.
95
that categorizes commands by type, so they can be listed in appropriate
96
subsections in the documentation's summary command list. Add an entry
97
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].
101
102
7. Give the maintainer one paragraph to include in the RelNotes file
103
to describe the new feature; a good place to do so is in the cover
command-list.txt
+30
-20
@@ -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
+
11
### command list (do not change this line)
12
# command name category [deprecated] [common]
13
git-add mainporcelain common
@@ -6,24 +16,24 @@ git-annotate ancillaryinterrogators
16
git-apply plumbingmanipulators
17
git-archimport foreignscminterface
18
git-archive mainporcelain
9
-git-bisect mainporcelain common
19
+git-bisect mainporcelain common info
20
git-blame ancillaryinterrogators
11
-git-branch mainporcelain common
21
+git-branch mainporcelain common history
22
git-bundle mainporcelain
23
git-cat-file plumbinginterrogators
24
git-check-attr purehelpers
25
git-check-ignore purehelpers
26
git-check-mailmap purehelpers
17
-git-checkout mainporcelain common
27
+git-checkout mainporcelain common history
28
git-checkout-index plumbingmanipulators
29
git-check-ref-format purehelpers
30
git-cherry ancillaryinterrogators
31
git-cherry-pick mainporcelain
32
git-citool mainporcelain
33
git-clean mainporcelain
24
-git-clone mainporcelain common
34
+git-clone mainporcelain common init
35
git-column purehelpers
26
-git-commit mainporcelain common
36
+git-commit mainporcelain common history
37
git-commit-tree plumbingmanipulators
38
git-config ancillarymanipulators
39
git-count-objects ancillaryinterrogators
@@ -35,14 +45,14 @@ git-cvsimport foreignscminterface
45
git-cvsserver foreignscminterface
46
git-daemon synchingrepositories
47
git-describe mainporcelain
38
-git-diff mainporcelain common
48
+git-diff mainporcelain common history
49
git-diff-files plumbinginterrogators
50
git-diff-index plumbinginterrogators
51
git-diff-tree plumbinginterrogators
52
git-difftool ancillaryinterrogators
53
git-fast-export ancillarymanipulators
54
git-fast-import ancillarymanipulators
45
-git-fetch mainporcelain common
55
+git-fetch mainporcelain common remote
56
git-fetch-pack synchingrepositories
57
git-filter-branch ancillarymanipulators
58
git-fmt-merge-msg purehelpers
@@ -51,7 +61,7 @@ git-format-patch mainporcelain
61
git-fsck ancillaryinterrogators
62
git-gc mainporcelain
63
git-get-tar-commit-id ancillaryinterrogators
54
-git-grep mainporcelain common
64
+git-grep mainporcelain common info
65
git-gui mainporcelain
66
git-hash-object plumbingmanipulators
67
git-help ancillaryinterrogators
@@ -60,17 +70,17 @@ git-http-fetch synchelpers
70
git-http-push synchelpers
71
git-imap-send foreignscminterface
72
git-index-pack plumbingmanipulators
63
-git-init mainporcelain common
73
+git-init mainporcelain common init
74
git-instaweb ancillaryinterrogators
75
git-interpret-trailers purehelpers
76
gitk mainporcelain
67
-git-log mainporcelain common
77
+git-log mainporcelain common info
78
git-ls-files plumbinginterrogators
79
git-ls-remote plumbinginterrogators
80
git-ls-tree plumbinginterrogators
81
git-mailinfo purehelpers
82
git-mailsplit purehelpers
73
-git-merge mainporcelain common
83
+git-merge mainporcelain common history
84
git-merge-base plumbinginterrogators
85
git-merge-file plumbingmanipulators
86
git-merge-index plumbingmanipulators
@@ -79,7 +89,7 @@ git-mergetool ancillarymanipulators
89
git-merge-tree ancillaryinterrogators
90
git-mktag plumbingmanipulators
91
git-mktree plumbingmanipulators
82
-git-mv mainporcelain common
92
+git-mv mainporcelain common worktree
93
git-name-rev plumbinginterrogators
94
git-notes mainporcelain
95
git-p4 foreignscminterface
@@ -90,11 +100,11 @@ git-parse-remote synchelpers
100
git-patch-id purehelpers
101
git-prune ancillarymanipulators
102
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
105
git-quiltimport foreignscminterface
106
git-read-tree plumbingmanipulators
97
-git-rebase mainporcelain common
107
+git-rebase mainporcelain common history
108
git-receive-pack synchelpers
109
git-reflog ancillarymanipulators
110
git-relink ancillarymanipulators
@@ -103,28 +113,28 @@ git-repack ancillarymanipulators
113
git-replace ancillarymanipulators
114
git-request-pull foreignscminterface
115
git-rerere ancillaryinterrogators
106
-git-reset mainporcelain common
116
+git-reset mainporcelain common worktree
117
git-revert mainporcelain
118
git-rev-list plumbinginterrogators
119
git-rev-parse ancillaryinterrogators
110
-git-rm mainporcelain common
120
+git-rm mainporcelain common worktree
121
git-send-email foreignscminterface
122
git-send-pack synchingrepositories
123
git-shell synchelpers
124
git-shortlog mainporcelain
115
-git-show mainporcelain common
125
+git-show mainporcelain common info
126
git-show-branch ancillaryinterrogators
127
git-show-index plumbinginterrogators
128
git-show-ref plumbinginterrogators
129
git-sh-i18n purehelpers
130
git-sh-setup purehelpers
131
git-stash mainporcelain
122
-git-status mainporcelain common
132
+git-status mainporcelain common info
133
git-stripspace purehelpers
134
git-submodule mainporcelain
135
git-svn foreignscminterface
136
git-symbolic-ref plumbingmanipulators
127
-git-tag mainporcelain common
137
+git-tag mainporcelain common history
138
git-unpack-file plumbinginterrogators
139
git-unpack-objects plumbingmanipulators
140
git-update-index plumbingmanipulators