aboutsummaryrefslogtreecommitdiff
path: root/Documentation
diff options
context:
space:
mode:
authorJunio C Hamano <gitster@pobox.com>2015-06-01 12:45:18 -0700
committerJunio C Hamano <gitster@pobox.com>2015-06-01 12:45:19 -0700
commit6dec263333417738528089834bd8cda72017aa31 (patch)
tree70e67708b1100262c98206130af057cc0b137fa6 /Documentation
parentabcbafedbfbd5994ad604bab141c0ba18f5a19df (diff)
parent224147704a3696d396dae005c280f7a25de407c7 (diff)
downloadgit-6dec263333417738528089834bd8cda72017aa31.tar.gz
git-6dec263333417738528089834bd8cda72017aa31.tar.xz
Merge branch 'sg/help-group'
Group list of commands shown by "git help" along the workflow elements to help early learners. * sg/help-group: help: respect new common command grouping command-list.txt: drop the "common" tag generate-cmdlist: parse common group commands command-list.txt: add the common groups block command-list: prepare machinery for upcoming "common groups" section
Diffstat (limited to 'Documentation')
-rwxr-xr-xDocumentation/cmd-list.perl4
-rw-r--r--Documentation/howto/new-command.txt4
2 files changed, 7 insertions, 1 deletions
diff --git a/Documentation/cmd-list.perl b/Documentation/cmd-list.perl
index 04f99778d..5aa73cfe4 100755
--- a/Documentation/cmd-list.perl
+++ b/Documentation/cmd-list.perl
@@ -38,6 +38,10 @@ sub format_one {
}
}
+while (<>) {
+ last if /^### command list/;
+}
+
my %cmds = ();
for (sort <>) {
next if /^#/;
diff --git a/Documentation/howto/new-command.txt b/Documentation/howto/new-command.txt
index d7de5a3e9..6d772bd92 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