Skip to content

Commit a90918e

Browse files
committed
INSTALL: explain how to build documentation
Signed-off-by: Junio C Hamano <[email protected]>
1 parent 3c74026 commit a90918e

File tree

1 file changed

+10
-4
lines changed

1 file changed

+10
-4
lines changed

INSTALL

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -89,10 +89,16 @@ Issues of note:
8989
will include them. Note that config.mak is not distributed;
9090
the name is reserved for local settings.
9191

92-
- To build and install documentation suite, you need to have the
93-
asciidoc/xmlto toolchain. Alternatively, pre-formatted
94-
documentation are available in "html" and "man" branches of the git
95-
repository itself. For example, you could:
92+
- To build and install documentation suite, you need to have
93+
the asciidoc/xmlto toolchain. Because not many people are
94+
inclined to install the tools, the default build target
95+
("make all") does _not_ build them. The documentation is
96+
written for AsciiDoc 7, but "make ASCIIDOC8=YesPlease doc"
97+
will let you format with AsciiDoc 8.
98+
99+
Alternatively, pre-formatted documentation are available in
100+
"html" and "man" branches of the git repository itself. For
101+
example, you could:
96102

97103
$ mkdir manual && cd manual
98104
$ git init

0 commit comments

Comments
 (0)