Skip to content

Commit 79c461d

Browse files
peffgitster
authored andcommitted
docs: default to more modern toolset
When the ASCIIDOC8 and ASCIIDOC_NO_ROFF knobs were built, many people were still on asciidoc 7 and using older versions of docbook-xsl. These days, even the almost 2-year-old Debian stable needs these knobs turned. So let's turn them by default. The new knobs ASCIIDOC7 and ASCIIDOC_ROFF can be used to get the old behavior if people are on older systems. Signed-off-by: Jeff King <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent 03276d9 commit 79c461d

File tree

6 files changed

+27
-29
lines changed

6 files changed

+27
-29
lines changed

Documentation/Makefile

Lines changed: 8 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -63,35 +63,28 @@ endif
6363

6464
#
6565
# For asciidoc ...
66-
# -7.1.2, no extra settings are needed.
67-
# 8.0-, set ASCIIDOC8.
66+
# -7.1.2, set ASCIIDOC7
67+
# 8.0-, no extra settings are needed
6868
#
6969

7070
#
7171
# For docbook-xsl ...
72-
# -1.68.1, set ASCIIDOC_NO_ROFF? (based on changelog from 1.73.0)
73-
# 1.69.0, no extra settings are needed?
72+
# -1.68.1, no extra settings are needed?
73+
# 1.69.0, set ASCIIDOC_ROFF?
7474
# 1.69.1-1.71.0, set DOCBOOK_SUPPRESS_SP?
75-
# 1.71.1, no extra settings are needed?
75+
# 1.71.1, set ASCIIDOC_ROFF?
7676
# 1.72.0, set DOCBOOK_XSL_172.
77-
# 1.73.0-, set ASCIIDOC_NO_ROFF
77+
# 1.73.0-, no extra settings are needed
7878
#
7979

80-
#
81-
# If you had been using DOCBOOK_XSL_172 in an attempt to get rid
82-
# of 'the ".ft C" problem' in your generated manpages, and you
83-
# instead ended up with weird characters around callouts, try
84-
# using ASCIIDOC_NO_ROFF instead (it works fine with ASCIIDOC8).
85-
#
86-
87-
ifdef ASCIIDOC8
80+
ifndef ASCIIDOC7
8881
ASCIIDOC_EXTRA += -a asciidoc7compatible -a no-inline-literal
8982
endif
9083
ifdef DOCBOOK_XSL_172
9184
ASCIIDOC_EXTRA += -a git-asciidoc-no-roff
9285
MANPAGE_XSL = manpage-1.72.xsl
9386
else
94-
ifdef ASCIIDOC_NO_ROFF
87+
ifndef ASCIIDOC_ROFF
9588
# docbook-xsl after 1.72 needs the regular XSL, but will not
9689
# pass-thru raw roff codes from asciidoc.conf, so turn them off.
9790
ASCIIDOC_EXTRA += -a git-asciidoc-no-roff

Documentation/RelNotes/1.7.4.txt

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,10 @@ Git v1.7.4 Release Notes (draft)
44
Updates since v1.7.3
55
--------------------
66

7+
* The documentation Makefile now assumes by default asciidoc 8 and
8+
docbook-xsl >= 1.73. If you have older versions, you can set
9+
ASCIIDOC7 and ASCIIDOC_ROFF, respectively.
10+
711
* The option parsers of various commands that create new branch (or
812
rename existing ones to a new name) were too loose and users were
913
allowed to call a branch with a name that begins with a dash by

INSTALL

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -122,8 +122,9 @@ Issues of note:
122122
Building and installing the pdf file additionally requires
123123
dblatex. Version 0.2.7 with asciidoc >= 8.2.7 is known to work.
124124

125-
The documentation is written for AsciiDoc 7, but "make
126-
ASCIIDOC8=YesPlease doc" will let you format with AsciiDoc 8.
125+
The documentation is written for AsciiDoc 7, but by default
126+
uses some compatibility wrappers to work on AsciiDoc 8. If you have
127+
AsciiDoc 7, try "make ASCIIDOC7=YesPlease".
127128

128129
Alternatively, pre-formatted documentation is available in
129130
"html" and "man" branches of the git repository itself. For

Makefile

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -162,13 +162,13 @@ all::
162162
# Define NO_ST_BLOCKS_IN_STRUCT_STAT if your platform does not have st_blocks
163163
# field that counts the on-disk footprint in 512-byte blocks.
164164
#
165-
# Define ASCIIDOC8 if you want to format documentation with AsciiDoc 8
165+
# Define ASCIIDOC7 if you want to format documentation with AsciiDoc 7
166166
#
167167
# Define DOCBOOK_XSL_172 if you want to format man pages with DocBook XSL v1.72
168168
# (not v1.73 or v1.71).
169169
#
170-
# Define ASCIIDOC_NO_ROFF if your DocBook XSL escapes raw roff directives
171-
# (versions 1.72 and later and 1.68.1 and earlier).
170+
# Define ASCIIDOC_ROFF if your DocBook XSL does not escape raw roff directives
171+
# (versions 1.68.1 through v1.72).
172172
#
173173
# Define GNU_ROFF if your target system uses GNU groff. This forces
174174
# apostrophes to be ASCII so that cut&pasting examples to the shell
@@ -1518,8 +1518,8 @@ ifndef V
15181518
endif
15191519
endif
15201520

1521-
ifdef ASCIIDOC8
1522-
export ASCIIDOC8
1521+
ifdef ASCIIDOC7
1522+
export ASCIIDOC7
15231523
endif
15241524

15251525
# Shell quote (do not use $(call) to accommodate ancient setups);

config.mak.in

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ VPATH = @srcdir@
2727
export exec_prefix mandir
2828
export srcdir VPATH
2929

30-
ASCIIDOC8=@ASCIIDOC8@
30+
ASCIIDOC7=@ASCIIDOC7@
3131
NEEDS_SSL_WITH_CRYPTO=@NEEDS_SSL_WITH_CRYPTO@
3232
NO_OPENSSL=@NO_OPENSSL@
3333
NO_CURL=@NO_CURL@

configure.ac

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -398,21 +398,21 @@ if test -n "$ASCIIDOC"; then
398398
AC_MSG_CHECKING([for asciidoc version])
399399
asciidoc_version=`$ASCIIDOC --version 2>/dev/null`
400400
case "${asciidoc_version}" in
401-
asciidoc' '8*)
402-
ASCIIDOC8=YesPlease
401+
asciidoc' '7*)
402+
ASCIIDOC7=YesPlease
403403
AC_MSG_RESULT([${asciidoc_version} > 7])
404404
;;
405-
asciidoc' '7*)
406-
ASCIIDOC8=
405+
asciidoc' '8*)
406+
ASCIIDOC7=
407407
AC_MSG_RESULT([${asciidoc_version}])
408408
;;
409409
*)
410-
ASCIIDOC8=
410+
ASCIIDOC7=
411411
AC_MSG_RESULT([${asciidoc_version} (unknown)])
412412
;;
413413
esac
414414
fi
415-
AC_SUBST(ASCIIDOC8)
415+
AC_SUBST(ASCIIDOC7)
416416

417417

418418
## Checks for libraries.

0 commit comments

Comments
 (0)