Skip to contentSkip to conversation

Is diff.indentHeuristic still experimental?

PATCH In review Hong Xu 4 participants 4 messages Aug 15, 2019 Documentation

lore
Share & tools
lore
#1 lore raw

PATCH 1/1 diff: 'diff.indentHeuristic' is no longer experimental

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

---
 Documentation/config/diff.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/config/diff.txt +1 -1
index 5afb5a2cbc..ff09f1cf73 100644
@@ -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::
Signature · 1 line
2.23.0.rc2.366.g16015fd804
#2 lore raw

Re: [PATCH] diff: 'diff.indentHeuristic' is no longer experimental

Quoted 7 lines · SZEDER Gábor

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.

Quoted 6 lines

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

#3 lore raw

Re: [PATCH] diff: 'diff.indentHeuristic' is no longer experimental

Quoted 9 lines · Jeff King
Quoted 7 lines · SZEDER Gábor

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.

Quoted 8 lines
Quoted 6 lines

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.