mailing list mirror (one of many)
 help / color / mirror / code / Atom feed
From: Jeff King <>
To: "Martin Ågren" <>
Subject: Re: [PATCH] config.txt: move closing "----" to cover entire listing
Date: Thu, 9 Apr 2020 10:14:52 -0400	[thread overview]
Message-ID: <> (raw)
In-Reply-To: <>

On Thu, Apr 09, 2020 at 12:35:41PM +0200, Martin Ågren wrote:

> Commit 1925fe0c8a ("Documentation: wrap config listings in "----"",
> 2019-09-07) wrapped this fairly large block of example config directives
> in "----". The closing "----" ended up a few lines too early though.
> Make sure to include the trailing "IncludeIf.onbranch:..." example, too.
> Signed-off-by: Martin Ågren <>
> ---
>  Not sure how I managed to botch this in 1925fe0c8a.

I managed to botch the review, as well. :)

This looks good to me. Some observations below.

> diff --git a/Documentation/config.txt b/Documentation/config.txt
> index 2450589a0e..74009d5402 100644
> --- a/Documentation/config.txt
> +++ b/Documentation/config.txt
> @@ -220,12 +220,12 @@ Example
>  ; affected by the condition
>  [includeIf "gitdir:/path/to/group/"]
>  	path =
> -----
> -	; include only if we are in a worktree where foo-branch is
> -	; currently checked out
> -	[includeIf "onbranch:foo-branch"]
> -		path =
> +; include only if we are in a worktree where foo-branch is
> +; currently checked out
> +[includeIf "onbranch:foo-branch"]
> +	path =
> +----

I had to stare at this for a moment before realizing that the "-----" is
not 5 dashes in context, but the removal of the old, misplaced 4-dash

I checked it with doc-diff, but was surprised to find no change. That's
because the manpage shows it the same either way (the indented chunk is
just a different example, but two examples back to back render the same
as a single one). But you can see the difference in the HTML version,
where the final example isn't in the grey box.

That explains why I didn't see the issue when running doc-diff on the
original bug. I wonder if we could teach doc-diff to look at the HTML,
too. I'm not sure how, though. Certainly html2text or similar would get
us something diff-able, but without the visual elements (like the grey
box), I don't know that it's much more valuable than the manpages.


  reply	other threads:[~2020-04-09 14:14 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-04-09 10:35 [PATCH] config.txt: move closing "----" to cover entire listing Martin Ågren
2020-04-09 14:14 ` Jeff King [this message]
2020-04-09 15:00   ` Martin Ågren
2020-04-09 15:51     ` Jeff King
2020-04-10  7:09       ` Martin Ågren

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:

  List information:

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \ \ \ \ \

* 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

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).