Skip to content

Commit

Permalink
command-list: prepare machinery for upcoming "common groups" section
Browse files Browse the repository at this point in the history
The ultimate goal is for "git help" to classify common commands by
group. Toward this end, a subsequent patch will add a new "common
groups" section to command-list.txt preceding the actual command list.
As preparation, teach existing command-list.txt parsing machinery, which
doesn't care about grouping, to skip over this upcoming "common groups"
section.

Signed-off-by: Eric Sunshine <sunshine@sunshineco.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>
  • Loading branch information
sunshineco authored and gitster committed May 21, 2015
1 parent bf990a2 commit 11c6659
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 3 deletions.
4 changes: 4 additions & 0 deletions Documentation/cmd-list.perl
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,10 @@ sub format_one {
}
}

while (<>) {
last if /^### command list/;
}

my %cmds = ();
for (sort <>) {
next if /^#/;
Expand Down
5 changes: 3 additions & 2 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -2447,15 +2447,16 @@ check-docs::
esac ; \
test -f "Documentation/$$v.txt" || \
echo "no doc: $$v"; \
sed -e '/^#/d' command-list.txt | \
sed -e '1,/^### command list/d' -e '/^#/d' command-list.txt | \
grep -q "^$$v[ ]" || \
case "$$v" in \
git) ;; \
*) echo "no link: $$v";; \
esac ; \
done; \
( \
sed -e '/^#/d' \
sed -e '1,/^### command list/d' \
-e '/^#/d' \
-e 's/[ ].*//' \
-e 's/^/listed /' command-list.txt; \
$(MAKE) -C Documentation print-man1 | \
Expand Down
2 changes: 1 addition & 1 deletion command-list.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# List of known git commands.
### command list (do not change this line)
# command name category [deprecated] [common]
git-add mainporcelain common
git-am mainporcelain
Expand Down

0 comments on commit 11c6659

Please sign in to comment.