Skip to content

Commit 8fa2b45

Browse files
ChrisJohnsengitster
authored andcommitted
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 <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent ae8d09b commit 8fa2b45

File tree

2 files changed

+32
-5
lines changed

2 files changed

+32
-5
lines changed

Documentation/Makefile

Lines changed: 28 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,12 +59,39 @@ endif
5959
-include ../config.mak.autogen
6060
-include ../config.mak
6161

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+
6283
ifdef ASCIIDOC8
6384
ASCIIDOC_EXTRA += -a asciidoc7compatible
6485
endif
6586
ifdef DOCBOOK_XSL_172
66-
ASCIIDOC_EXTRA += -a docbook-xsl-172
87+
ASCIIDOC_EXTRA += -a git-asciidoc-no-roff
6788
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
6895
endif
6996

7097
#

Documentation/asciidoc.conf

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ ifdef::backend-docbook[]
2727
endif::backend-docbook[]
2828

2929
ifdef::backend-docbook[]
30-
ifndef::docbook-xsl-172[]
30+
ifndef::git-asciidoc-no-roff[]
3131
# "unbreak" docbook-xsl v1.68 for manpages. v1.69 works with or without this.
3232
# v1.72 breaks with this because it replaces dots not in roff requests.
3333
[listingblock]
@@ -42,9 +42,9 @@ ifdef::doctype-manpage[]
4242
endif::doctype-manpage[]
4343
</literallayout>
4444
{title#}</example>
45-
endif::docbook-xsl-172[]
45+
endif::git-asciidoc-no-roff[]
4646

47-
ifdef::docbook-xsl-172[]
47+
ifdef::git-asciidoc-no-roff[]
4848
ifdef::doctype-manpage[]
4949
# The following two small workarounds insert a simple paragraph after screen
5050
[listingblock]
@@ -62,7 +62,7 @@ ifdef::doctype-manpage[]
6262
</literallayout><simpara></simpara>
6363
{title#}</para></formalpara>
6464
endif::doctype-manpage[]
65-
endif::docbook-xsl-172[]
65+
endif::git-asciidoc-no-roff[]
6666
endif::backend-docbook[]
6767

6868
ifdef::doctype-manpage[]

0 commit comments

Comments
 (0)