git@vger.kernel.org mailing list mirror (one of many)
 help / color / mirror / code / Atom feed
From: Jeff King <peff@peff.net>
To: "Ævar Arnfjörð Bjarmason" <avarab@gmail.com>
Cc: git@vger.kernel.org, Junio C Hamano <gitster@pobox.com>,
	Bagas Sanjaya <bagasdotme@gmail.com>
Subject: Re: [PATCH] git config doc: fix recent ASCIIDOC formatting regresison
Date: Tue, 19 Oct 2021 17:11:47 -0400	[thread overview]
Message-ID: <YW80k4kCPG6VJfW/@coredump.intra.peff.net> (raw)
In-Reply-To: <patch-1.1-36700e581d2-20211019T123057Z-avarab@gmail.com>

On Tue, Oct 19, 2021 at 02:31:34PM +0200, Ævar Arnfjörð Bjarmason wrote:

> Fix a regression in 8c328561332 (blame: document --color-* options,
> 2021-10-08), which added an extra newline before the "+" syntax.

Thanks, this looks like an obviously correct fix. I think asciidoc's
pickiness around "+" has bitten us before. Asciidoctor is more lenient
here, and the rendered result looks the same before and after your
patch, but we should definitely make it look good in both.

> The "Documentation/doc-diff HEAD~ HEAD" output with this applied is:

I just want to call this out not only as a good way to review this
patch, but a great way in general to review any patches which touch
documentation. Running:

  doc-diff 8c328561332^ 8c328561332

shows the original problem pretty clearly.

>  Documentation/config/color.txt | 2 --
>  1 file changed, 2 deletions(-)

Patch looks good. There's a small typo in the subject:

> Subject: [PATCH] git config doc: fix recent ASCIIDOC formatting regresison

s/regresison/regression/

-Peff

  reply	other threads:[~2021-10-19 21:11 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-10-08  9:16 [PATCH v5 0/2] blame: documentation update Bagas Sanjaya
2021-10-08  9:16 ` [PATCH v5 1/2] blame: describe default output format Bagas Sanjaya
2021-10-08  9:16 ` [PATCH v5 2/2] blame: document --color-* options Bagas Sanjaya
2021-10-19 12:31   ` [PATCH] git config doc: fix recent ASCIIDOC formatting regresison Ævar Arnfjörð Bjarmason
2021-10-19 21:11     ` Jeff King [this message]
2021-10-20 15:35       ` Junio C Hamano
2021-10-08 21:09 ` [PATCH v5 0/2] blame: documentation update Junio C Hamano

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=YW80k4kCPG6VJfW/@coredump.intra.peff.net \
    --to=peff@peff.net \
    --cc=avarab@gmail.com \
    --cc=bagasdotme@gmail.com \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.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).