git@vger.kernel.org mailing list mirror (one of many)
 help / color / mirror / code / Atom feed
* [PATCH v2] INSTALL: note on using Asciidoctor to build doc
@ 2021-03-19 11:00 Bagas Sanjaya
  2021-03-19 17:49 ` Junio C Hamano
  0 siblings, 1 reply; 2+ messages in thread
From: Bagas Sanjaya @ 2021-03-19 11:00 UTC (permalink / raw)
  To: git; +Cc: gitster, sandals, Bagas Sanjaya

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


^ permalink raw reply related	[flat|nested] 2+ messages in thread

* Re: [PATCH v2] INSTALL: note on using Asciidoctor to build doc
  2021-03-19 11:00 [PATCH v2] INSTALL: note on using Asciidoctor to build doc Bagas Sanjaya
@ 2021-03-19 17:49 ` Junio C Hamano
  0 siblings, 0 replies; 2+ messages in thread
From: Junio C Hamano @ 2021-03-19 17:49 UTC (permalink / raw)
  To: Bagas Sanjaya; +Cc: git, sandals

Bagas Sanjaya <bagasdotme@gmail.com> writes:

> Note on using Asciidoctor to build documentation suite.
> ...
> -   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

Thanks.

^ permalink raw reply	[flat|nested] 2+ messages in thread

end of thread, other threads:[~2021-03-19 17:50 UTC | newest]

Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-03-19 11:00 [PATCH v2] INSTALL: note on using Asciidoctor to build doc Bagas Sanjaya
2021-03-19 17:49 ` Junio C Hamano

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).