From: Felipe Contreras <firstname.lastname@example.org>
To: "Martin Ågren" <email@example.com>,
"Felipe Contreras" <firstname.lastname@example.org>
Cc: "Git Mailing List" <email@example.com>,
"brian m . carlson" <firstname.lastname@example.org>,
"Jeff King" <email@example.com>,
"Ævar Arnfjörð Bjarmason" <firstname.lastname@example.org>,
"Bagas Sanjaya" <email@example.com>
Subject: Re: [PATCH 04/11] doc: use asciidoctor to build man pages directly
Date: Fri, 14 May 2021 15:26:14 -0500 [thread overview]
Message-ID: <firstname.lastname@example.org> (raw)
Martin Ågren wrote:
> On Fri, 14 May 2021 at 14:14, Felipe Contreras
> <email@example.com> wrote:
> > There's no need to use xmlto to build the man pages when modern
> > asciidoctor can do it by itself.
> > This new mode will be active only when USE_ASCIIDOCTOR is set.
> May I suggest incorporating something more like brian's patch here ,
> so that there's a separate knob for this thing?
Sure. Do you agree with the name? (USE_ASCIIDOCTOR_MANPAGE)
> The commit message is short on details and makes it sound like this is
> it, we're done. But then there are several patches to fix up things.
> Which is a good approach, so that this patch doesn't need to do several
> things at once. This commit message could say something about it, e.g.,
> The doc-diff here [which doc-diff? see below] is a XYZ-line diff.
> Large parts of this difference will be addressed in the following
Right. I'll include that.
> About the use of doc-diff: If this commit introduces a new knob rather
> than taking over USE_ASCIIDOCTOR=Yes, the next patch could be Peff's
> patch to doc-diff that compares the two asciidoctor approaches , and
> then the next few patches could diff between them. That would get the
> asciidoc-vs-asciidoctor differences out of the way, so you can focus on
You mean . I think that belongs on the same patch. It's important
that if we do have a new switch, doc-diff is able to use it.
However, I personally don't need such switch, I want to compare
I want to see *all* the diffs.
> With a separate knob, it would feel like a lot easier decision to take
> something like this. There are over 11000 lines in the doc-diff after
> applying your series, and there's the missing boldness for literals.
> Maybe those differences are all great (I would be missing the bold
> literals, though). If this series doesn't affect someone using
> "vanilla" USE_ASCIIDOCTOR=Yes, we could let this thing cook in master
> and work incrementally on top.
I did notice the missing boldness for literals, and I know how to fix
it. It's a small hack. I also noticed a few small rendering issues.
But from my point of view after my patches this is 98% done. Most of the
remaining diffs are fine, for example:
-GIT-CHECK-REF-FOR(1) Git Manual GIT-CHECK-REF-FOR(1)
+GIT-CHECK-REF-FORMAT(1) Git Manual GIT-CHECK-REF-FORMAT(1)
That's clearly a bug in asciidoc+docbook. Others are things asciidoctor
renders better, and most are whitespace noise.
next prev parent reply other threads:[~2021-05-14 20:26 UTC|newest]
Thread overview: 25+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-05-14 12:14 [PATCH 00/11] doc: asciidoctor: direct man page creation and fixes Felipe Contreras
2021-05-14 12:14 ` [PATCH 01/11] doc: allow the user to provide ASCIIDOC_EXTRA Felipe Contreras
2021-05-15 9:32 ` Jeff King
2021-05-15 9:39 ` Jeff King
2021-05-15 12:13 ` Felipe Contreras
2021-05-17 8:57 ` Jeff King
2021-05-17 10:53 ` Felipe Contreras
2021-05-17 11:39 ` Jeff King
2021-05-17 16:50 ` Felipe Contreras
2021-05-14 12:14 ` [PATCH 02/11] doc: doc-diff: allow more than one flag Felipe Contreras
2021-05-15 9:37 ` Jeff King
2021-05-15 12:11 ` Felipe Contreras
2021-05-14 12:14 ` [PATCH 03/11] doc: doc-diff: set docdate manually Felipe Contreras
2021-05-14 15:43 ` Martin Ågren
2021-05-14 20:33 ` Felipe Contreras
2021-05-14 12:14 ` [PATCH 04/11] doc: use asciidoctor to build man pages directly Felipe Contreras
2021-05-14 15:38 ` Martin Ågren
2021-05-14 20:26 ` Felipe Contreras [this message]
2021-05-14 12:14 ` [PATCH 05/11] doc: asciidoctor: add linkgit macros in man pages Felipe Contreras
2021-05-14 12:14 ` [PATCH 06/11] doc: join mansource and manversion Felipe Contreras
2021-05-14 12:14 ` [PATCH 07/11] doc: add man pages workaround for asciidoctor Felipe Contreras
2021-05-14 12:14 ` [PATCH 08/11] doc: asciidoctor: add hack for xrefs Felipe Contreras
2021-05-14 12:14 ` [PATCH 09/11] doc: asciidoctor: add hack to improve links Felipe Contreras
2021-05-14 12:14 ` [PATCH 10/11] doc: asciidoctor: add support for baseurl Felipe Contreras
2021-05-14 12:14 ` [PATCH 11/11] doc: asciidoctor: cleanup man page hack Felipe Contreras
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:
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 \
* 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
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).