From: Bagas Sanjaya <bagasdotme@gmail.com>
To: git@vger.kernel.org
Cc: "brian m . carlson" <sandals@crustytoothpaste.net>,
"Felipe Contreras" <felipe.contreras@gmail.com>,
"Martin Ågren" <martin.agren@gmail.com>,
"Jeff King" <peff@peff.net>,
"Bagas Sanjaya" <bagasdotme@gmail.com>
Subject: [PATCH] INSTALL: note about make man with Asciidoctor backend
Date: Wed, 12 May 2021 13:41:29 +0700 [thread overview]
Message-ID: <20210512064128.15411-1-bagasdotme@gmail.com> (raw)
"make man" can now be also done with Asciidoctor's manpage backend
instead of asciidoc+xmlto.
Update INSTALL to reflect that.
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
This patch is based on "doc: add an option to have Asciidoctor build
man pages directly" series by brian m. carlson [1]. It can be added
to that series.
[1]:
https://lore.kernel.org/git/20210512021138.63598-1-sandals@crustytoothpaste.net/
INSTALL | 10 ++++++++--
1 file changed, 8 insertions(+), 2 deletions(-)
diff --git a/INSTALL b/INSTALL
index 66389ce059..89e31566c3 100644
--- a/INSTALL
+++ b/INSTALL
@@ -184,8 +184,9 @@ Issues of note:
"make doc" builds documentation in man and html formats; there are
also "make man", "make html" and "make info". Note that "make html"
- requires asciidoc, but not xmlto. "make man" (and thus make doc)
- requires both.
+ requires asciidoc, but not xmlto. "make man" requires either
+ Asciidoctor or asciidoc+xmlto. "make doc" requires both asciidoc
+ and xmlto.
"make install-doc" installs documentation in man format only; there
are also "make install-man", "make install-html" and "make
@@ -201,6 +202,11 @@ Issues of note:
use Asciidoctor (requires Ruby) by passing USE_ASCIIDOCTOR=YesPlease
to make. You need at least Asciidoctor version 1.5.
+ You can also do "make man" using Asciidoctor's manpage backend in
+ place of xmlto by passing USE_ASCIIDOCTOR_MANPAGE=YesPlease. Version
+ 2.0 or later is highly recommended, as these version properly handle
+ apostrophes.
+
There are also "make quick-install-doc", "make quick-install-man"
and "make quick-install-html" which install preformatted man pages
and html documentation. To use these build targets, you need to
--
2.25.1
next reply other threads:[~2021-05-12 6:42 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-05-12 6:41 Bagas Sanjaya [this message]
2021-05-12 7:00 ` [PATCH] INSTALL: note about make man with Asciidoctor backend Junio C Hamano
2021-05-12 8:13 ` Felipe Contreras
2021-05-13 13:41 ` Martin Ågren
2021-05-13 20:23 ` Junio C Hamano
2021-06-02 20:07 ` Felipe Contreras
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=20210512064128.15411-1-bagasdotme@gmail.com \
--to=bagasdotme@gmail.com \
--cc=felipe.contreras@gmail.com \
--cc=git@vger.kernel.org \
--cc=martin.agren@gmail.com \
--cc=peff@peff.net \
--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).