From: Bagas Sanjaya <bagasdotme@gmail.com>
To: git@vger.kernel.org
Cc: gitster@pobox.com, sandals@crustytoothpaste.net,
Bagas Sanjaya <bagasdotme@gmail.com>
Subject: [PATCH v2] INSTALL: note on using Asciidoctor to build doc
Date: Fri, 19 Mar 2021 18:00:45 +0700 [thread overview]
Message-ID: <20210319110045.15987-1-bagasdotme@gmail.com> (raw)
Note on using Asciidoctor to build documentation suite.
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
Changes from v1:
* Apply suggestions from Junio:
* Place on the same paragraph as asciidoc version requirement
* Reword
* Mention Asciidoctor minimum version required for building to 1.5
(as suggested by brian m. carlson)
INSTALL | 4 +++-
1 file changed, 3 insertions(+), 1 deletion(-)
diff --git a/INSTALL b/INSTALL
index 8474ad01bf..66389ce059 100644
--- 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
--
2.25.1
next reply other threads:[~2021-03-19 11:01 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-03-19 11:00 Bagas Sanjaya [this message]
2021-03-19 17:49 ` [PATCH v2] INSTALL: note on using Asciidoctor to build doc Junio C Hamano
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
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20210319110045.15987-1-bagasdotme@gmail.com \
--to=bagasdotme@gmail.com \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=sandals@crustytoothpaste.net \
/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.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
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 read-only IMAP folder(s) and NNTP newsgroup(s).