Re: [PATCHv3 3/4] diff: enable indent heuristic by default

From: Jeff King <peff@peff.net>
Date: May 1, 2017, 22:20 UTC
Message-ID: <20170501222051.svylxazjwnot3wwg@sigill.intra.peff.net>
In-Reply-To: <20170501221345.4025-4-marcnarc@xiplink.com>

On Mon, May 01, 2017 at 06:13:44PM -0400, Marc Branchaud wrote:

Show 23 quoted lines

> From: Stefan Beller <sbeller@google.com>
> 
> The feature was included in v2.11 (released 2016-11-29) and we got no
> negative feedback. Quite the opposite, all feedback we got was positive.
> 
> Turn it on by default. Users who dislike the feature can turn it off
> by setting diff.indentHeuristic (which also configures plumbing commands,
> see prior patches).
> 
> The change to t/t4051-diff-function-context.sh is needed because the
> heuristic shifts the changed hunk in the patch.  To get the same result
> regardless of the heuristic configuration, we modify the test file
> differently:  We insert a completely new line after line 2, instead of
> simply duplicating it.
> 
> Helped-by: Jeff King <peff@peff.net>
> Signed-off-by: Stefan Beller <sbeller@google.com>
> Signed-off-by: Marc Branchaud <marcnarc@xiplink.com>
> 
> ---
> 
> Tested the sed "2a" command's escaping in both Ubuntu 17.04 and FreeBSD 10.3.
> Threw in a little indenting so that it isn't too ugly.

I think that should be fine. The indenting will go into the output, but we really don't care _what_ that line is, just as long as it's new content.

Show 12 quoted lines

> diff --git a/t/t4061-diff-indent.sh b/t/t4061-diff-indent.sh
> index 13d3dc96a..56d7d7760 100755
> --- a/t/t4061-diff-indent.sh
> +++ b/t/t4061-diff-indent.sh
> @@ -153,7 +153,7 @@ test_expect_success 'prepare' '
>  '
>  
>  test_expect_success 'diff: ugly spaces' '
> -	git diff old new -- spaces.txt >out &&
> +	git diff --no-indent-heuristic old new -- spaces.txt >out &&
>  	compare_diff spaces-expect out
>  '

I guess one could argue that most of t4061 should be rewritten. This fixes the failures that the "ugly" version is no longer the default. But the tests checking that diff.indentHeuristic=true works are basically doing nothing (the interesting thing after this patch is that setting it to false goes back to the ugly output).

I dunno. If we drop the config and options as experiments, then the whole script basically goes away in favor of checking that the test case has the non-ugly output. If that's our endgame, it may not be worth spending too much time refactoring it. But if we're going to keep the config indefinitely, maybe we should make sure it works.

-Peff