Documentation: adjust to AsciiDoc 8

It turns out that the attribute definition we have had for a
long time to hide "^" character from AsciiDoc 7 was not honored
by AsciiDoc 8 even under "-a asciidoc7compatible" mode.  There is
a similar breakage with the "compatible" mode with + characters.

The double colon at the end of definition list term needs
to be attached to the term, without a whitespace.  After this
minimum fixups, AsciiDoc 8 (I used 8.2.1 on Debian) with
compatibility mode seems to produce reasonably good results.

Signed-off-by: Junio C Hamano <gitster@pobox.com>

diff --git a/Documentation/Makefile b/Documentation/Makefile
index 9cef4806d1a51bac670ebe192a4482fde95c9013..4edf788c3a8ddf39638028447ca78624305da778 100644 (file)
--- a/Documentation/Makefile
+++ b/Documentation/Makefile
@@ -37,6 +37,9 @@ man7dir=$(mandir)/man7
 
 ASCIIDOC=asciidoc
 ASCIIDOC_EXTRA =
 
 ASCIIDOC=asciidoc
 ASCIIDOC_EXTRA =

+ifdef ASCIIDOC8
+ASCIIDOC_EXTRA += -a asciidoc7compatible
+endif

 INSTALL?=install
 DOC_REF = origin/man
 
 INSTALL?=install
 DOC_REF = origin/man
 

diff --git a/Documentation/asciidoc.conf b/Documentation/asciidoc.conf
index 60e15ba3494b93f2c956356d3d5fd905385d0c1f..e061f73867bb4d582fb88907b0a11fb2bf7816fd 100644 (file)
--- a/Documentation/asciidoc.conf
+++ b/Documentation/asciidoc.conf
@@ -8,7 +8,8 @@
 # the command.
 
 [attributes]
 # the command.
 
 [attributes]

-caret=^
+plus=+
+caret=^

 startsb=[
 endsb=]
 tilde=~
 startsb=[
 endsb=]
 tilde=~

diff --git a/Documentation/git-cvsexportcommit.txt b/Documentation/git-cvsexportcommit.txt
index fd7f54093fc3d0a85126a0826affb712096aa144..f3590dee04f801f79cf6400a30a0d9c6f4169154 100644 (file)
--- a/Documentation/git-cvsexportcommit.txt
+++ b/Documentation/git-cvsexportcommit.txt
@@ -73,7 +73,7 @@ $ git-cvsexportcommit -v <commit-sha1>
 $ cvs commit -F .mgs <files> 
 ------------
 
 $ cvs commit -F .mgs <files> 
 ------------
 

-Merge pending patches into CVS automatically -- only if you really know what you are doing ::
+Merge pending patches into CVS automatically -- only if you really know what you are doing::

 +
 ------------
 $ export GIT_DIR=~/project/.git
 +
 ------------
 $ export GIT_DIR=~/project/.git

diff --git a/Documentation/user-manual.txt b/Documentation/user-manual.txt
index 780f0f0ee64f8ea20e0a4eafe2db039194819fed..714e6a9942ab2dc910ff8d6c3388f75a713e873e 100644 (file)
--- a/Documentation/user-manual.txt
+++ b/Documentation/user-manual.txt
@@ -2757,8 +2757,8 @@ As a result, the general consistency of an object can always be tested
 independently of the contents or the type of the object: all objects can
 be validated by verifying that (a) their hashes match the content of the
 file and (b) the object successfully inflates to a stream of bytes that
 independently of the contents or the type of the object: all objects can
 be validated by verifying that (a) their hashes match the content of the
 file and (b) the object successfully inflates to a stream of bytes that

-forms a sequence of <ascii type without space> + <space> + <ascii decimal
-size> + <byte\0> + <binary object data>. 
+forms a sequence of <ascii type without space> {plus} <space> {plus} <ascii decimal
+size> {plus} <byte\0> {plus} <binary object data>.

 
 The structured objects can further have their structure and
 connectivity to other objects verified. This is generally done with
 
 The structured objects can further have their structure and
 connectivity to other objects verified. This is generally done with

diff --git a/Makefile b/Makefile
index 862c2682aa39b424bb3349e4e885409c94a0df42..50e7bb39b5d661d6339afa53e57674146ee45176 100644 (file)
--- a/Makefile
+++ b/Makefile
@@ -107,6 +107,8 @@ all::
 # Define USE_STDEV below if you want git to care about the underlying device
 # change being considered an inode change from the update-cache perspective.
 #
 # Define USE_STDEV below if you want git to care about the underlying device
 # change being considered an inode change from the update-cache perspective.
 #

+# Define ASCIIDOC8 if you want to format documentation with AsciiDoc 8
+#

 # Define NO_PERL_MAKEMAKER if you cannot use Makefiles generated by perl's
 # MakeMaker (e.g. using ActiveState under Cygwin).
 #
 # Define NO_PERL_MAKEMAKER if you cannot use Makefiles generated by perl's
 # MakeMaker (e.g. using ActiveState under Cygwin).
 #


@@ -689,6 +691,10 @@ ifndef V
 endif
 endif
 
 endif
 endif
 

+ifdef ASCIIDOC8
+       export ASCIIDOC8
+endif
+

 # Shell quote (do not use $(call) to accommodate ancient setups);
 
 SHA1_HEADER_SQ = $(subst ','\'',$(SHA1_HEADER))
 # Shell quote (do not use $(call) to accommodate ancient setups);
 
 SHA1_HEADER_SQ = $(subst ','\'',$(SHA1_HEADER))