Skip to content

Commit 4c7100a

Browse files
committed
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 <[email protected]>
1 parent 66e41f7 commit 4c7100a

File tree

5 files changed

+14
-4
lines changed

5 files changed

+14
-4
lines changed

Documentation/Makefile

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,9 @@ man7dir=$(mandir)/man7
3737

3838
ASCIIDOC=asciidoc
3939
ASCIIDOC_EXTRA =
40+
ifdef ASCIIDOC8
41+
ASCIIDOC_EXTRA += -a asciidoc7compatible
42+
endif
4043
INSTALL?=install
4144
DOC_REF = origin/man
4245

Documentation/asciidoc.conf

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,8 @@
88
# the command.
99

1010
[attributes]
11-
caret=^
11+
plus=&#43;
12+
caret=&#94;
1213
startsb=&#91;
1314
endsb=&#93;
1415
tilde=&#126;

Documentation/git-cvsexportcommit.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ $ git-cvsexportcommit -v <commit-sha1>
7373
$ cvs commit -F .mgs <files>
7474
------------
7575

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::
7777
+
7878
------------
7979
$ export GIT_DIR=~/project/.git

Documentation/user-manual.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2757,8 +2757,8 @@ As a result, the general consistency of an object can always be tested
27572757
independently of the contents or the type of the object: all objects can
27582758
be validated by verifying that (a) their hashes match the content of the
27592759
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>.
27622762

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

Makefile

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -107,6 +107,8 @@ all::
107107
# Define USE_STDEV below if you want git to care about the underlying device
108108
# change being considered an inode change from the update-cache perspective.
109109
#
110+
# Define ASCIIDOC8 if you want to format documentation with AsciiDoc 8
111+
#
110112
# Define NO_PERL_MAKEMAKER if you cannot use Makefiles generated by perl's
111113
# MakeMaker (e.g. using ActiveState under Cygwin).
112114
#
@@ -689,6 +691,10 @@ ifndef V
689691
endif
690692
endif
691693

694+
ifdef ASCIIDOC8
695+
export ASCIIDOC8
696+
endif
697+
692698
# Shell quote (do not use $(call) to accommodate ancient setups);
693699

694700
SHA1_HEADER_SQ = $(subst ','\'',$(SHA1_HEADER))

0 commit comments

Comments
 (0)