Skip to content

Commit

Permalink
Fix the building of gitman.info document
Browse files Browse the repository at this point in the history
"makeinfo" failed to generate gitman.info from gitman.texi input file
because the combined manual page file contains several nodes with the
same name (DESCRIPTION, OPTIONS, SEE ALSO etc.). An Info document should
contain unique node names.

This patch creates a simple (read: ugly) work-around by suppressing the
validation of the final Info file. Jumping to nodes in the Info document
still works but they are not very useful. Common man-page headings like
DESCRIPTION and OPTIONS appear in the Info node list and they point to
the man page where they appear first (that is git-add currently).

Also, this patch adds directory-entry information for Info document to
make the document appear in the top-level Info directory.

Signed-off-by: Teemu Likonen <tlikonen@iki.fi>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
  • Loading branch information
Teemu Likonen authored and Junio C Hamano committed Dec 29, 2008
1 parent 8b30ad0 commit 9c6c304
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 3 deletions.
2 changes: 1 addition & 1 deletion Documentation/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -198,7 +198,7 @@ gitman.texi: $(MAN_XML) cat-texi.perl
mv $@+ $@

gitman.info: gitman.texi
$(MAKEINFO) --no-split $*.texi
$(MAKEINFO) --no-split --no-validate $*.texi

$(patsubst %.txt,%.texi,$(MAN_TXT)): %.texi : %.xml
$(RM) $@+ $@
Expand Down
8 changes: 6 additions & 2 deletions Documentation/cat-texi.perl
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,12 @@

printf '\input texinfo
@setfilename gitman.info
@documentencoding us-ascii
@node Top,,%s
@documentencoding UTF-8
@dircategory Development
@direntry
* Git Man Pages: (gitman). Manual pages for Git revision control system
@end direntry
@node Top,,, (dir)
@top Git Manual Pages
@documentlanguage en
@menu
Expand Down

0 comments on commit 9c6c304

Please sign in to comment.