Browse Source

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>
maint
Junio C Hamano 18 years ago
parent
commit
4c7100a9f4
  1. 3
      Documentation/Makefile
  2. 3
      Documentation/asciidoc.conf
  3. 2
      Documentation/git-cvsexportcommit.txt
  4. 4
      Documentation/user-manual.txt
  5. 6
      Makefile

3
Documentation/Makefile

@ -37,6 +37,9 @@ man7dir=$(mandir)/man7 @@ -37,6 +37,9 @@ man7dir=$(mandir)/man7

ASCIIDOC=asciidoc
ASCIIDOC_EXTRA =
ifdef ASCIIDOC8
ASCIIDOC_EXTRA += -a asciidoc7compatible
endif
INSTALL?=install
DOC_REF = origin/man


3
Documentation/asciidoc.conf

@ -8,7 +8,8 @@ @@ -8,7 +8,8 @@
# the command.

[attributes]
caret=^
plus=&#43;
caret=&#94;
startsb=&#91;
endsb=&#93;
tilde=&#126;

2
Documentation/git-cvsexportcommit.txt

@ -73,7 +73,7 @@ $ git-cvsexportcommit -v <commit-sha1> @@ -73,7 +73,7 @@ $ git-cvsexportcommit -v <commit-sha1>
$ 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

4
Documentation/user-manual.txt

@ -2757,8 +2757,8 @@ As a result, the general consistency of an object can always be tested @@ -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
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

6
Makefile

@ -107,6 +107,8 @@ all:: @@ -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 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).
#
@ -689,6 +691,10 @@ ifndef V @@ -689,6 +691,10 @@ ifndef V
endif
endif

ifdef ASCIIDOC8
export ASCIIDOC8
endif

# Shell quote (do not use $(call) to accommodate ancient setups);

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

Loading…
Cancel
Save