Improve the git-diff-tree -c/-cc documentation
This tries to clarify the -c/-cc documentation and clean up the style and grammar. Signed-off-by: Petr Baudis <pasky@suse.cz> Signed-off-by: Junio C Hamano <junkio@cox.net>
Petr Baudis committed
Apr 9, 2006 at 15:43 UTC
a13ba129cdc66b60eef177696084ff80034069b7
1 file changed
+16
-9
Documentation/git-diff-tree.txt
+16
-9
@@ -60,7 +60,8 @@ separated with a single space are given.
60
-m::
61
By default, "git-diff-tree --stdin" does not show
62
differences for merge commits. With this flag, it shows
63
- differences to that commit from all of its parents.
63
+ differences to that commit from all of its parents. See
64
+ also '-c'.
65
66
-s::
67
By default, "git-diff-tree --stdin" shows differences,
@@ -81,19 +82,25 @@ separated with a single space are given.
82
git-diff-tree outputs a line with the commit ID when
83
applicable. This flag suppressed the commit ID output.
84
84
--c,--cc::
85
- These flags change the way a merge commit is displayed
85
+-c::
86
+ This flag changes the way a merge commit is displayed
87
(which means it is useful only when the command is given
88
one <tree-ish>, or '--stdin'). It shows the differences
88
- from each of the parents to the merge result
89
- simultaneously, instead of showing pairwise diff between
90
- a parent and the result one at a time, which '-m' option
91
- output does. '--cc' further compresses the output by
92
- omiting hunks that show differences from only one
89
+ from each of the parents to the merge result simultaneously
90
+ instead of showing pairwise diff between a parent and the
91
+ result one at a time (which is what the '-m' option does).
92
+ Furthermore, it lists only files which were modified
93
+ from all parents.
94
+
95
+-cc::
96
+ This flag changes the way a merge commit patch is displayed,
97
+ in a similar way to the '-c' option. It implies the '-c'
98
+ and '-p' options and further compresses the patch output
99
+ by omitting hunks that show differences from only one
100
parent, or show the same change from all but one parent
101
for an Octopus merge. When this optimization makes all
102
hunks disappear, the commit itself and the commit log
96
- message is not shown, just like any other "empty diff" cases.
103
+ message is not shown, just like in any other "empty diff" case.
104
105
--always::
106
Show the commit itself and the commit log message even