[PATCH v2 1/3] git help: group common commands by theme
- From
Sébastien Guimmara <sebastien.guimmara@gmail.com>
- Date
- May 1, 2015, 23:01 UTC
- Message-ID
- <554405D5.9080702@gmail.com>
This v2 contains exactly the same patches but this time they are properly formatted using format-patch.
Group the common commands printed by 'git help' (or 'git' without any options) a beginner's friendly themes. To achieve this, the file command-list.txt receives an additional information for all 'common' commands, in the form of an indexed group suffix.
Group suffixes are in the form: 'x_group', where x is a number used to order (ascending) commands in the displayed help:
[...]
git-add mainporcelain common-3_worktree git-bisect mainporcelain common-7_search git-branch mainporcelain common-6_branching git-checkout mainporcelain common-6_branching
[...]
Note: the proposed layout comprises:
1_init 2_info 3_worktree 4_remote 5_history 6_branching 7_search
But they can be easily modified by just changing command-list.txt
command-list.txt is then parsed by generate-cmdlist.sh to generate common-cmds.h with the additional group name being a 'group' field in the cmdname_help struct:
[...]
{"add", N_("Add file contents to the index"), "3_worktree"},
{"bisect", N_("Find by binary search the change that introduced a
bug"), "7_search"},
{"branch", N_("List, create, or delete branches"), "6_branching"},
{"checkout", N_("Checkout a branch or paths to the working tree"),
"6_branching"},[...]
Finally, list_common_cmds_help() prints those common commands by groups, skipping a line between each group:
[...]
The most commonly used git commands are:
clone Clone a repository into a new directory
init Create an empty Git repository or reinitialize an
existing one log Show commit logs
show Show various types of objects
status Show the working tree status add Add file contents to the index
mv Move or rename a file, a directory, or a symlink
reset Reset current HEAD to the specified state
rm Remove files from the working tree and from the index fetch Download objects and refs from another repository
pull Fetch from and integrate with another repository or a
local branch
push Update remote refs along with associated objects commit Record changes to the repository
diff Show changes between commits, commit and working tree, etc
rebase Forward-port local commits to the updated upstream head
tag Create, list, delete or verify a tag object signed with GPG[...]
Signed-off-by: Sébastien Guimmara <sebastien.guimmara@gmail.com>
--- command-list.txt | 42 +++++++++++++++++++++--------------------- 1 file changed, 21 insertions(+), 21 deletions(-)
diff --git a/command-list.txt b/command-list.txt index f1eae08..b0730a2 100644 --- a/command-list.txt +++ b/command-list.txt @@ -1,29 +1,29 @@ # List of known git commands. # command name category [deprecated] [common] -git-add mainporcelain common +git-add mainporcelain common-3_worktree git-am mainporcelain git-annotate ancillaryinterrogators git-apply plumbingmanipulators git-archimport foreignscminterface git-archive mainporcelain -git-bisect mainporcelain common +git-bisect mainporcelain common-7_search git-blame ancillaryinterrogators -git-branch mainporcelain common +git-branch mainporcelain common-6_branching git-bundle mainporcelain git-cat-file plumbinginterrogators git-check-attr purehelpers git-check-ignore purehelpers git-check-mailmap purehelpers -git-checkout mainporcelain common +git-checkout mainporcelain common-6_branching git-checkout-index plumbingmanipulators git-check-ref-format purehelpers git-cherry ancillaryinterrogators git-cherry-pick mainporcelain git-citool mainporcelain git-clean mainporcelain -git-clone mainporcelain common +git-clone mainporcelain common-1_init git-column purehelpers -git-commit mainporcelain common +git-commit mainporcelain common-5_history git-commit-tree plumbingmanipulators git-config ancillarymanipulators git-count-objects ancillaryinterrogators @@ -35,14 +35,14 @@ git-cvsimport foreignscminterface git-cvsserver foreignscminterface git-daemon synchingrepositories git-describe mainporcelain -git-diff mainporcelain common +git-diff mainporcelain common-5_history git-diff-files plumbinginterrogators git-diff-index plumbinginterrogators git-diff-tree plumbinginterrogators git-difftool ancillaryinterrogators git-fast-export ancillarymanipulators git-fast-import ancillarymanipulators -git-fetch mainporcelain common +git-fetch mainporcelain common-4_remote git-fetch-pack synchingrepositories git-filter-branch ancillarymanipulators git-fmt-merge-msg purehelpers @@ -51,7 +51,7 @@ git-format-patch mainporcelain git-fsck ancillaryinterrogators git-gc mainporcelain git-get-tar-commit-id ancillaryinterrogators -git-grep mainporcelain common +git-grep mainporcelain common-7_search git-gui mainporcelain git-hash-object plumbingmanipulators git-help ancillaryinterrogators @@ -60,17 +60,17 @@ git-http-fetch synchelpers git-http-push synchelpers git-imap-send foreignscminterface git-index-pack plumbingmanipulators -git-init mainporcelain common +git-init mainporcelain common-1_init git-instaweb ancillaryinterrogators git-interpret-trailers purehelpers gitk mainporcelain -git-log mainporcelain common +git-log mainporcelain common-2_info git-ls-files plumbinginterrogators git-ls-remote plumbinginterrogators git-ls-tree plumbinginterrogators git-mailinfo purehelpers git-mailsplit purehelpers -git-merge mainporcelain common +git-merge mainporcelain common-6_branching git-merge-base plumbinginterrogators git-merge-file plumbingmanipulators git-merge-index plumbingmanipulators @@ -79,7 +79,7 @@ git-mergetool ancillarymanipulators git-merge-tree ancillaryinterrogators git-mktag plumbingmanipulators git-mktree plumbingmanipulators -git-mv mainporcelain common +git-mv mainporcelain common-3_worktree git-name-rev plumbinginterrogators git-notes mainporcelain git-p4 foreignscminterface @@ -90,11 +90,11 @@ git-parse-remote synchelpers git-patch-id purehelpers git-prune ancillarymanipulators git-prune-packed plumbingmanipulators -git-pull mainporcelain common -git-push mainporcelain common +git-pull mainporcelain common-4_remote +git-push mainporcelain common-4_remote git-quiltimport foreignscminterface git-read-tree plumbingmanipulators -git-rebase mainporcelain common +git-rebase mainporcelain common-5_history git-receive-pack synchelpers git-reflog ancillarymanipulators git-relink ancillarymanipulators @@ -103,28 +103,28 @@ git-repack ancillarymanipulators git-replace ancillarymanipulators git-request-pull foreignscminterface git-rerere ancillaryinterrogators -git-reset mainporcelain common +git-reset mainporcelain common-3_worktree git-revert mainporcelain git-rev-list plumbinginterrogators git-rev-parse ancillaryinterrogators -git-rm mainporcelain common +git-rm mainporcelain common-3_worktree git-send-email foreignscminterface git-send-pack synchingrepositories git-shell synchelpers git-shortlog mainporcelain -git-show mainporcelain common +git-show mainporcelain common-2_info git-show-branch ancillaryinterrogators git-show-index plumbinginterrogators git-show-ref plumbinginterrogators git-sh-i18n purehelpers git-sh-setup purehelpers git-stash mainporcelain -git-status mainporcelain common +git-status mainporcelain common-2_info git-stripspace purehelpers git-submodule mainporcelain git-svn foreignscminterface git-symbolic-ref plumbingmanipulators -git-tag mainporcelain common +git-tag mainporcelain common-5_history git-unpack-file plumbinginterrogators git-unpack-objects plumbingmanipulators git-update-index plumbingmanipulators
-- 2.4.0