Re: [PATCH 1/2] git-reset.txt: render tables correctly under Asciidoctor
- Date: Wed, 28 Nov 2018 21:37:19 +0100
- From: Martin Ågren <martin.agren@xxxxxxxxx>
- Subject: Re: [PATCH 1/2] git-reset.txt: render tables correctly under Asciidoctor
On Wed, 28 Nov 2018 at 20:45, Ævar Arnfjörð Bjarmason <avarab@xxxxxxxxx> 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.