undef/git-commit-vandalism
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

git.txt: add list of guides

Browse Source 
Not all man5/man7 guides are mentioned in the 'git(1)' documentation,
which makes the missing ones somewhat hard to find.

Add a list of the guides to git(1) by leveraging the existing
`Documentation/cmd-list.perl` script to generate a file `cmds-guide.txt`
which gets included in git.txt.

Also, do not hard-code the manual section '1'. Instead, use a regex so
that the manual section is discovered from the first line of each
`git*.txt` file.

This addition was hinted at in 1b81d8cb19 (help: use command-list.txt
for the source of guides, 2018-05-20).

Helped-by: Junio C Hamano <gitster@pobox.com>
Signed-off-by: Philippe Blain <levraiphilippeblain@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
Philippe Blain 2020-08-05 01:19:07 +00:00 committed by Junio C Hamano
parent e7a9807a62
commit f442f28a81
3 changed files with 14 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
Documentation/Makefile
View File

@ -295,6 +295,7 @@ cmds_txt = cmds-ancillaryinterrogators.txt \
cmds-plumbingmanipulators.txt \ cmds-plumbingmanipulators.txt \
cmds-synchingrepositories.txt \ cmds-synchingrepositories.txt \
cmds-synchelpers.txt \ cmds-synchelpers.txt \
cmds-guide.txt \
cmds-purehelpers.txt \ cmds-purehelpers.txt \
cmds-foreignscminterface.txt cmds-foreignscminterface.txt

7
Documentation/cmd-list.perl
View File

@ -6,9 +6,14 @@ sub format_one {
my ($out, $nameattr) = @_; my ($out, $nameattr) = @_;
my ($name, $attr) = @$nameattr; my ($name, $attr) = @$nameattr;
my ($state, $description); my ($state, $description);
my $mansection;
$state = 0; $state = 0;
open I, '<', "$name.txt" or die "No such file $name.txt"; open I, '<', "$name.txt" or die "No such file $name.txt";
while (<I>) { while (<I>) {
if (/^git[a-z0-9-]*\(([0-9])\)$/) {
$mansection = $1;
next;
}
if (/^NAME$/) { if (/^NAME$/) {
$state = 1; $state = 1;
next; next;
@ -27,7 +32,7 @@ sub format_one {
die "No description found in $name.txt"; die "No description found in $name.txt";
} }
if (my ($verify_name, $text) = ($description =~ /^($name) - (.*)/)) { if (my ($verify_name, $text) = ($description =~ /^($name) - (.*)/)) {
print $out "linkgit:$name\[1\]::\n\t"; print $out "linkgit:$name\[$mansection\]::\n\t";
if ($attr =~ / deprecated /) { if ($attr =~ / deprecated /) {
print $out "(deprecated) "; print $out "(deprecated) ";
} }

7
Documentation/git.txt
View File

@ -304,6 +304,13 @@ users typically do not use them directly.
include::cmds-purehelpers.txt[] include::cmds-purehelpers.txt[]
Guides
------
The following documentation pages are guides about Git concepts.
include::cmds-guide.txt[]
Configuration Mechanism Configuration Mechanism
----------------------- -----------------------