[PATCH 1/2] Documentation: Allow @@GIT_VERSION@@ in asciidoc.conf
From: Frank Lichtenheld <hidden>
Date: 2016-06-15 22:43:01
Subsystem:
documentation, the rest · Maintainers:
Jonathan Corbet, Linus Torvalds
Rename asciidoc.conf to asciidoc.conf.in and create the former on build time after piping it through sed. This is useful to allow us to include the git version in the documentation. Signed-off-by: Frank Lichtenheld <redacted> --- Documentation/Makefile | 11 ++++++++--- Documentation/asciidoc.conf | 39 --------------------------------------- Documentation/asciidoc.conf.in | 39 +++++++++++++++++++++++++++++++++++++++ 3 files changed, 47 insertions(+), 42 deletions(-) delete mode 100644 Documentation/asciidoc.conf create mode 100644 Documentation/asciidoc.conf.in
diff --git a/Documentation/Makefile b/Documentation/Makefile
index 7c1c9e1..6197929 100644
--- a/Documentation/Makefile
+++ b/Documentation/Makefile@@ -38,6 +38,7 @@ DOC_REF = origin/man -include ../config.mak.autogen -include ../config.mak +-include ../GIT-VERSION-FILE # # Please note that there is a minor bug in asciidoc.
@@ -90,16 +91,20 @@ $(cmds_txt): cmd-list.perl $(MAN1_TXT) git.7 git.html: git.txt core-intro.txt clean: - rm -f *.xml *.html *.1 *.7 howto-index.txt howto/*.html doc.dep + rm -f *.xml *.html *.1 *.7 howto-index.txt howto/*.html doc.dep asciidoc.conf rm -f $(cmds_txt) -%.html : %.txt +asciidoc.conf: asciidoc.conf.in + sed -e 's/@@GIT_VERSION@@/$(GIT_VERSION)/g' $< >$@+ + mv $@+ $@ + +%.html : %.txt asciidoc.conf $(ASCIIDOC) -b xhtml11 -d manpage -f asciidoc.conf $(ASCIIDOC_EXTRA) $< %.1 %.7 : %.xml xmlto -m callouts.xsl man $< -%.xml : %.txt +%.xml : %.txt asciidoc.conf $(ASCIIDOC) -b docbook -d manpage -f asciidoc.conf $< user-manual.xml: user-manual.txt user-manual.conf
diff --git a/Documentation/asciidoc.conf b/Documentation/asciidoc.conf
deleted file mode 100644
index 44b1ce4..0000000
--- a/Documentation/asciidoc.conf
+++ /dev/null@@ -1,39 +0,0 @@ -## 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. - -[attributes] -caret=^ -startsb=[ -endsb=] -tilde=~ - -ifdef::backend-docbook[] -[gitlink-inlinemacro] -{0%{target}} -{0#<citerefentry>} -{0#<refentrytitle>{target}</refentrytitle><manvolnum>{0}</manvolnum>} -{0#</citerefentry>} -endif::backend-docbook[] - -ifdef::backend-docbook[] -# "unbreak" docbook-xsl v1.68 for manpages. v1.69 works with or without this. -[listingblock] -<example><title>{title}</title> -<literallayout> -| -</literallayout> -{title#}</example> -endif::backend-docbook[] - -ifdef::backend-xhtml11[] -[gitlink-inlinemacro] -<a href="{target}.html">{target}{0?({0})}</a> -endif::backend-xhtml11[] - -
diff --git a/Documentation/asciidoc.conf.in b/Documentation/asciidoc.conf.in
new file mode 100644
index 0000000..44b1ce4
--- /dev/null
+++ b/Documentation/asciidoc.conf.in@@ -0,0 +1,39 @@ +## 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. + +[attributes] +caret=^ +startsb=[ +endsb=] +tilde=~ + +ifdef::backend-docbook[] +[gitlink-inlinemacro] +{0%{target}} +{0#<citerefentry>} +{0#<refentrytitle>{target}</refentrytitle><manvolnum>{0}</manvolnum>} +{0#</citerefentry>} +endif::backend-docbook[] + +ifdef::backend-docbook[] +# "unbreak" docbook-xsl v1.68 for manpages. v1.69 works with or without this. +[listingblock] +<example><title>{title}</title> +<literallayout> +| +</literallayout> +{title#}</example> +endif::backend-docbook[] + +ifdef::backend-xhtml11[] +[gitlink-inlinemacro] +<a href="{target}.html">{target}{0?({0})}</a> +endif::backend-xhtml11[] + +
--
1.5.0.3