[PATCH] diff: --indent-heuristic is no longer experimental

[PATCH] diff: --indent-heuristic is no longer experimental

[Carlos Martín Nieto]

This heuristic has been the default since 2.14 so we should not confuse our
users by saying that it's experimental and off by default.

Signed-off-by: Carlos Martín Nieto <cmn@dwim.me>
---
 Documentation/diff-heuristic-options.txt | 5 -----
 Documentation/diff-options.txt           | 7 ++++++-
 2 files changed, 6 insertions(+), 6 deletions(-)
 delete mode 100644 Documentation/diff-heuristic-options.txt

diff --git a/Documentation/diff-heuristic-options.txt b/Documentation/diff-heuristic-options.txt
deleted file mode 100644
index d4f3d95505..0000000000
--- a/Documentation/diff-heuristic-options.txt
+++ /dev/null
@@ -1,5 +0,0 @@
---indent-heuristic::
---no-indent-heuristic::
-	These are to help debugging and tuning experimental heuristics
-	(which are off by default) that shift diff hunk boundaries to
-	make patches easier to read.
diff --git a/Documentation/diff-options.txt b/Documentation/diff-options.txt
index a88c76741e..dd0dba5b1d 100644
--- a/Documentation/diff-options.txt
+++ b/Documentation/diff-options.txt
@@ -63,7 +63,12 @@ ifndef::git-format-patch[]
 	Synonym for `-p --raw`.
 endif::git-format-patch[]
 
-include::diff-heuristic-options.txt[]
+--indent-heuristic::
+	Enable the heuristic that shift diff hunk boundaries to make patches
+	easier to read. This is the default.
+
+--no-indent-heuristic::
+	Disable the indent heuristic.
 
 --minimal::
 	Spend extra time to make sure the smallest possible
-- 
2.15.0.rc2

Re: [PATCH] diff: --indent-heuristic is no longer experimental

[Stefan Beller]

On Sun, Oct 29, 2017 at 8:12 AM, Carlos Martín Nieto <cmn@dwim.me> wrote:
> This heuristic has been the default since 2.14 so we should not confuse our
> users by saying that it's experimental and off by default.
>
> Signed-off-by: Carlos Martín Nieto <cmn@dwim.me>

Looks good to me,

Thanks,
Stefan

Re: [PATCH] diff: --indent-heuristic is no longer experimental

[Junio C Hamano]

Carlos Martín Nieto <cmn@dwim.me> writes:

> This heuristic has been the default since 2.14 so we should not confuse our
> users by saying that it's experimental and off by default.
>
> Signed-off-by: Carlos Martín Nieto <cmn@dwim.me>
> ---

Good eyes.  Nobody raised noises since this happened at 2.14 until
now, so this could wait until the next cycle, though ;-)

>  Documentation/diff-heuristic-options.txt | 5 -----
>  Documentation/diff-options.txt           | 7 ++++++-
>  2 files changed, 6 insertions(+), 6 deletions(-)
>  delete mode 100644 Documentation/diff-heuristic-options.txt
>
> diff --git a/Documentation/diff-heuristic-options.txt b/Documentation/diff-heuristic-options.txt
> deleted file mode 100644
> index d4f3d95505..0000000000
> --- a/Documentation/diff-heuristic-options.txt
> +++ /dev/null
> @@ -1,5 +0,0 @@
> ---indent-heuristic::
> ---no-indent-heuristic::
> -	These are to help debugging and tuning experimental heuristics
> -	(which are off by default) that shift diff hunk boundaries to
> -	make patches easier to read.
> diff --git a/Documentation/diff-options.txt b/Documentation/diff-options.txt
> index a88c76741e..dd0dba5b1d 100644
> --- a/Documentation/diff-options.txt
> +++ b/Documentation/diff-options.txt
> @@ -63,7 +63,12 @@ ifndef::git-format-patch[]
>  	Synonym for `-p --raw`.
>  endif::git-format-patch[]
>  
> -include::diff-heuristic-options.txt[]
> +--indent-heuristic::
> +	Enable the heuristic that shift diff hunk boundaries to make patches
> +	easier to read. This is the default.
> +
> +--no-indent-heuristic::
> +	Disable the indent heuristic.
>  
>  --minimal::
>  	Spend extra time to make sure the smallest possible

Re: [PATCH] diff: --indent-heuristic is no longer experimental

[Junio C Hamano]

Carlos Martín Nieto <cmn@dwim.me> writes:

> This heuristic has been the default since 2.14 so we should not confuse our
> users by saying that it's experimental and off by default.
>
> Signed-off-by: Carlos Martín Nieto <cmn@dwim.me>
> ---
>  Documentation/diff-heuristic-options.txt | 5 -----
>  Documentation/diff-options.txt           | 7 ++++++-
>  2 files changed, 6 insertions(+), 6 deletions(-)
>  delete mode 100644 Documentation/diff-heuristic-options.txt

I suspect that this patch is incomplete.  The build procedure barfs
and dies while making git-annotate.html, claiming that it wants to
find diff-heuristic-options.txt that no longer exists.

I'll have to redo today's integration cycle again without this
patch.  Sigh...

Re: [PATCH] diff: --indent-heuristic is no longer experimental

[Junio C Hamano]

Junio C Hamano <gitster@pobox.com> writes:

> Carlos Martín Nieto <cmn@dwim.me> writes:
>
>> This heuristic has been the default since 2.14 so we should not confuse our
>> users by saying that it's experimental and off by default.
>>
>> Signed-off-by: Carlos Martín Nieto <cmn@dwim.me>
>> ---
>>  Documentation/diff-heuristic-options.txt | 5 -----
>>  Documentation/diff-options.txt           | 7 ++++++-
>>  2 files changed, 6 insertions(+), 6 deletions(-)
>>  delete mode 100644 Documentation/diff-heuristic-options.txt
>
> I suspect that this patch is incomplete.  The build procedure barfs
> and dies while making git-annotate.html, claiming that it wants to
> find diff-heuristic-options.txt that no longer exists.

The fix is obvious once you have time to sip your tea and look at
the output from "git grep" ;-)

Subject: [PATCH] SQUASH???

---
 Documentation/git-annotate.txt | 1 -
 Documentation/git-blame.txt    | 2 --
 2 files changed, 3 deletions(-)

diff --git a/Documentation/git-annotate.txt b/Documentation/git-annotate.txt
index 94be4b85e0..05fd482b74 100644
--- a/Documentation/git-annotate.txt
+++ b/Documentation/git-annotate.txt
@@ -23,7 +23,6 @@ familiar command name for people coming from other SCM systems.
 OPTIONS
 -------
 include::blame-options.txt[]
-include::diff-heuristic-options.txt[]
 
 SEE ALSO
 --------
diff --git a/Documentation/git-blame.txt b/Documentation/git-blame.txt
index fdc3aea30a..16323eb80e 100644
--- a/Documentation/git-blame.txt
+++ b/Documentation/git-blame.txt
@@ -89,8 +89,6 @@ include::blame-options.txt[]
 	abbreviated object name, use <n>+1 digits. Note that 1 column
 	is used for a caret to mark the boundary commit.
 
-include::diff-heuristic-options.txt[]
-
 
 THE PORCELAIN FORMAT
 --------------------
-- 
2.15.0-206-g5fb43f7f39