Code

Improve the git-diff-tree -c/-cc documentation
authorPetr Baudis <pasky@suse.cz>
Sun, 9 Apr 2006 13:43:17 +0000 (15:43 +0200)
committerJunio C Hamano <junkio@cox.net>
Sun, 9 Apr 2006 18:11:19 +0000 (11:11 -0700)
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>
Documentation/git-diff-tree.txt

index 9153e4cf2a1020dc9a3b5792ff3f64f7efd9f42c..2169169850da89283027778f47a40090bb6acfde 100644 (file)
@@ -60,7 +60,8 @@ separated with a single space are given.
 -m::
        By default, "git-diff-tree --stdin" does not show
        differences for merge commits.  With this flag, it shows
-       differences to that commit from all of its parents.
+       differences to that commit from all of its parents. See
+       also '-c'.
 
 -s::
        By default, "git-diff-tree --stdin" shows differences,
@@ -81,19 +82,25 @@ separated with a single space are given.
        git-diff-tree outputs a line with the commit ID when
        applicable.  This flag suppressed the commit ID output.
 
--c,--cc::
-       These flags change the way a merge commit is displayed
+-c::
+       This flag changes the way a merge commit is displayed
        (which means it is useful only when the command is given
        one <tree-ish>, or '--stdin').  It shows the differences
-       from each of the parents to the merge result
-       simultaneously, instead of showing pairwise diff between
-       a parent and the result one at a time, which '-m' option
-       output does.  '--cc' further compresses the output by
-       omiting hunks that show differences from only one
+       from each of the parents to the merge result simultaneously
+       instead of showing pairwise diff between a parent and the
+       result one at a time (which is what the '-m' option does).
+       Furthermore, it lists only files which were modified
+       from all parents.
+
+-cc::
+       This flag changes the way a merge commit patch is displayed,
+       in a similar way to the '-c' option. It implies the '-c'
+       and '-p' options and further compresses the patch output
+       by omitting hunks that show differences from only one
        parent, or show the same change from all but one parent
        for an Octopus merge.  When this optimization makes all
        hunks disappear, the commit itself and the commit log
-       message is not shown, just like any other "empty diff" cases.
+       message is not shown, just like in any other "empty diff" case.
 
 --always::
        Show the commit itself and the commit log message even