From: Felipe Contreras <felipe.contreras@gmail.com>
To: Jeff King <peff@peff.net>,
"brian m. carlson" <sandals@crustytoothpaste.net>
Cc: git@vger.kernel.org,
"Felipe Contreras" <felipe.contreras@gmail.com>,
"Martin Ågren" <martin.agren@gmail.com>,
"Bagas Sanjaya" <bagasdotme@gmail.com>
Subject: Re: [PATCH 1/2] doc: add an option to have Asciidoctor build man pages directly
Date: Wed, 12 May 2021 14:29:57 -0500 [thread overview]
Message-ID: <609c2cb5a88ba_71bd1208b3@natae.notmuch> (raw)
In-Reply-To: <YJt81neO7zsGz2ah@coredump.intra.peff.net>
Jeff King wrote:
> We seem to have a problem with some escape codes. E.g.:
>
> - of nothing). The other file, git-add--interactive.perl, has 403
> - lines added and 35 lines deleted if you commit what is in the
> - index, but working tree file has further modifications (one
> + of nothing). The other file, git-add--interactive.perl,
> + has 403 lines added and 35 lines deleted if you commit what is in
> + the index, but working tree file has further modifications (one
>
> and:
>
> - Added content is represented by lines beginning with "+". You can
> - prevent staging any addition lines by deleting them.
> + Added content is represented by lines beginning with "+". You
> + can prevent staging any addition lines by deleting them.
>
> which is a pretty bad regression.
Is it? At leat in my system both are rendered correctly.
> The trailer misses the version field:
>
> -Git omitted 1970-01-01 GIT-ADD(1)
> +Git 1970-01-01 GIT-ADD(1)
>
> The "omitted" is part of doc-diff's attempt to reduce noise in the
> diff. But you can see that it's missing entirely in the direct version.
This is indeed a limitation of asciidoctor: manversion is ignored.
I have a fix for that. I'll send it to the asciidoctor project.
> There are lots of whitespace changes for lists. They mostly seem fine
> either way. It also formats numbered lists differently:
>
> - 1. Delete the remote-tracking branches "todo", "html" and
> + (1) Delete the remote-tracking branches "todo", "html" and
> "man". The next fetch or pull will create them again
> unless you configure them not to. See git-fetch(1).
> - 2. Delete the "test" branch even if the "master" branch (or
> + (2) Delete the "test" branch even if the "master" branch (or
> whichever branch is currently checked out) does not have
> all commits from the test branch.
>
> I prefer the original, but could live with the latter (IIRC, this is
> something that can be configured via asciidoctor, but I didn't dig).
It is not a numbered list, it is a reference. I actually prefer the (n)
version.
> Links are a bit harder to read. E.g.:
>
> SEE ALSO
> git-check-ref-format(1), git-fetch(1), git-remote(1), “Understanding
> - history: What is a branch?”[1] in the Git User’s Manual.
> + history: What is <user-manual.html#what-is-a-branch> a branch?”" in the
> + Git User’s Manual.
That indeed looks weird. I'm not exactly sure how to fix that properly.
--
Felipe Contreras
next prev parent reply other threads:[~2021-05-12 20:36 UTC|newest]
Thread overview: 45+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-05-11 22:27 [PATCH] doc: use asciidoctor to build man pages directly Felipe Contreras
2021-05-11 23:26 ` brian m. carlson
2021-05-12 0:58 ` Felipe Contreras
2021-05-12 2:11 ` [PATCH 1/2] doc: add an option to have Asciidoctor " brian m. carlson
2021-05-12 2:11 ` [PATCH 2/2] doc: remove GNU_ROFF option brian m. carlson
2021-05-12 2:18 ` Eric Sunshine
2021-05-12 2:28 ` brian m. carlson
2021-05-12 4:45 ` Felipe Contreras
2021-05-14 0:11 ` brian m. carlson
2021-05-15 13:30 ` Felipe Contreras
2021-05-13 13:11 ` Martin Ågren
2021-05-12 2:48 ` [PATCH 1/2] doc: add an option to have Asciidoctor build man pages directly Bagas Sanjaya
2021-05-12 5:03 ` Felipe Contreras
2021-05-13 23:24 ` brian m. carlson
2021-05-14 12:58 ` Felipe Contreras
2021-05-15 13:25 ` Felipe Contreras
2021-05-12 4:41 ` Felipe Contreras
2021-05-13 23:38 ` brian m. carlson
2021-05-14 19:02 ` Felipe Contreras
2021-05-12 4:43 ` Bagas Sanjaya
2021-05-13 23:54 ` brian m. carlson
2021-05-12 6:22 ` Jeff King
2021-05-12 6:30 ` Jeff King
2021-05-12 6:59 ` Jeff King
2021-05-12 19:29 ` Felipe Contreras [this message]
2021-05-13 17:30 ` Martin Ågren
2021-05-13 22:37 ` Felipe Contreras
2021-05-12 19:53 ` Eric Sunshine
2021-05-12 22:37 ` Jeff King
2021-05-14 15:34 ` Martin Ågren
2021-05-14 0:31 ` [PATCH v2 0/2] Asciidoctor native manpage builds brian m. carlson
2021-05-14 0:31 ` [PATCH v2 1/2] doc: add an option to have Asciidoctor build man pages directly brian m. carlson
2021-05-14 3:58 ` Junio C Hamano
2021-05-14 5:27 ` Jeff King
2021-05-14 20:00 ` Felipe Contreras
2021-05-14 19:55 ` brian m. carlson
2021-05-14 20:52 ` Felipe Contreras
2021-05-14 19:57 ` Felipe Contreras
2021-05-14 19:53 ` Felipe Contreras
2021-05-14 20:17 ` brian m. carlson
2021-05-14 23:31 ` Felipe Contreras
2021-05-14 0:31 ` [PATCH v2 2/2] doc: remove GNU_ROFF option brian m. carlson
2021-05-14 19:07 ` [PATCH v2 0/2] Asciidoctor native manpage builds Felipe Contreras
2021-05-14 20:00 ` brian m. carlson
2021-05-14 21:21 ` 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=609c2cb5a88ba_71bd1208b3@natae.notmuch \
--to=felipe.contreras@gmail.com \
--cc=bagasdotme@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).