whatschanged: list it in BreakingChanges document
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. While at it, update the documentation page to use the new [synopsis] facility to mark-up the SYNOPSIS part. Helped-by: Elijah Newren <newren@gmail.com> [en: typofix] Signed-off-by: Junio C Hamano <gitster@pobox.com>
Junio C Hamano committed
May 12, 2025 at 12:03 UTC
e836757e14bf4fd617828d834d29e679e1f527c0
2 files changed
+17
-2
Documentation/BreakingChanges.adoc
+9
@@ -178,6 +178,15 @@ references.
178
+
179
These features will be removed.
180
181
+* The git-whatchanged(1) command has outlived its usefulness more than
182
+ 10 years ago, and takes more keystrokes to type than its rough
183
+ equivalent `git log --raw`. We have nominated the command for
184
+ removal, have changed the command to refuse to work unless the
185
+ `--i-still-use-this` option is given, and asked the users to report
186
+ when they do so. So far there hasn't been a single complaint.
187
++
188
+The command will be removed.
189
+
190
== Superseded features that will not be deprecated
191
192
Some features have gained newer replacements that aim to improve the design in
Documentation/git-whatchanged.adoc
+8
-2
@@ -8,8 +8,14 @@ git-whatchanged - Show logs with differences each commit introduces
8
9
SYNOPSIS
10
--------
11
-[verse]
12
-'git whatchanged' <option>...
11
+[synopsis]
12
+git whatchanged <option>...
13
+
14
+WARNING
15
+-------
16
+`git whatchanged` has been deprecated and is scheduled for removal in
17
+a future version of Git, as it is merely `git log` with different
18
+default; `whatchanged` is not even shorter to type than `log --raw`.
19
20
DESCRIPTION
21
-----------