mirror of
https://github.com/git/git
synced 2024-08-25 02:35:46 +00:00
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>
This commit is contained in:
Sébastien Guimmara
Junio C Hamano
parent
11c6659d85
commit
413f50b901
|
|
@ -95,7 +95,9 @@ your language, document it in the INSTALL file.
|
||||||
that categorizes commands by type, so they can be listed in appropriate
|
that categorizes commands by type, so they can be listed in appropriate
|
||||||
subsections in the documentation's summary command list. Add an entry
|
subsections in the documentation's summary command list. Add an entry
|
||||||
for yours. To understand the categories, look at git-commands.txt
|
for yours. To understand the categories, look at git-commands.txt
|
||||||
in the main directory.
|
in the main directory. If the new command is part of the typical Git
|
||||||
|
workflow and you believe it common enough to be mentioned in 'git help',
|
||||||
|
map this command to a common group in the column [common].
|
||||||
|
|
||||||
7. Give the maintainer one paragraph to include in the RelNotes file
|
7. Give the maintainer one paragraph to include in the RelNotes file
|
||||||
to describe the new feature; a good place to do so is in the cover
|
to describe the new feature; a good place to do so is in the cover
|
||||||
|
|
|
||||||
|
|
@ -1,3 +1,13 @@
|
||||||
|
# common commands are grouped by themes
|
||||||
|
# these groups are output by 'git help' in the order declared here.
|
||||||
|
# map each common command in the command list to one of these groups.
|
||||||
|
### common groups (do not change this line)
|
||||||
|
init start a working area (see also: git help tutorial)
|
||||||
|
worktree work on the current change (see also: git help everyday)
|
||||||
|
info examine the history and state (see also: git help revisions)
|
||||||
|
history grow, mark and tweak your common history
|
||||||
|
remote collaborate (see also: git help workflows)
|
||||||
|
|
||||||
### command list (do not change this line)
|
### command list (do not change this line)
|
||||||
# command name category [deprecated] [common]
|
# command name category [deprecated] [common]
|
||||||
git-add mainporcelain common
|
git-add mainporcelain common
|
||||||
|
|
@ -6,24 +16,24 @@ git-annotate ancillaryinterrogators
|
||||||
git-apply plumbingmanipulators
|
git-apply plumbingmanipulators
|
||||||
git-archimport foreignscminterface
|
git-archimport foreignscminterface
|
||||||
git-archive mainporcelain
|
git-archive mainporcelain
|
||||||
git-bisect mainporcelain common
|
git-bisect mainporcelain common info
|
||||||
git-blame ancillaryinterrogators
|
git-blame ancillaryinterrogators
|
||||||
git-branch mainporcelain common
|
git-branch mainporcelain common history
|
||||||
git-bundle mainporcelain
|
git-bundle mainporcelain
|
||||||
git-cat-file plumbinginterrogators
|
git-cat-file plumbinginterrogators
|
||||||
git-check-attr purehelpers
|
git-check-attr purehelpers
|
||||||
git-check-ignore purehelpers
|
git-check-ignore purehelpers
|
||||||
git-check-mailmap purehelpers
|
git-check-mailmap purehelpers
|
||||||
git-checkout mainporcelain common
|
git-checkout mainporcelain common history
|
||||||
git-checkout-index plumbingmanipulators
|
git-checkout-index plumbingmanipulators
|
||||||
git-check-ref-format purehelpers
|
git-check-ref-format purehelpers
|
||||||
git-cherry ancillaryinterrogators
|
git-cherry ancillaryinterrogators
|
||||||
git-cherry-pick mainporcelain
|
git-cherry-pick mainporcelain
|
||||||
git-citool mainporcelain
|
git-citool mainporcelain
|
||||||
git-clean mainporcelain
|
git-clean mainporcelain
|
||||||
git-clone mainporcelain common
|
git-clone mainporcelain common init
|
||||||
git-column purehelpers
|
git-column purehelpers
|
||||||
git-commit mainporcelain common
|
git-commit mainporcelain common history
|
||||||
git-commit-tree plumbingmanipulators
|
git-commit-tree plumbingmanipulators
|
||||||
git-config ancillarymanipulators
|
git-config ancillarymanipulators
|
||||||
git-count-objects ancillaryinterrogators
|
git-count-objects ancillaryinterrogators
|
||||||
|
|
@ -35,14 +45,14 @@ git-cvsimport foreignscminterface
|
||||||
git-cvsserver foreignscminterface
|
git-cvsserver foreignscminterface
|
||||||
git-daemon synchingrepositories
|
git-daemon synchingrepositories
|
||||||
git-describe mainporcelain
|
git-describe mainporcelain
|
||||||
git-diff mainporcelain common
|
git-diff mainporcelain common history
|
||||||
git-diff-files plumbinginterrogators
|
git-diff-files plumbinginterrogators
|
||||||
git-diff-index plumbinginterrogators
|
git-diff-index plumbinginterrogators
|
||||||
git-diff-tree plumbinginterrogators
|
git-diff-tree plumbinginterrogators
|
||||||
git-difftool ancillaryinterrogators
|
git-difftool ancillaryinterrogators
|
||||||
git-fast-export ancillarymanipulators
|
git-fast-export ancillarymanipulators
|
||||||
git-fast-import ancillarymanipulators
|
git-fast-import ancillarymanipulators
|
||||||
git-fetch mainporcelain common
|
git-fetch mainporcelain common remote
|
||||||
git-fetch-pack synchingrepositories
|
git-fetch-pack synchingrepositories
|
||||||
git-filter-branch ancillarymanipulators
|
git-filter-branch ancillarymanipulators
|
||||||
git-fmt-merge-msg purehelpers
|
git-fmt-merge-msg purehelpers
|
||||||
|
|
@ -51,7 +61,7 @@ git-format-patch mainporcelain
|
||||||
git-fsck ancillaryinterrogators
|
git-fsck ancillaryinterrogators
|
||||||
git-gc mainporcelain
|
git-gc mainporcelain
|
||||||
git-get-tar-commit-id ancillaryinterrogators
|
git-get-tar-commit-id ancillaryinterrogators
|
||||||
git-grep mainporcelain common
|
git-grep mainporcelain common info
|
||||||
git-gui mainporcelain
|
git-gui mainporcelain
|
||||||
git-hash-object plumbingmanipulators
|
git-hash-object plumbingmanipulators
|
||||||
git-help ancillaryinterrogators
|
git-help ancillaryinterrogators
|
||||||
|
|
@ -60,17 +70,17 @@ git-http-fetch synchelpers
|
||||||
git-http-push synchelpers
|
git-http-push synchelpers
|
||||||
git-imap-send foreignscminterface
|
git-imap-send foreignscminterface
|
||||||
git-index-pack plumbingmanipulators
|
git-index-pack plumbingmanipulators
|
||||||
git-init mainporcelain common
|
git-init mainporcelain common init
|
||||||
git-instaweb ancillaryinterrogators
|
git-instaweb ancillaryinterrogators
|
||||||
git-interpret-trailers purehelpers
|
git-interpret-trailers purehelpers
|
||||||
gitk mainporcelain
|
gitk mainporcelain
|
||||||
git-log mainporcelain common
|
git-log mainporcelain common info
|
||||||
git-ls-files plumbinginterrogators
|
git-ls-files plumbinginterrogators
|
||||||
git-ls-remote plumbinginterrogators
|
git-ls-remote plumbinginterrogators
|
||||||
git-ls-tree plumbinginterrogators
|
git-ls-tree plumbinginterrogators
|
||||||
git-mailinfo purehelpers
|
git-mailinfo purehelpers
|
||||||
git-mailsplit purehelpers
|
git-mailsplit purehelpers
|
||||||
git-merge mainporcelain common
|
git-merge mainporcelain common history
|
||||||
git-merge-base plumbinginterrogators
|
git-merge-base plumbinginterrogators
|
||||||
git-merge-file plumbingmanipulators
|
git-merge-file plumbingmanipulators
|
||||||
git-merge-index plumbingmanipulators
|
git-merge-index plumbingmanipulators
|
||||||
|
|
@ -79,7 +89,7 @@ git-mergetool ancillarymanipulators
|
||||||
git-merge-tree ancillaryinterrogators
|
git-merge-tree ancillaryinterrogators
|
||||||
git-mktag plumbingmanipulators
|
git-mktag plumbingmanipulators
|
||||||
git-mktree plumbingmanipulators
|
git-mktree plumbingmanipulators
|
||||||
git-mv mainporcelain common
|
git-mv mainporcelain common worktree
|
||||||
git-name-rev plumbinginterrogators
|
git-name-rev plumbinginterrogators
|
||||||
git-notes mainporcelain
|
git-notes mainporcelain
|
||||||
git-p4 foreignscminterface
|
git-p4 foreignscminterface
|
||||||
|
|
@ -90,11 +100,11 @@ git-parse-remote synchelpers
|
||||||
git-patch-id purehelpers
|
git-patch-id purehelpers
|
||||||
git-prune ancillarymanipulators
|
git-prune ancillarymanipulators
|
||||||
git-prune-packed plumbingmanipulators
|
git-prune-packed plumbingmanipulators
|
||||||
git-pull mainporcelain common
|
git-pull mainporcelain common remote
|
||||||
git-push mainporcelain common
|
git-push mainporcelain common remote
|
||||||
git-quiltimport foreignscminterface
|
git-quiltimport foreignscminterface
|
||||||
git-read-tree plumbingmanipulators
|
git-read-tree plumbingmanipulators
|
||||||
git-rebase mainporcelain common
|
git-rebase mainporcelain common history
|
||||||
git-receive-pack synchelpers
|
git-receive-pack synchelpers
|
||||||
git-reflog ancillarymanipulators
|
git-reflog ancillarymanipulators
|
||||||
git-relink ancillarymanipulators
|
git-relink ancillarymanipulators
|
||||||
|
|
@ -103,28 +113,28 @@ git-repack ancillarymanipulators
|
||||||
git-replace ancillarymanipulators
|
git-replace ancillarymanipulators
|
||||||
git-request-pull foreignscminterface
|
git-request-pull foreignscminterface
|
||||||
git-rerere ancillaryinterrogators
|
git-rerere ancillaryinterrogators
|
||||||
git-reset mainporcelain common
|
git-reset mainporcelain common worktree
|
||||||
git-revert mainporcelain
|
git-revert mainporcelain
|
||||||
git-rev-list plumbinginterrogators
|
git-rev-list plumbinginterrogators
|
||||||
git-rev-parse ancillaryinterrogators
|
git-rev-parse ancillaryinterrogators
|
||||||
git-rm mainporcelain common
|
git-rm mainporcelain common worktree
|
||||||
git-send-email foreignscminterface
|
git-send-email foreignscminterface
|
||||||
git-send-pack synchingrepositories
|
git-send-pack synchingrepositories
|
||||||
git-shell synchelpers
|
git-shell synchelpers
|
||||||
git-shortlog mainporcelain
|
git-shortlog mainporcelain
|
||||||
git-show mainporcelain common
|
git-show mainporcelain common info
|
||||||
git-show-branch ancillaryinterrogators
|
git-show-branch ancillaryinterrogators
|
||||||
git-show-index plumbinginterrogators
|
git-show-index plumbinginterrogators
|
||||||
git-show-ref plumbinginterrogators
|
git-show-ref plumbinginterrogators
|
||||||
git-sh-i18n purehelpers
|
git-sh-i18n purehelpers
|
||||||
git-sh-setup purehelpers
|
git-sh-setup purehelpers
|
||||||
git-stash mainporcelain
|
git-stash mainporcelain
|
||||||
git-status mainporcelain common
|
git-status mainporcelain common info
|
||||||
git-stripspace purehelpers
|
git-stripspace purehelpers
|
||||||
git-submodule mainporcelain
|
git-submodule mainporcelain
|
||||||
git-svn foreignscminterface
|
git-svn foreignscminterface
|
||||||
git-symbolic-ref plumbingmanipulators
|
git-symbolic-ref plumbingmanipulators
|
||||||
git-tag mainporcelain common
|
git-tag mainporcelain common history
|
||||||
git-unpack-file plumbinginterrogators
|
git-unpack-file plumbinginterrogators
|
||||||
git-unpack-objects plumbingmanipulators
|
git-unpack-objects plumbingmanipulators
|
||||||
git-update-index plumbingmanipulators
|
git-update-index plumbingmanipulators
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue