summaryrefslogtreecommitdiff
path: root/Documentation/howto
diff options
context:
space:
mode:
authorS├ębastien Guimmara <sebastien.guimmara@gmail.com>2015-05-21 17:39:19 (GMT)
committerJunio C Hamano <gitster@pobox.com>2015-05-21 20:03:37 (GMT)
commit413f50b901f5f5addd7404516cdd3e8ee8a4ac25 (patch)
tree37ec6b84fb2c9c8a8e60f1b9b17dd55f3e3bd720 /Documentation/howto
parent11c6659d85d72273a4161c8779123147b52fbcb2 (diff)
downloadgit-413f50b901f5f5addd7404516cdd3e8ee8a4ac25.zip
git-413f50b901f5f5addd7404516cdd3e8ee8a4ac25.tar.gz
git-413f50b901f5f5addd7404516cdd3e8ee8a4ac25.tar.bz2
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>
Diffstat (limited to 'Documentation/howto')
-rw-r--r--Documentation/howto/new-command.txt4
1 files changed, 3 insertions, 1 deletions
diff --git a/Documentation/howto/new-command.txt b/Documentation/howto/new-command.txt
index d7de5a3..6d772bd 100644
--- a/Documentation/howto/new-command.txt
+++ b/Documentation/howto/new-command.txt
@@ -95,7 +95,9 @@ your language, document it in the INSTALL file.
that categorizes commands by type, so they can be listed in appropriate
subsections in the documentation's summary command list. Add an entry
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
to describe the new feature; a good place to do so is in the cover