From: Felipe Contreras <felipe.contreras@gmail.com>
To: "brian m. carlson" <sandals@crustytoothpaste.net>,
Bagas Sanjaya <bagasdotme@gmail.com>
Cc: Git Users <git@vger.kernel.org>
Subject: Re: [RFC suggestion] Generate manpage directly with Asciidoctor
Date: Fri, 07 May 2021 18:35:21 -0500 [thread overview]
Message-ID: <6095ceb984401_cfc7208b9@natae.notmuch> (raw)
In-Reply-To: <YJWiQH2nf0B14Zy7@camp.crustytoothpaste.net>
brian m. carlson wrote:
> On 2021-05-07 at 06:06:31, Bagas Sanjaya wrote:
> > So completely migrating to Asciidoctor can eliminate xmlto requirement
> > for generating manpage.
> >
> > What do you think about above?
>
> I didn't do this because it makes things very complicated in the
> Makefile and my goal was to minimize the needed changes and divergence.
> I'm not opposed to someone else doing it, but I expect it will be a
> bunch of work.
I don't think it would be that complicated.
This patch seems to do the trick here:
diff --git a/Documentation/Makefile b/Documentation/Makefile
index c2baad0bd8..8fa4896d22 100644
--- a/Documentation/Makefile
+++ b/Documentation/Makefile
@@ -189,6 +189,7 @@ ASCIIDOC_EXTRA += -alitdd='&\#x2d;&\#x2d;'
DBLATEX_COMMON =
XMLTO_EXTRA += --skip-validation
XMLTO_EXTRA += -x manpage.xsl
+TXT_TO_MAN = $(ASCIIDOC_COMMON) -b manpage
endif
SHELL_PATH ?= $(SHELL)
@@ -360,9 +361,16 @@ $(OBSOLETE_HTML): %.html : %.txto asciidoc.conf asciidoctor-extensions.rb GIT-AS
manpage-base-url.xsl: manpage-base-url.xsl.in
$(QUIET_GEN)sed "s|@@MAN_BASE_URL@@|$(MAN_BASE_URL)|" $< > $@
+ifdef TXT_TO_MAN
+%.1 %.5 %.7 : %.txt asciidoc.conf asciidoctor-extensions.rb GIT-ASCIIDOCFLAGS
+ $(QUIET_ASCIIDOC)$(RM) $@+ $@ && \
+ $(TXT_TO_MAN) -o $@+ $< && \
+ mv $@+ $@
+else
%.1 %.5 %.7 : %.xml manpage-base-url.xsl $(wildcard manpage*.xsl)
$(QUIET_XMLTO)$(RM) $@ && \
$(XMLTO) -m $(MANPAGE_XSL) $(XMLTO_EXTRA) man $<
+endif
%.xml : %.txt asciidoc.conf asciidoctor-extensions.rb GIT-ASCIIDOCFLAGS
$(QUIET_ASCIIDOC)$(RM) $@+ $@ && \
I'm sure this can be improved with some knowledge about intermediary
rules.
> It also doesn't help if you're generating more than just the manual
> pages, since generating the PDFs will definitely require xmlto and
> either dblatex or fop. I personally prefer fop over dblatex, but folks
> have different opinions.
Huh? user-manual.pdf seems to require DBLATEX, not XMLTO.
Cheers.
--
Felipe Contreras
next prev parent reply other threads:[~2021-05-07 23:35 UTC|newest]
Thread overview: 38+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-05-07 6:06 [RFC suggestion] Generate manpage directly with Asciidoctor Bagas Sanjaya
2021-05-07 12:02 ` Randall S. Becker
2021-05-07 22:55 ` Felipe Contreras
2021-05-07 22:57 ` brian m. carlson
2021-05-08 1:42 ` Randall S. Becker
2021-05-07 12:27 ` Đoàn Trần Công Danh
2021-05-07 12:47 ` Bagas Sanjaya
2021-05-07 23:03 ` Felipe Contreras
2021-05-08 4:27 ` Bagas Sanjaya
2021-05-07 20:25 ` brian m. carlson
2021-05-07 22:19 ` Jeff King
2021-05-08 4:22 ` Bagas Sanjaya
2021-05-09 8:20 ` Martin Ågren
2021-05-09 18:46 ` Felipe Contreras
2021-05-10 18:43 ` Martin Ågren
2021-05-10 22:24 ` Jeff King
2021-05-11 4:27 ` Felipe Contreras
2021-05-11 6:13 ` Jeff King
2021-05-11 8:03 ` Felipe Contreras
2021-05-11 12:44 ` Ævar Arnfjörð Bjarmason
2021-05-11 19:00 ` Felipe Contreras
2021-05-11 19:09 ` Jeff King
2021-05-11 20:22 ` Felipe Contreras
2021-05-11 23:14 ` brian m. carlson
2021-05-12 1:44 ` Felipe Contreras
2021-05-11 18:45 ` Martin Ågren
2021-05-11 19:07 ` Jeff King
2021-05-11 19:11 ` Martin Ågren
2021-05-11 20:14 ` Felipe Contreras
2021-05-11 9:04 ` Jean-Noël Avila
2021-05-11 18:54 ` Martin Ågren
2021-05-07 23:35 ` Felipe Contreras [this message]
2021-05-07 23:57 ` brian m. carlson
2021-05-08 3:10 ` Jeff King
2021-05-08 3:23 ` Jeff King
2021-05-09 0:22 ` brian m. carlson
2021-05-09 8:29 ` Martin Ågren
2021-05-07 22:48 ` 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=6095ceb984401_cfc7208b9@natae.notmuch \
--to=felipe.contreras@gmail.com \
--cc=bagasdotme@gmail.com \
--cc=git@vger.kernel.org \
--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).