git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Bagas Sanjaya <bagasdotme@gmail.com>
To: git@vger.kernel.org
Cc: gitster@pobox.com, Bagas Sanjaya <bagasdotme@gmail.com>
Subject: [PATCH] INSTALL: note on using Asciidoctor to build doc
Date: Thu, 18 Mar 2021 18:23:39 +0700	[thread overview]
Message-ID: <20210318112339.38474-1-bagasdotme@gmail.com> (raw)

Note on using Asciidoctor to build documentation suite, with example
for build documentation in html format.

Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
 INSTALL | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/INSTALL b/INSTALL
index 8474ad01bf..3a67f335e0 100644
--- a/INSTALL
+++ b/INSTALL
@@ -239,3 +239,9 @@ Issues of note:
          http://www.oasis-open.org/docbook/xml/4.5/xsl/current \
          /usr/share/sgml/docbook/xml-dtd-4.5 \
      /etc/xml/catalog
+
+ - Alternatively, if you have Asciidoctor installed (requires Ruby),
+   you can pass USE_ASCIIDOCTOR=1 to use it to build documentation.
+   For example, to build documentation in html format:
+
+       $ make USE_ASCIIDOCTOR=1 html
-- 
2.25.1


             reply	other threads:[~2021-03-18 11:24 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-03-18 11:23 Bagas Sanjaya [this message]
2021-03-18 20:05 ` [PATCH] INSTALL: note on using Asciidoctor to build doc Junio C Hamano
2021-03-19  0:07   ` brian m. carlson

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20210318112339.38474-1-bagasdotme@gmail.com \
    --to=bagasdotme@gmail.com \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body. 
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).