Re: [PATCH v3 6/6] whatschanged: list it in BreakingChanges document

[Elijah Newren <newren@gmail.com>]

On Fri, May 2, 2025 at 5:59 PM Junio C Hamano <gitster@pobox.com> wrote:
>
> This can be squashed into the previous step.  That is how our "git
> pack-redundant" conversion did.
>
> Theoretically, however, those who want to gauge the need to keep the
> command by exposing their users to patches before this one may want
> to wait until their experiment finishes before they formally say
> "this will go away".
>
> This change is made into a separate patch from the previous step
> precisely to help those folks.

Were these three paragraphs intended to come after the "---" line, but
accidentally placed in the commit message?

>
> Signed-off-by: Junio C Hamano <gitster@pobox.com>
> ---
>  Documentation/BreakingChanges.adoc | 9 +++++++++
>  Documentation/git-whatchanged.adoc | 6 ++++++
>  2 files changed, 15 insertions(+)
>
> diff --git a/Documentation/BreakingChanges.adoc b/Documentation/BreakingChanges.adoc
> index bdfad29d8a..f9026d004c 100644
> --- a/Documentation/BreakingChanges.adoc
> +++ b/Documentation/BreakingChanges.adoc
> @@ -178,6 +178,15 @@ references.
>  +
>  These features will be removed.
>
> +* The git-whatchanged(1) command has outlived its usefulness more than
> +  10 years ago, and takes more keystrokes to type than its rough
> +  equivalent `git log --raw`.  We have nominated the command for
> +  removal, have changed the command to refuse to work unless the
> +  `--i-still-use-this` option is given, and asked the users to report
> +  when they do so.  So far there hasn't been a single complaint.
> ++
> +The command will be removed

Missing period at the end of this sentence?


> +
>  == Superseded features that will not be deprecated
>
>  Some features have gained newer replacements that aim to improve the design in
> diff --git a/Documentation/git-whatchanged.adoc b/Documentation/git-whatchanged.adoc
> index d400b68d4b..d21484026f 100644
> --- a/Documentation/git-whatchanged.adoc
> +++ b/Documentation/git-whatchanged.adoc
> @@ -11,6 +11,12 @@ SYNOPSIS
>  [synopsis]
>  git whatchanged <option>...
>
> +WARNING
> +-------
> +`git whatchanged` has been deprecated and is scheduled for removal in
> +a future version of Git, as it is merely `git log` with different
> +default; `whatchanged` is not even shorter to type than `log --raw`.
> +
>  DESCRIPTION
>  -----------
>
> --
> 2.49.0-601-ga5925c3955