Re: [PATCH] config.txt: move closing "----" to cover entire listing

[Jeff King <peff@peff.net>]

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 <martin.agren@gmail.com>
> ---
>  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 = foo.inc
> -----
>  
> -	; include only if we are in a worktree where foo-branch is
> -	; currently checked out
> -	[includeIf "onbranch:foo-branch"]
> -		path = foo.inc
> +; include only if we are in a worktree where foo-branch is
> +; currently checked out
> +[includeIf "onbranch:foo-branch"]
> +	path = foo.inc
> +----

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

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.

-Peff