Jonathan NiederIn February 2006 [1], the behavior of diff --cc was changed to fit a more appropriate notion of "interesting hunks" in Octopus merges. This patch updates documentation accordingly.
[1] commit bf1c32bdec8223785c779779d0a660a099f69a63
combine-diff: update --cc "uninteresting hunks" logicSigned-off-by: Jonathan Nieder <jrnieder@uchicago.edu> --- Hello, all. A while ago when someone was asking about the diff --cc output, I noticed some mistakes in the documentation but never got around to fixing them. So here's a small fix. After this patch, many issues remain:
- The user would usually look to git-diff(1) or git-log(1) for an explanation of the --cc option, not git-diff-tree(1) or git-rev-list(1). - diff-format.txt contains the cryptic text "Note that 'combined diff' lists only files which were modified from all parents." I have no idea what that means. - There is some duplication of text between git-diff-tree(1) and git-rev-list(1) here. I don't think that's such a big deal, though. - My proposed text here is not very intuitive or clear, and it does not suggest very strongly what --cc is intended to do (to point out "evil merges" and other merges where the integrator is likely to have made a mistake). Alternate wordings welcome!
At least this patch would not makes matters worse.
Documentation/git-diff-tree.txt | 12 +++++++----- Documentation/rev-list-options.txt | 9 +++++---- 2 files changed, 12 insertions(+), 9 deletions(-)
Show changes to 2 files +12 −9
Documentation/git-diff-tree.txt, Documentation/rev-list-options.txt
diff --git a/Documentation/git-diff-tree.txt b/Documentation/git-diff-tree.txt index 0e45b58..5a81d5d 100644 --- a/Documentation/git-diff-tree.txt +++ b/Documentation/git-diff-tree.txt @@ -92,12 +92,14 @@ include::pretty-options.txt[] --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 + and '-p' options and makes the patch output + even more compact by omitting uninteresting hunks. A hunk is + considered interesting only if either (a) it shows changes from + all parents or (b) in an Octopus merge, it shows different changes + from at least three different parents. + When this optimization makes all hunks disappear, the commit itself and the commit log - message is not shown, just like in any other "empty diff" case. + message are not shown, just like in any other "empty diff" case. --always:: Show the commit itself and the commit log message even diff --git a/Documentation/rev-list-options.txt b/Documentation/rev-list-options.txt index b6f5d87..a399e2b 100644 --- a/Documentation/rev-list-options.txt +++ b/Documentation/rev-list-options.txt @@ -111,10 +111,11 @@ options may be given. See linkgit:git-diff-files[1] for more options. --cc:: - This flag implies the '-c' 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. + This flag implies the '-c' option and makes the patch output + even more compact by omitting uninteresting hunks. A hunk is + considered interesting only if either (a) it shows changes from + all parents or (b) in an Octopus merge, it shows different changes + from at least three different parents. -r::
-- 1.5.6.3.549.g8ca11
