]> git.ipfire.org Git - thirdparty/git.git/commitdiff
INSTALL: note on using Asciidoctor to build doc
authorBagas Sanjaya <bagasdotme@gmail.com>
Fri, 19 Mar 2021 11:00:45 +0000 (18:00 +0700)
committerJunio C Hamano <gitster@pobox.com>
Fri, 19 Mar 2021 17:49:20 +0000 (10:49 -0700)
Note on using Asciidoctor to build documentation suite.

Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
INSTALL

diff --git a/INSTALL b/INSTALL
index 8474ad01bf9db87ec293bd6d5cd2ed7706c56914..66389ce05915d776e5c8ff49aea40e20bc40eb62 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -197,7 +197,9 @@ Issues of note:
    Building and installing the pdf file additionally requires
    dblatex.  Version >= 0.2.7 is known to work.
 
-   All formats require at least asciidoc 8.4.1.
+   All formats require at least asciidoc 8.4.1. Alternatively, you can
+   use Asciidoctor (requires Ruby) by passing USE_ASCIIDOCTOR=YesPlease
+   to make. You need at least Asciidoctor version 1.5.
 
    There are also "make quick-install-doc", "make quick-install-man"
    and "make quick-install-html" which install preformatted man pages