diff options
| author | Junio C Hamano <gitster@pobox.com> | 2007-06-18 10:43:34 +0200 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2007-06-21 01:22:09 +0200 |
| commit | a90918e8244d98862d0183de949fe9764c40e4d5 (patch) | |
| tree | 6484b0323bd583894c4ef67a230f3fbd81cec23f /INSTALL | |
| parent | cvsserver: Actually implement --export-all (diff) | |
| download | git-a90918e8244d98862d0183de949fe9764c40e4d5.tar.xz git-a90918e8244d98862d0183de949fe9764c40e4d5.zip | |
INSTALL: explain how to build documentation
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'INSTALL')
| -rw-r--r-- | INSTALL | 14 |
1 files changed, 10 insertions, 4 deletions
@@ -89,10 +89,16 @@ Issues of note: will include them. Note that config.mak is not distributed; the name is reserved for local settings. - - To build and install documentation suite, you need to have the - asciidoc/xmlto toolchain. Alternatively, pre-formatted - documentation are available in "html" and "man" branches of the git - repository itself. For example, you could: + - To build and install documentation suite, you need to have + the asciidoc/xmlto toolchain. Because not many people are + inclined to install the tools, the default build target + ("make all") does _not_ build them. The documentation is + written for AsciiDoc 7, but "make ASCIIDOC8=YesPlease doc" + will let you format with AsciiDoc 8. + + Alternatively, pre-formatted documentation are available in + "html" and "man" branches of the git repository itself. For + example, you could: $ mkdir manual && cd manual $ git init |