summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSergey Vlasov <vsu@altlinux.ru>2005-09-19 10:10:14 (GMT)
committerJunio C Hamano <junkio@cox.net>2005-09-20 22:07:51 (GMT)
commitd1c2e113c5b6bb580bb345fc9bc56e0b8712d070 (patch)
treebf77564038f7f47d26419cfba767fcdd33ba6f4a
parentaf61c6e008c39ee9f61af33bb48850230f503443 (diff)
downloadgit-d1c2e113c5b6bb580bb345fc9bc56e0b8712d070.zip
git-d1c2e113c5b6bb580bb345fc9bc56e0b8712d070.tar.gz
git-d1c2e113c5b6bb580bb345fc9bc56e0b8712d070.tar.bz2
[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>
-rw-r--r--Documentation/Makefile4
-rw-r--r--Documentation/asciidoc.conf21
2 files changed, 23 insertions, 2 deletions
diff --git a/Documentation/Makefile b/Documentation/Makefile
index 37b7fcb..822098a 100644
--- a/Documentation/Makefile
+++ b/Documentation/Makefile
@@ -57,13 +57,13 @@ clean:
rm -f *.xml *.html *.1 *.7 howto-index.txt howto/*.html
%.html : %.txt
- asciidoc -b xhtml11 -d manpage $<
+ asciidoc -b xhtml11 -d manpage -f asciidoc.conf $<
%.1 %.7 : %.xml
xmlto man $<
%.xml : %.txt
- asciidoc -b docbook -d manpage $<
+ asciidoc -b docbook -d manpage -f asciidoc.conf $<
git.html: git.txt ../README
diff --git a/Documentation/asciidoc.conf b/Documentation/asciidoc.conf
new file mode 100644
index 0000000..baefb2f
--- /dev/null
+++ b/Documentation/asciidoc.conf
@@ -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[]