From: "Martin Ågren" <martin.agren@gmail.com>
To: "Ævar Arnfjörð Bjarmason" <avarab@gmail.com>
Cc: "Git Mailing List" <git@vger.kernel.org>,
"Paweł Samoraj" <samoraj.pawel@gmail.com>,
"Jeff King" <peff@peff.net>
Subject: Re: [PATCH 1/2] git-reset.txt: render tables correctly under Asciidoctor
Date: Wed, 28 Nov 2018 21:37:19 +0100 [thread overview]
Message-ID: <CAN0heSob+Ac4BvM-vuKvPZKxrTW53-d91a55NX5kC7ZyNXntWQ@mail.gmail.com> (raw)
In-Reply-To: <877egxyojp.fsf@evledraar.gmail.com>
On Wed, 28 Nov 2018 at 20:45, Ævar Arnfjörð Bjarmason <avarab@gmail.com> wrote:
> On Wed, Nov 28 2018, Martin Ågren wrote:
>
> > Asciidoctor removes the indentation of each line in these tables, so the
> > last lines of each table have a completely broken alignment.
>
> Earlier I was trying to get the Documentation/doc-diff script to diff
> the asciidoc and asciidoctor docs without much success (hadn't used it
> before, just hacking the Makefile to turn on asciidoctor yielded syntax
> errors or something).
>
> Is something like that a thing we could make into a regression test?
Interesting idea. I just tried a gross hack:
* Use `make --always-make ... install-man` in doc-diff.
* ./doc-diff -f HEAD HEAD # note -f
* Add empty commit and tweak config.mak
* ./doc-diff HEAD^ HEAD # note no -f
There are lots of irrelevant differences in the headers and footers,
which is a bit unfortunate.
Also, lots of annoying differences originating in Asciidoctor's
inclination to render a space after linkgit:foo . There are those
differences themselves, obviously, but also follow-on differences such
as entire paragraphs that wrap differently.
I could spot a few things that should be fixable on our side, but on a
quick skimming, I didn't spot too many "huge" differences, which feels
good. The one which this patch fixes, obviously, and there's some work
to do in git-status.txt and git-column.txt (at least).
Tacking on `--stat` to the call to `git diff --no-index` singles out
git-config.txt, but it seems like lots of small or maybe even irrelevant
differences, plus lots of spaces around linkgit: , as already mentioned.
Martin
next prev parent reply other threads:[~2018-11-28 20:37 UTC|newest]
Thread overview: 7+ messages / expand[flat|nested] mbox.gz Atom feed top
2018-11-28 11:40 Broken alignment in git-reset docs Paweł Samoraj
2018-11-28 12:02 ` Martin Ågren
2018-11-28 19:02 ` [PATCH 0/2] " Martin Ågren
2018-11-28 19:02 ` [PATCH 1/2] git-reset.txt: render tables correctly under Asciidoctor Martin Ågren
2018-11-28 19:44 ` Ævar Arnfjörð Bjarmason
2018-11-28 20:37 ` Martin Ågren [this message]
2018-11-28 19:02 ` [PATCH 2/2] git-reset.txt: render literal examples as monospace Martin Ågren
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=CAN0heSob+Ac4BvM-vuKvPZKxrTW53-d91a55NX5kC7ZyNXntWQ@mail.gmail.com \
--to=martin.agren@gmail.com \
--cc=avarab@gmail.com \
--cc=git@vger.kernel.org \
--cc=peff@peff.net \
--cc=samoraj.pawel@gmail.com \
/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).