kernel
/
git
mirror of https://git.kernel.org/pub/scm/git/git.git
1
0
Fork 0
Code Releases Activity

[PATCH] Documentation: Add asciidoc.conf file and gitlink: macro 

Introduce an asciidoc.conf file with the purpose of adding a gitlink:
macro which will improve the manpage output.

Original cogito patch by Jonas Fonseca <fonseca@diku.dk>;
asciidoc.conf from that patch was further enhanced to use the proper
DocBook tag <citerefentry> for references to man pages.

Signed-off-by: Sergey Vlasov <vsu@altlinux.ru>
Signed-off-by: Junio C Hamano <junkio@cox.net>
maint
Sergey Vlasov 2005-09-19 14:10:14 +04:00 committed by Junio C Hamano
parent af61c6e008
commit d1c2e113c5
2 changed files with 23 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
Documentation/Makefile
View File

@ -57,13 +57,13 @@ clean:
rm -f *.xml *.html *.1 *.7 howto-index.txt howto/*.html rm -f *.xml *.html *.1 *.7 howto-index.txt howto/*.html


%.html : %.txt %.html : %.txt
asciidoc -b xhtml11 -d manpage $< asciidoc -b xhtml11 -d manpage -f asciidoc.conf $<


%.1 %.7 : %.xml %.1 %.7 : %.xml
xmlto man $< xmlto man $<


%.xml : %.txt %.xml : %.txt
asciidoc -b docbook -d manpage $< asciidoc -b docbook -d manpage -f asciidoc.conf $<


git.html: git.txt ../README git.html: git.txt ../README



21
Documentation/asciidoc.conf Normal file
View File

@ -0,0 +1,21 @@
## gitlink: macro
#
# Usage: gitlink:command[manpage-section]
#
# Note, {0} is the manpage section, while {target} is the command.
#
# Show GIT link as: <command>(<section>); if section is defined, else just show
# the command.

ifdef::backend-docbook[]
[gitlink-inlinemacro]
{0%{target}}
{0#<citerefentry>}
{0#<refentrytitle>{target}</refentrytitle><manvolnum>{0}</manvolnum>}
{0#</citerefentry>}
endif::backend-docbook[]

ifdef::backend-xhtml11[]
[gitlink-inlinemacro]
<a href="{target}.html">{target}{0?({0})}</a>
endif::backend-xhtml11[]