git/list[1] front-page[2] threads[3] people[4] search[5] about
 

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

From
Jeff King <peff@peff.net>
Date
Oct 19, 2021, 21:11 UTC
Message-ID
<YW80k4kCPG6VJfW/@coredump.intra.peff.net>
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
Previous: Ævar Arnfjörð BjarmasonNext: Junio C Hamano
Message 5 of 7 in “blame: documentation update”
  1. 0/2 blame: documentation updateBagas Sanjaya, Oct 8, 2021
  2. 1/2 blame: describe default output formatBagas Sanjaya, Oct 8, 2021
  3. 2/2 blame: document --color-* optionsBagas Sanjaya, Oct 8, 2021
  4. git config doc: fix recent ASCIIDOC formatting regresisonÆvar Arnfjörð Bjarmason, Oct 19, 2021
  5. Jeff KingOct 19, 2021
  6. Junio C HamanoOct 20, 2021
  7. Junio C HamanoOct 8, 2021

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.