Re: [PATCH] INSTALL: note on using Asciidoctor to build doc
- From
Junio C Hamano <gitster@pobox.com>
- Date
- Mar 18, 2021, 20:05 UTC
- Message-ID
- <xmqqwnu4rzw0.fsf@gitster.g>
- In-Reply-To
- <20210318112339.38474-1-bagasdotme@gmail.com>
Bagas Sanjaya <bagasdotme@gmail.com> writes:
Show 7 quoted lines
> 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(+)
Thanks. This patch means well, but ...
Show 14 quoted lines
> 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
Mention of asciidoctor may be a good idea, but this gives an impression that everything between this new paragraph and the line that says
"All formats require at least asciidoc 8.4.1."
are irrelevant if you choose to use asciidoctor. Is that really the case (e.g. is docbook-xsl unneeded with asciidoctor)?
If not, then wouldn't it make the result easier to follow if you did something along this line instead?
INSTALL | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-)
diff --git c/INSTALL w/INSTALL index 9ba33e6a14..d8e75a7c59 100644 --- c/INSTALL +++ w/INSTALL @@ -198,7 +198,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 by passing USE_ASCIIDOCTOR=YesPlease to make. + You need at least asciidoctor verison X.Y.Z. There are also "make quick-install-doc", "make quick-install-man" and "make quick-install-html" which install preformatted man pages