Skip to content

Commit

Permalink
Merge branch 'jk/asciidoc-update'
Browse files Browse the repository at this point in the history
* jk/asciidoc-update:
  docs: default to more modern toolset
  • Loading branch information
gitster committed Dec 13, 2010
2 parents 73fd7f3 + 79c461d commit 0d181cb
Show file tree
Hide file tree
Showing 6 changed files with 27 additions and 29 deletions.
23 changes: 8 additions & 15 deletions Documentation/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -63,35 +63,28 @@ endif

#
# For asciidoc ...
# -7.1.2, no extra settings are needed.
# 8.0-, set ASCIIDOC8.
# -7.1.2, set ASCIIDOC7
# 8.0-, no extra settings are needed
#

#
# For docbook-xsl ...
# -1.68.1, set ASCIIDOC_NO_ROFF? (based on changelog from 1.73.0)
# 1.69.0, no extra settings are needed?
# -1.68.1, no extra settings are needed?
# 1.69.0, set ASCIIDOC_ROFF?
# 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.73.0-, set ASCIIDOC_NO_ROFF
# 1.73.0-, no extra settings are needed
#

#
# 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
ifndef ASCIIDOC7
ASCIIDOC_EXTRA += -a asciidoc7compatible -a no-inline-literal
endif
ifdef DOCBOOK_XSL_172
ASCIIDOC_EXTRA += -a git-asciidoc-no-roff
MANPAGE_XSL = manpage-1.72.xsl
else
ifdef ASCIIDOC_NO_ROFF
ifndef ASCIIDOC_ROFF
# docbook-xsl after 1.72 needs the regular XSL, but will not
# pass-thru raw roff codes from asciidoc.conf, so turn them off.
ASCIIDOC_EXTRA += -a git-asciidoc-no-roff
Expand Down
4 changes: 4 additions & 0 deletions Documentation/RelNotes/1.7.4.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@ Git v1.7.4 Release Notes (draft)
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
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
Expand Down
5 changes: 3 additions & 2 deletions INSTALL
Original file line number Diff line number Diff line change
Expand Up @@ -122,8 +122,9 @@ Issues of note:
Building and installing the pdf file additionally requires
dblatex. Version 0.2.7 with asciidoc >= 8.2.7 is known to work.

The documentation is written for AsciiDoc 7, but "make
ASCIIDOC8=YesPlease doc" will let you format with AsciiDoc 8.
The documentation is written for AsciiDoc 7, but by default
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
"html" and "man" branches of the git repository itself. For
Expand Down
10 changes: 5 additions & 5 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -167,13 +167,13 @@ all::
# 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.
#
# 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
# (not v1.73 or v1.71).
#
# Define ASCIIDOC_NO_ROFF if your DocBook XSL escapes raw roff directives
# (versions 1.72 and later and 1.68.1 and earlier).
# Define ASCIIDOC_ROFF if your DocBook XSL does not escape raw roff directives
# (versions 1.68.1 through v1.72).
#
# Define GNU_ROFF if your target system uses GNU groff. This forces
# apostrophes to be ASCII so that cut&pasting examples to the shell
Expand Down Expand Up @@ -1579,8 +1579,8 @@ ifndef V
endif
endif

ifdef ASCIIDOC8
export ASCIIDOC8
ifdef ASCIIDOC7
export ASCIIDOC7
endif

# Shell quote (do not use $(call) to accommodate ancient setups);
Expand Down
2 changes: 1 addition & 1 deletion config.mak.in
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ VPATH = @srcdir@
export exec_prefix mandir
export srcdir VPATH

ASCIIDOC8=@ASCIIDOC8@
ASCIIDOC7=@ASCIIDOC7@
NEEDS_SSL_WITH_CRYPTO=@NEEDS_SSL_WITH_CRYPTO@
NO_OPENSSL=@NO_OPENSSL@
NO_CURL=@NO_CURL@
Expand Down
12 changes: 6 additions & 6 deletions configure.ac
Original file line number Diff line number Diff line change
Expand Up @@ -398,21 +398,21 @@ if test -n "$ASCIIDOC"; then
AC_MSG_CHECKING([for asciidoc version])
asciidoc_version=`$ASCIIDOC --version 2>/dev/null`
case "${asciidoc_version}" in
asciidoc' '8*)
ASCIIDOC8=YesPlease
asciidoc' '7*)
ASCIIDOC7=YesPlease
AC_MSG_RESULT([${asciidoc_version} > 7])
;;
asciidoc' '7*)
ASCIIDOC8=
asciidoc' '8*)
ASCIIDOC7=
AC_MSG_RESULT([${asciidoc_version}])
;;
*)
ASCIIDOC8=
ASCIIDOC7=
AC_MSG_RESULT([${asciidoc_version} (unknown)])
;;
esac
fi
AC_SUBST(ASCIIDOC8)
AC_SUBST(ASCIIDOC7)


## Checks for libraries.
Expand Down

0 comments on commit 0d181cb

Please sign in to comment.