1
0
Fork 0
mirror of https://github.com/git/git.git synced 2024-06-03 15:46:17 +02:00

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 <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
Jeff King 2010-11-19 12:54:24 -05:00 committed by Junio C Hamano
parent 03276d94bc
commit 79c461d5b1
6 changed files with 27 additions and 29 deletions

View File

@ -63,35 +63,28 @@ endif
# #
# For asciidoc ... # For asciidoc ...
# -7.1.2, no extra settings are needed. # -7.1.2, set ASCIIDOC7
# 8.0-, set ASCIIDOC8. # 8.0-, no extra settings are needed
# #
# #
# For docbook-xsl ... # For docbook-xsl ...
# -1.68.1, set ASCIIDOC_NO_ROFF? (based on changelog from 1.73.0) # -1.68.1, no extra settings are needed?
# 1.69.0, no extra settings are needed? # 1.69.0, set ASCIIDOC_ROFF?
# 1.69.1-1.71.0, set DOCBOOK_SUPPRESS_SP? # 1.69.1-1.71.0, set DOCBOOK_SUPPRESS_SP?
# 1.71.1, no extra settings are needed? # 1.71.1, set ASCIIDOC_ROFF?
# 1.72.0, set DOCBOOK_XSL_172. # 1.72.0, set DOCBOOK_XSL_172.
# 1.73.0-, set ASCIIDOC_NO_ROFF # 1.73.0-, no extra settings are needed
# #
# ifndef ASCIIDOC7
# If you had been using DOCBOOK_XSL_172 in an attempt to get rid
# of 'the ".ft C" problem' in your generated manpages, and you
# instead ended up with weird characters around callouts, try
# using ASCIIDOC_NO_ROFF instead (it works fine with ASCIIDOC8).
#
ifdef ASCIIDOC8
ASCIIDOC_EXTRA += -a asciidoc7compatible -a no-inline-literal ASCIIDOC_EXTRA += -a asciidoc7compatible -a no-inline-literal
endif endif
ifdef DOCBOOK_XSL_172 ifdef DOCBOOK_XSL_172
ASCIIDOC_EXTRA += -a git-asciidoc-no-roff ASCIIDOC_EXTRA += -a git-asciidoc-no-roff
MANPAGE_XSL = manpage-1.72.xsl MANPAGE_XSL = manpage-1.72.xsl
else else
ifdef ASCIIDOC_NO_ROFF ifndef ASCIIDOC_ROFF
# docbook-xsl after 1.72 needs the regular XSL, but will not # docbook-xsl after 1.72 needs the regular XSL, but will not
# pass-thru raw roff codes from asciidoc.conf, so turn them off. # pass-thru raw roff codes from asciidoc.conf, so turn them off.
ASCIIDOC_EXTRA += -a git-asciidoc-no-roff ASCIIDOC_EXTRA += -a git-asciidoc-no-roff

View File

@ -4,6 +4,10 @@ Git v1.7.4 Release Notes (draft)
Updates since v1.7.3 Updates since v1.7.3
-------------------- --------------------
* The documentation Makefile now assumes by default asciidoc 8 and
docbook-xsl >= 1.73. If you have older versions, you can set
ASCIIDOC7 and ASCIIDOC_ROFF, respectively.
* The option parsers of various commands that create new branch (or * The option parsers of various commands that create new branch (or
rename existing ones to a new name) were too loose and users were rename existing ones to a new name) were too loose and users were
allowed to call a branch with a name that begins with a dash by allowed to call a branch with a name that begins with a dash by

View File

@ -122,8 +122,9 @@ Issues of note:
Building and installing the pdf file additionally requires Building and installing the pdf file additionally requires
dblatex. Version 0.2.7 with asciidoc >= 8.2.7 is known to work. dblatex. Version 0.2.7 with asciidoc >= 8.2.7 is known to work.
The documentation is written for AsciiDoc 7, but "make The documentation is written for AsciiDoc 7, but by default
ASCIIDOC8=YesPlease doc" will let you format with AsciiDoc 8. uses some compatibility wrappers to work on AsciiDoc 8. If you have
AsciiDoc 7, try "make ASCIIDOC7=YesPlease".
Alternatively, pre-formatted documentation is available in Alternatively, pre-formatted documentation is available in
"html" and "man" branches of the git repository itself. For "html" and "man" branches of the git repository itself. For

View File

@ -162,13 +162,13 @@ all::
# Define NO_ST_BLOCKS_IN_STRUCT_STAT if your platform does not have st_blocks # Define NO_ST_BLOCKS_IN_STRUCT_STAT if your platform does not have st_blocks
# field that counts the on-disk footprint in 512-byte blocks. # field that counts the on-disk footprint in 512-byte blocks.
# #
# Define ASCIIDOC8 if you want to format documentation with AsciiDoc 8 # Define ASCIIDOC7 if you want to format documentation with AsciiDoc 7
# #
# Define DOCBOOK_XSL_172 if you want to format man pages with DocBook XSL v1.72 # Define DOCBOOK_XSL_172 if you want to format man pages with DocBook XSL v1.72
# (not v1.73 or v1.71). # (not v1.73 or v1.71).
# #
# Define ASCIIDOC_NO_ROFF if your DocBook XSL escapes raw roff directives # Define ASCIIDOC_ROFF if your DocBook XSL does not escape raw roff directives
# (versions 1.72 and later and 1.68.1 and earlier). # (versions 1.68.1 through v1.72).
# #
# Define GNU_ROFF if your target system uses GNU groff. This forces # Define GNU_ROFF if your target system uses GNU groff. This forces
# apostrophes to be ASCII so that cut&pasting examples to the shell # apostrophes to be ASCII so that cut&pasting examples to the shell
@ -1518,8 +1518,8 @@ ifndef V
endif endif
endif endif
ifdef ASCIIDOC8 ifdef ASCIIDOC7
export ASCIIDOC8 export ASCIIDOC7
endif endif
# Shell quote (do not use $(call) to accommodate ancient setups); # Shell quote (do not use $(call) to accommodate ancient setups);

View File

@ -27,7 +27,7 @@ VPATH = @srcdir@
export exec_prefix mandir export exec_prefix mandir
export srcdir VPATH export srcdir VPATH
ASCIIDOC8=@ASCIIDOC8@ ASCIIDOC7=@ASCIIDOC7@
NEEDS_SSL_WITH_CRYPTO=@NEEDS_SSL_WITH_CRYPTO@ NEEDS_SSL_WITH_CRYPTO=@NEEDS_SSL_WITH_CRYPTO@
NO_OPENSSL=@NO_OPENSSL@ NO_OPENSSL=@NO_OPENSSL@
NO_CURL=@NO_CURL@ NO_CURL=@NO_CURL@

View File

@ -398,21 +398,21 @@ if test -n "$ASCIIDOC"; then
AC_MSG_CHECKING([for asciidoc version]) AC_MSG_CHECKING([for asciidoc version])
asciidoc_version=`$ASCIIDOC --version 2>/dev/null` asciidoc_version=`$ASCIIDOC --version 2>/dev/null`
case "${asciidoc_version}" in case "${asciidoc_version}" in
asciidoc' '8*) asciidoc' '7*)
ASCIIDOC8=YesPlease ASCIIDOC7=YesPlease
AC_MSG_RESULT([${asciidoc_version} > 7]) AC_MSG_RESULT([${asciidoc_version} > 7])
;; ;;
asciidoc' '7*) asciidoc' '8*)
ASCIIDOC8= ASCIIDOC7=
AC_MSG_RESULT([${asciidoc_version}]) AC_MSG_RESULT([${asciidoc_version}])
;; ;;
*) *)
ASCIIDOC8= ASCIIDOC7=
AC_MSG_RESULT([${asciidoc_version} (unknown)]) AC_MSG_RESULT([${asciidoc_version} (unknown)])
;; ;;
esac esac
fi fi
AC_SUBST(ASCIIDOC8) AC_SUBST(ASCIIDOC7)
## Checks for libraries. ## Checks for libraries.