git@vger.kernel.org mailing list mirror (one of many)
 help / color / mirror / code / Atom feed
From: Jeff King <peff@peff.net>
To: "Martin Ågren" <martin.agren@gmail.com>
Cc: git@vger.kernel.org
Subject: Re: [PATCH 0/4] A few Asciidoctor-fixes
Date: Sun, 16 Dec 2018 05:44:58 -0500	[thread overview]
Message-ID: <20181216104458.GC13704@sigill.intra.peff.net> (raw)
In-Reply-To: <20181215112742.1475882-1-martin.agren@gmail.com>

On Sat, Dec 15, 2018 at 12:27:38PM +0100, Martin Ågren wrote:

> I have (ab)used doc-diff to try to find instances where Asciidoctor and
> Asciidoc render our documentation differently. (See [1] for details on
> the hack.) This series fixes the differences that somehow stood out in
> the diff. Many smaller differences remain.

I think the relevant bits from [1] are:

 * 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

To make this easier, it would make sense to me to:

  - teach doc-diff a flag for marking one or both of the endpoints to be
    built with asciidoctor versus asciidoc

  - mark the asciidoc/asciidoctor in the directory name. That name
    serves as a cache key for avoiding re-doing the work, you should be
    able to just:

      ./doc-diff --asciidoctor HEAD HEAD

    and actually build and compare what you want.

  - it sounds from "make --always-make" that our Makefile does not
    properly rebuild when we switch from asciidoc to asciidoctor. That
    might be nice to fix with a mechanism similar to the GIT-BUILD-FLAGS
    we use in the top-level Makefile.

-Peff

  parent reply	other threads:[~2018-12-16 10:45 UTC|newest]

Thread overview: 18+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-12-15 11:27 [PATCH 0/4] A few Asciidoctor-fixes Martin Ågren
2018-12-15 11:27 ` [PATCH 1/4] git-column.txt: fix section header Martin Ågren
2018-12-16 10:51   ` Jeff King
2018-12-16 14:27     ` Martin Ågren
2018-12-15 11:27 ` [PATCH 2/4] git-init.txt: do not nest open blocks Martin Ågren
2018-12-16 10:55   ` Jeff King
2018-12-15 11:27 ` [PATCH 3/4] rev-list-options.txt: " Martin Ågren
2018-12-16 10:56   ` Jeff King
2018-12-15 11:27 ` [PATCH 4/4] git-status.txt: render tables correctly under Asciidoctor Martin Ågren
2018-12-16 10:59   ` Jeff King
2018-12-16 14:28     ` [PATCH v2 0/3] A few Asciidoctor-fixes Martin Ågren
2018-12-16 14:28       ` [PATCH v2 1/3] git-column.txt: fix section header Martin Ågren
2018-12-16 14:28       ` [PATCH v2 2/3] Documentation: do not nest open blocks Martin Ågren
2018-12-16 14:28       ` [PATCH v2 3/3] git-status.txt: render tables correctly under Asciidoctor Martin Ågren
2018-12-16 16:19       ` [PATCH v2 0/3] A few Asciidoctor-fixes Jeff King
2018-12-16 10:44 ` Jeff King [this message]
2018-12-16 14:34   ` [PATCH 0/4] " Martin Ågren
2018-12-16 16:17     ` Jeff King

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=20181216104458.GC13704@sigill.intra.peff.net \
    --to=peff@peff.net \
    --cc=git@vger.kernel.org \
    --cc=martin.agren@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).