Skip to content

Commit 52f425e

Browse files
committed
whatchanged: document its historical nature
Encourage new users to use 'log' instead. These days, these commands are unified and just have different defaults. 'git log' only allowed you to view the log messages and no diffs when it was added in early June 2005. It was only in early April 2006 that the command learned to take diff options. Because of this, power users tended to use 'whatchanged' that already existed since mid May 2005 and supported diff options. Signed-off-by: Junio C Hamano <[email protected]>
1 parent 627a8b8 commit 52f425e

File tree

1 file changed

+7
-33
lines changed

1 file changed

+7
-33
lines changed

Documentation/git-whatchanged.txt

Lines changed: 7 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -13,43 +13,17 @@ SYNOPSIS
1313

1414
DESCRIPTION
1515
-----------
16-
Shows commit logs and diff output each commit introduces. The
17-
command internally invokes 'git rev-list' piped to
18-
'git diff-tree', and takes command line options for both of
19-
these commands.
2016

21-
This manual page describes only the most frequently used options.
17+
Shows commit logs and diff output each commit introduces.
2218

19+
New users are encouraged to use linkgit:git-log[1] instead. The
20+
`whatchanged` command is essentially the same as linkgit:git-log[1]
21+
but defaults to show the raw format diff output and to skip merges.
2322

24-
OPTIONS
25-
-------
26-
-p::
27-
Show textual diffs, instead of the Git internal diff
28-
output format that is useful only to tell the changed
29-
paths and their nature of changes.
23+
The command is kept primarily for historical reasons; fingers of
24+
many people who learned Git long before `git log` was invented by
25+
reading Linux kernel mailing list are trained to type it.
3026

31-
-<n>::
32-
Limit output to <n> commits.
33-
34-
<since>..<until>::
35-
Limit output to between the two named commits (bottom
36-
exclusive, top inclusive).
37-
38-
-r::
39-
Show Git internal diff output, but for the whole tree,
40-
not just the top level.
41-
42-
-m::
43-
By default, differences for merge commits are not shown.
44-
With this flag, show differences to that commit from all
45-
of its parents.
46-
+
47-
However, it is not very useful in general, although it
48-
*is* useful on a file-by-file basis.
49-
50-
include::pretty-options.txt[]
51-
52-
include::pretty-formats.txt[]
5327

5428
Examples
5529
--------

0 commit comments

Comments
 (0)