Skip to content

Commit bf17126

Browse files
peffgitster
authored andcommitted
docs: drop asciidoc7compatible flag
When we made the switch to supporting asciidoc 8 in 4c7100a (Documentation: adjust to AsciiDoc 8, 2007-06-14), we were able to leave most of the documentation intact by defining asciidoc7compatible. Since commit 6cf378f (docs: stop using asciidoc no-inline-literal, 2012-04-26), we don't support versions of asciidoc older than 8.4.1, which is when inline literals were introduced. Therefore there is not much point in keeping our documentation compatible with asciidoc 7. So we are now free to drop the asciidoc7compatible flag and update the documentation itself to assume asciidoc8. Fortunately, doing the latter is very easy; we weren't using any of the constructs impacted by asciidoc7compatible, so there are no changes to make. The reason is somewhat subtle. The asciidoc7compatible affects only super/sub-scripts ("^" and "~") and index terms. We don't use the latter at all. Nor we do we use the former, but we did have to protect them from accidental expansion in constructs like "rev^1". However, all of our uses of "~" and "^" are either in code blocks (which are rendered literally), or inside backticks. Prior to 6cf378f, backticks were not inline literals, and needed proper quoting. But post-6cf378f, we don't have to worry whether we are using the old or new rules, as those characters are not interpreted at all in either case. I verified that the result of "make install-html install-man" is identical before and after this patch on asciidoc 8.6.7. Signed-off-by: Jeff King <peff@peff.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
1 parent b2478aa commit bf17126

File tree

4 files changed

+0
-23
lines changed

4 files changed

+0
-23
lines changed

Documentation/Makefile

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -65,12 +65,6 @@ endif
6565
-include ../config.mak.autogen
6666
-include ../config.mak
6767

68-
#
69-
# For asciidoc ...
70-
# -7.1.2, set ASCIIDOC7
71-
# 8.0-, no extra settings are needed
72-
#
73-
7468
#
7569
# For docbook-xsl ...
7670
# -1.68.1, no extra settings are needed?
@@ -81,9 +75,6 @@ endif
8175
# 1.73.0-, no extra settings are needed
8276
#
8377

84-
ifndef ASCIIDOC7
85-
ASCIIDOC_EXTRA += -a asciidoc7compatible
86-
endif
8778
ifdef DOCBOOK_XSL_172
8879
ASCIIDOC_EXTRA += -a git-asciidoc-no-roff
8980
MANPAGE_XSL = manpage-1.72.xsl

Makefile

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -203,8 +203,6 @@ all::
203203
# Define NO_ST_BLOCKS_IN_STRUCT_STAT if your platform does not have st_blocks
204204
# field that counts the on-disk footprint in 512-byte blocks.
205205
#
206-
# Define ASCIIDOC7 if you want to format documentation with AsciiDoc 7
207-
#
208206
# Define DOCBOOK_XSL_172 if you want to format man pages with DocBook XSL v1.72
209207
# (not v1.73 or v1.71).
210208
#
@@ -1834,10 +1832,6 @@ ifndef V
18341832
endif
18351833
endif
18361834

1837-
ifdef ASCIIDOC7
1838-
export ASCIIDOC7
1839-
endif
1840-
18411835
ifdef NO_INSTALL_HARDLINKS
18421836
export NO_INSTALL_HARDLINKS
18431837
endif

config.mak.in

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,6 @@ VPATH = @srcdir@
2828
export exec_prefix mandir
2929
export srcdir VPATH
3030

31-
ASCIIDOC7=@ASCIIDOC7@
3231
NEEDS_SSL_WITH_CRYPTO=@NEEDS_SSL_WITH_CRYPTO@
3332
NO_OPENSSL=@NO_OPENSSL@
3433
NO_CURL=@NO_CURL@

configure.ac

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -437,21 +437,14 @@ if test -n "$ASCIIDOC"; then
437437
AC_MSG_CHECKING([for asciidoc version])
438438
asciidoc_version=`$ASCIIDOC --version 2>/dev/null`
439439
case "${asciidoc_version}" in
440-
asciidoc' '7*)
441-
ASCIIDOC7=YesPlease
442-
AC_MSG_RESULT([${asciidoc_version} > 7])
443-
;;
444440
asciidoc' '8*)
445-
ASCIIDOC7=
446441
AC_MSG_RESULT([${asciidoc_version}])
447442
;;
448443
*)
449-
ASCIIDOC7=
450444
AC_MSG_RESULT([${asciidoc_version} (unknown)])
451445
;;
452446
esac
453447
fi
454-
AC_SUBST(ASCIIDOC7)
455448

456449

457450
## Checks for libraries.

0 commit comments

Comments
 (0)