From: Jeff King <peff@peff.net>
Date: Tue, 28 Jan 2020 07:33:40 GMT
Subject: Re: [PATCH v2] git: update documentation for --git-dir
Message-ID: <20200128073340.GA564804@coredump.intra.peff.net>
In-Reply-To: <CACg5j24TNczbZZ3u0UR_MYQgeWk8HRY-cxc3N8HX=v-Tx0vi3A@mail.gmail.com>

On Tue, Jan 28, 2020 at 05:17:49PM +1300, Heba Waly wrote:

> On Mon, Jan 27, 2020 at 7:29 PM Johannes Sixt <j6t@kdbg.org> wrote:
> >
> > Does this render well? Judging by the precedent set by the descriptions
> > of -C and -c options earlier in this file, continuation paragraphs
> > should not be indented and separated by a line with just a plus sign
> > instead of an empty line.
> 
> It doesn't render well, thanks for pointing it out, will send an
> updated version.

One tool that might help as you do documentation patches: there's a
doc-diff script that shows the rendered differences.

Try:

  cd Documentation
  ./doc-diff HEAD^ HEAD

(on a branch with your patch at the tip). It was originally written to
investigate changes to the markup, etc, but I find it's useful just for
looking at any documentation patch, because it takes you right to the
part that changed. :)

-Peff