Documentation: rename docbook-xsl-172 attribute to git-asciidoc-no-roff
It seems that the ability to use raw roff codes in asciidoc.conf was eliminated by docbook-xsl 1.72.0 _and later_. Unlike the 1.72.0-specific XSLT problem, this behavior was not reverted in later releases. This patch aims to make it clear that the affected asciidoc attribute (flag) can be reasonably used with docbook-xsl versions other than 1.72.0. Also, document which make variables should be set for various versions of asciidoc and docbook-xsl. Testing done with asciidoc 8.3.1 and docbook-xsl 1.74.0. Signed-off-by: Chris Johnsen <chris_johnsen@pobox.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Chris Johnsen committed
Mar 27, 2009 at 01:44 UTC
8fa2b45f3a70a1622c8fc5d35af148da5cab80d1
2 files changed
+32
-5
Documentation/Makefile
+28
-1
@@ -59,12 +59,39 @@ endif
59
-include ../config.mak.autogen
60
-include ../config.mak
61
62
+#
63
+# For asciidoc ...
64
+# -7.1.2, no extra settings are needed.
65
+# 8.0-, set ASCIIDOC8.
66
+#
67
+
68
+#
69
+# For docbook-xsl ...
70
+# -1.68.1, set ASCIIDOC_NO_ROFF? (based on changelog from 1.73.0)
71
+# 1.69.0-1.71.1, no extra settings are needed?
72
+# 1.72.0, set DOCBOOK_XSL_172.
73
+# 1.73.0-, set ASCIIDOC_NO_ROFF
74
+#
75
+
76
+#
77
+# If you had been using DOCBOOK_XSL_172 in an attempt to get rid
78
+# of 'the ".ft C" problem' in your generated manpages, and you
79
+# instead ended up with weird characters around callouts, try
80
+# using ASCIIDOC_NO_ROFF instead (it works fine with ASCIIDOC8).
81
+#
82
+
83
ifdef ASCIIDOC8
84
ASCIIDOC_EXTRA += -a asciidoc7compatible
85
endif
86
ifdef DOCBOOK_XSL_172
66
-ASCIIDOC_EXTRA += -a docbook-xsl-172
87
+ASCIIDOC_EXTRA += -a git-asciidoc-no-roff
88
MANPAGE_XSL = manpage-1.72.xsl
89
+else
90
+ ifdef ASCIIDOC_NO_ROFF
91
+ # docbook-xsl after 1.72 needs the regular XSL, but will not
92
+ # pass-thru raw roff codes from asciidoc.conf, so turn them off.
93
+ ASCIIDOC_EXTRA += -a git-asciidoc-no-roff
94
+ endif
95
endif
96
97
#
Documentation/asciidoc.conf
+4
-4
@@ -27,7 +27,7 @@ ifdef::backend-docbook[]
27
endif::backend-docbook[]
28
29
ifdef::backend-docbook[]
30
-ifndef::docbook-xsl-172[]
30
+ifndef::git-asciidoc-no-roff[]
31
# "unbreak" docbook-xsl v1.68 for manpages. v1.69 works with or without this.
32
# v1.72 breaks with this because it replaces dots not in roff requests.
33
[listingblock]
@@ -42,9 +42,9 @@ ifdef::doctype-manpage[]
42
endif::doctype-manpage[]
43
</literallayout>
44
{title#}</example>
45
-endif::docbook-xsl-172[]
45
+endif::git-asciidoc-no-roff[]
46
47
-ifdef::docbook-xsl-172[]
47
+ifdef::git-asciidoc-no-roff[]
48
ifdef::doctype-manpage[]
49
# The following two small workarounds insert a simple paragraph after screen
50
[listingblock]
@@ -62,7 +62,7 @@ ifdef::doctype-manpage[]
62
</literallayout><simpara></simpara>
63
{title#}</para></formalpara>
64
endif::doctype-manpage[]
65
-endif::docbook-xsl-172[]
65
+endif::git-asciidoc-no-roff[]
66
endif::backend-docbook[]
67
68
ifdef::doctype-manpage[]