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>
Junio C Hamano committed
Jun 14, 2007 at 22:20 UTC
4c7100a9f438c281c18c800b450ea12045d22d62
5 files changed
+14
-4
Documentation/Makefile
+3
@@ -37,6 +37,9 @@ man7dir=$(mandir)/man7
37
38
ASCIIDOC=asciidoc
39
ASCIIDOC_EXTRA =
40
+ifdef ASCIIDOC8
41
+ASCIIDOC_EXTRA += -a asciidoc7compatible
42
+endif
43
INSTALL?=install
44
DOC_REF = origin/man
45
Documentation/asciidoc.conf
+2
-1
@@ -8,7 +8,8 @@
8
# the command.
9
10
[attributes]
11
-caret=^
11
+plus=+
12
+caret=^
13
startsb=[
14
endsb=]
15
tilde=~
Documentation/git-cvsexportcommit.txt
+1
-1
@@ -73,7 +73,7 @@ $ git-cvsexportcommit -v <commit-sha1>
73
$ cvs commit -F .mgs <files>
74
------------
75
76
-Merge pending patches into CVS automatically -- only if you really know what you are doing ::
76
+Merge pending patches into CVS automatically -- only if you really know what you are doing::
77
+
78
------------
79
$ export GIT_DIR=~/project/.git
Documentation/user-manual.txt
+2
-2
@@ -2757,8 +2757,8 @@ As a result, the general consistency of an object can always be tested
2757
independently of the contents or the type of the object: all objects can
2758
be validated by verifying that (a) their hashes match the content of the
2759
file and (b) the object successfully inflates to a stream of bytes that
2760
-forms a sequence of <ascii type without space> + <space> + <ascii decimal
2761
-size> + <byte\0> + <binary object data>.
2760
+forms a sequence of <ascii type without space> {plus} <space> {plus} <ascii decimal
2761
+size> {plus} <byte\0> {plus} <binary object data>.
2762
2763
The structured objects can further have their structure and
2764
connectivity to other objects verified. This is generally done with
Makefile
+6
@@ -107,6 +107,8 @@ all::
107
# Define USE_STDEV below if you want git to care about the underlying device
108
# change being considered an inode change from the update-cache perspective.
109
#
110
+# Define ASCIIDOC8 if you want to format documentation with AsciiDoc 8
111
+#
112
# Define NO_PERL_MAKEMAKER if you cannot use Makefiles generated by perl's
113
# MakeMaker (e.g. using ActiveState under Cygwin).
114
#
@@ -689,6 +691,10 @@ ifndef V
691
endif
692
endif
693
694
+ifdef ASCIIDOC8
695
+ export ASCIIDOC8
696
+endif
697
+
698
# Shell quote (do not use $(call) to accommodate ancient setups);
699
700
SHA1_HEADER_SQ = $(subst ','\'',$(SHA1_HEADER))