diff: 'diff.indentHeuristic' is no longer experimental
diff mbox series

Message ID 20190815091245.16525-1-szeder.dev@gmail.com
State New
Headers show
Series
  • diff: 'diff.indentHeuristic' is no longer experimental
Related show

Commit Message

SZEDER Gábor Aug. 15, 2019, 9:12 a.m. UTC
The indent heuristic started out as experimental, but it's now our
default diff heuristic since 33de716387 (diff: enable indent heuristic
by default, 2017-05-08).  Alas, that commit didn't update the
documentation, and the description of the 'diff.indentHeuristic'
configuration variable still implies that it's experimental and not
the default.

Update the description of 'diff.indentHeuristic' to make it clear that
it's the default diff heuristic.

The description of the related '--indent-heuristic' option has already
been updated in bab76141da (diff: --indent-heuristic is no
longer experimental, 2017-10-29).

Signed-off-by: SZEDER Gábor <szeder.dev@gmail.com>
---
 Documentation/config/diff.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Jeff King Aug. 15, 2019, 1:56 p.m. UTC | #1
On Thu, Aug 15, 2019 at 11:12:45AM +0200, SZEDER Gábor wrote:

> The indent heuristic started out as experimental, but it's now our
> default diff heuristic since 33de716387 (diff: enable indent heuristic
> by default, 2017-05-08).  Alas, that commit didn't update the
> documentation, and the description of the 'diff.indentHeuristic'
> configuration variable still implies that it's experimental and not
> the default.
> 
> Update the description of 'diff.indentHeuristic' to make it clear that
> it's the default diff heuristic.
> 
> The description of the related '--indent-heuristic' option has already
> been updated in bab76141da (diff: --indent-heuristic is no
> longer experimental, 2017-10-29).

Yeah, this makes perfect sense.

I wondered briefly if we needed to distinguish between plumbing and
porcelain here, but the config option (and its default) are the same for
both.

-Peff
Junio C Hamano Aug. 15, 2019, 4:58 p.m. UTC | #2
Jeff King <peff@peff.net> writes:

> On Thu, Aug 15, 2019 at 11:12:45AM +0200, SZEDER Gábor wrote:
>
>> The indent heuristic started out as experimental, but it's now our
>> default diff heuristic since 33de716387 (diff: enable indent heuristic
>> by default, 2017-05-08).  Alas, that commit didn't update the
>> documentation, and the description of the 'diff.indentHeuristic'
>> configuration variable still implies that it's experimental and not
>> the default.
>> 
>> Update the description of 'diff.indentHeuristic' to make it clear that
>> it's the default diff heuristic.
>> 
>> The description of the related '--indent-heuristic' option has already
>> been updated in bab76141da (diff: --indent-heuristic is no
>> longer experimental, 2017-10-29).
>
> Yeah, this makes perfect sense.

OK.  Thanks, all.

Patch
diff mbox series

diff --git a/Documentation/config/diff.txt b/Documentation/config/diff.txt
index 5afb5a2cbc..ff09f1cf73 100644
--- a/Documentation/config/diff.txt
+++ b/Documentation/config/diff.txt
@@ -189,7 +189,7 @@  diff.guitool::
 include::../mergetools-diff.txt[]
 
 diff.indentHeuristic::
-	Set this option to `true` to enable experimental heuristics
+	Set this option to `false` to disable the default heuristics
 	that shift diff hunk boundaries to make patches easier to read.
 
 diff.algorithm::