man1/git-range-diff.1

   1 '\" t
   2 .\"     Title: git-range-diff
   3 .\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
   4 .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
   5 .\"      Date: 12/10/2021
   6 .\"    Manual: Git Manual
   7 .\"    Source: Git 2.34.1.182.ge773545c7f
   8 .\"  Language: English
   9 .\"
  10 .TH "GIT\-RANGE\-DIFF" "1" "12/10/2021" "Git 2\&.34\&.1\&.182\&.ge77354" "Git Manual"
  11 .\" -----------------------------------------------------------------
  12 .\" * Define some portability stuff
  13 .\" -----------------------------------------------------------------
  14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  15 .\" http://bugs.debian.org/507673
  16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
  17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  18 .ie \n(.g .ds Aq \(aq
  19 .el       .ds Aq '
  20 .\" -----------------------------------------------------------------
  21 .\" * set default formatting
  22 .\" -----------------------------------------------------------------
  23 .\" disable hyphenation
  24 .nh
  25 .\" disable justification (adjust text to left margin only)
  26 .ad l
  27 .\" -----------------------------------------------------------------
  28 .\" * MAIN CONTENT STARTS HERE *
  29 .\" -----------------------------------------------------------------
  30 .SH "NAME"
  31 git-range-diff \- Compare two commit ranges (e\&.g\&. two versions of a branch)
  32 .SH "SYNOPSIS"
  33 .sp
  34 .nf
  35 \fIgit range\-diff\fR [\-\-color=[<when>]] [\-\-no\-color] [<diff\-options>]
  36         [\-\-no\-dual\-color] [\-\-creation\-factor=<factor>]
  37         [\-\-left\-only | \-\-right\-only]
  38         ( <range1> <range2> | <rev1>\&...<rev2> | <base> <rev1> <rev2> )
  39 .fi
  40 .sp
  41 .SH "DESCRIPTION"
  42 .sp
  43 This command shows the differences between two versions of a patch series, or more generally, two commit ranges (ignoring merge commits)\&.
  44 .sp
  45 To that end, it first finds pairs of commits from both commit ranges that correspond with each other\&. Two commits are said to correspond when the diff between their patches (i\&.e\&. the author information, the commit message and the commit diff) is reasonably small compared to the patches\(aq size\&. See ``Algorithm`` below for details\&.
  46 .sp
  47 Finally, the list of matching commits is shown in the order of the second commit range, with unmatched commits being inserted just after all of their ancestors have been shown\&.
  48 .sp
  49 There are three ways to specify the commit ranges:
  50 .sp
  51 .RS 4
  52 .ie n \{\
  53 \h'-04'\(bu\h'+03'\c
  54 .\}
  55 .el \{\
  56 .sp -1
  57 .IP \(bu 2.3
  58 .\}
  59 \fB<range1> <range2>\fR: Either commit range can be of the form
  60 \fB<base>\&.\&.<rev>\fR,
  61 \fB<rev>^!\fR
  62 or
  63 \fB<rev>^\-<n>\fR\&. See
  64 \fBSPECIFYING RANGES\fR
  65 in
  66 \fBgitrevisions\fR(7)
  67 for more details\&.
  68 .RE
  69 .sp
  70 .RS 4
  71 .ie n \{\
  72 \h'-04'\(bu\h'+03'\c
  73 .\}
  74 .el \{\
  75 .sp -1
  76 .IP \(bu 2.3
  77 .\}
  78 \fB<rev1>\&.\&.\&.<rev2>\fR\&. This is equivalent to
  79 \fB<rev2>\&.\&.<rev1> <rev1>\&.\&.<rev2>\fR\&.
  80 .RE
  81 .sp
  82 .RS 4
  83 .ie n \{\
  84 \h'-04'\(bu\h'+03'\c
  85 .\}
  86 .el \{\
  87 .sp -1
  88 .IP \(bu 2.3
  89 .\}
  90 \fB<base> <rev1> <rev2>\fR: This is equivalent to
  91 \fB<base>\&.\&.<rev1> <base>\&.\&.<rev2>\fR\&.
  92 .RE
  93 .SH "OPTIONS"
  94 .PP
  95 \-\-no\-dual\-color
  96 .RS 4
  97 When the commit diffs differ, \(oqgit range\-diff` recreates the original diffs\(cq coloring, and adds outer \-/+ diff markers with the
  98 \fBbackground\fR
  99 being red/green to make it easier to see e\&.g\&. when there was a change in what exact lines were added\&.
 100 .sp
 101 Additionally, the commit diff lines that are only present in the first commit range are shown "dimmed" (this can be overridden using the
 102 \fBcolor\&.diff\&.<slot>\fR
 103 config setting where
 104 \fB<slot>\fR
 105 is one of
 106 \fBcontextDimmed\fR,
 107 \fBoldDimmed\fR
 108 and
 109 \fBnewDimmed\fR), and the commit diff lines that are only present in the second commit range are shown in bold (which can be overridden using the config settings
 110 \fBcolor\&.diff\&.<slot>\fR
 111 with
 112 \fB<slot>\fR
 113 being one of
 114 \fBcontextBold\fR,
 115 \fBoldBold\fR
 116 or
 117 \fBnewBold\fR)\&.
 118 .sp
 119 This is known to
 120 \fBrange\-diff\fR
 121 as "dual coloring"\&. Use
 122 \fB\-\-no\-dual\-color\fR
 123 to revert to color all lines according to the outer diff markers (and completely ignore the inner diff when it comes to color)\&.
 124 .RE
 125 .PP
 126 \-\-creation\-factor=<percent>
 127 .RS 4
 128 Set the creation/deletion cost fudge factor to
 129 \fB<percent>\fR\&. Defaults to 60\&. Try a larger value if
 130 \fBgit range\-diff\fR
 131 erroneously considers a large change a total rewrite (deletion of one commit and addition of another), and a smaller one in the reverse case\&. See the ``Algorithm`` section below for an explanation why this is needed\&.
 132 .RE
 133 .PP
 134 \-\-left\-only
 135 .RS 4
 136 Suppress commits that are missing from the first specified range (or the "left range" when using the
 137 \fB<rev1>\&.\&.\&.<rev2>\fR
 138 format)\&.
 139 .RE
 140 .PP
 141 \-\-right\-only
 142 .RS 4
 143 Suppress commits that are missing from the second specified range (or the "right range" when using the
 144 \fB<rev1>\&.\&.\&.<rev2>\fR
 145 format)\&.
 146 .RE
 147 .PP
 148 \-\-[no\-]notes[=<ref>]
 149 .RS 4
 150 This flag is passed to the
 151 \fBgit log\fR
 152 program (see
 153 \fBgit-log\fR(1)) that generates the patches\&.
 154 .RE
 155 .PP
 156 <range1> <range2>
 157 .RS 4
 158 Compare the commits specified by the two ranges, where
 159 \fB<range1>\fR
 160 is considered an older version of
 161 \fB<range2>\fR\&.
 162 .RE
 163 .PP
 164 <rev1>\&...<rev2>
 165 .RS 4
 166 Equivalent to passing
 167 \fB<rev2>\&.\&.<rev1>\fR
 168 and
 169 \fB<rev1>\&.\&.<rev2>\fR\&.
 170 .RE
 171 .PP
 172 <base> <rev1> <rev2>
 173 .RS 4
 174 Equivalent to passing
 175 \fB<base>\&.\&.<rev1>\fR
 176 and
 177 \fB<base>\&.\&.<rev2>\fR\&. Note that
 178 \fB<base>\fR
 179 does not need to be the exact branch point of the branches\&. Example: after rebasing a branch
 180 \fBmy\-topic\fR,
 181 \fBgit range\-diff my\-topic@{u} my\-topic@{1} my\-topic\fR
 182 would show the differences introduced by the rebase\&.
 183 .RE
 184 .sp
 185 \fBgit range\-diff\fR also accepts the regular diff options (see \fBgit-diff\fR(1)), most notably the \fB\-\-color=[<when>]\fR and \fB\-\-no\-color\fR options\&. These options are used when generating the "diff between patches", i\&.e\&. to compare the author, commit message and diff of corresponding old/new commits\&. There is currently no means to tweak most of the diff options passed to \fBgit log\fR when generating those patches\&.
 186 .SH "OUTPUT STABILITY"
 187 .sp
 188 The output of the \fBrange\-diff\fR command is subject to change\&. It is intended to be human\-readable porcelain output, not something that can be used across versions of Git to get a textually stable \fBrange\-diff\fR (as opposed to something like the \fB\-\-stable\fR option to \fBgit-patch-id\fR(1))\&. There\(cqs also no equivalent of \fBgit-apply\fR(1) for \fBrange\-diff\fR, the output is not intended to be machine\-readable\&.
 189 .sp
 190 This is particularly true when passing in diff options\&. Currently some options like \fB\-\-stat\fR can, as an emergent effect, produce output that\(cqs quite useless in the context of \fBrange\-diff\fR\&. Future versions of \fBrange\-diff\fR may learn to interpret such options in a manner specific to \fBrange\-diff\fR (e\&.g\&. for \fB\-\-stat\fR producing human\-readable output which summarizes how the diffstat changed)\&.
 191 .SH "CONFIGURATION"
 192 .sp
 193 This command uses the \fBdiff\&.color\&.*\fR and \fBpager\&.range\-diff\fR settings (the latter is on by default)\&. See \fBgit-config\fR(1)\&.
 194 .SH "EXAMPLES"
 195 .sp
 196 When a rebase required merge conflicts to be resolved, compare the changes introduced by the rebase directly afterwards using:
 197 .sp
 198 .if n \{\
 199 .RS 4
 200 .\}
 201 .nf
 202 $ git range\-diff @{u} @{1} @
 203 .fi
 204 .if n \{\
 205 .RE
 206 .\}
 207 .sp
 208 .sp
 209 A typical output of \fBgit range\-diff\fR would look like this:
 210 .sp
 211 .if n \{\
 212 .RS 4
 213 .\}
 214 .nf
 215 \-:  \-\-\-\-\-\-\- > 1:  0ddba11 Prepare for the inevitable!
 216 1:  c0debee = 2:  cab005e Add a helpful message at the start
 217 2:  f00dbal ! 3:  decafe1 Describe a bug
 218     @@ \-1,3 +1,3 @@
 219      Author: A U Thor <author@example\&.com>
 220
 221     \-TODO: Describe a bug
 222     +Describe a bug
 223     @@ \-324,5 +324,6
 224       This is expected\&.
 225
 226     \-+What is unexpected is that it will also crash\&.
 227     ++Unexpectedly, it also crashes\&. This is a bug, and the jury is
 228     ++still out there how to fix it best\&. See ticket #314 for details\&.
 229
 230       Contact
 231 3:  bedead < \-:  \-\-\-\-\-\-\- TO\-UNDO
 232 .fi
 233 .if n \{\
 234 .RE
 235 .\}
 236 .sp
 237 .sp
 238 In this example, there are 3 old and 3 new commits, where the developer removed the 3rd, added a new one before the first two, and modified the commit message of the 2nd commit as well its diff\&.
 239 .sp
 240 When the output goes to a terminal, it is color\-coded by default, just like regular \fBgit diff\fR\(aqs output\&. In addition, the first line (adding a commit) is green, the last line (deleting a commit) is red, the second line (with a perfect match) is yellow like the commit header of \fBgit show\fR\(aqs output, and the third line colors the old commit red, the new one green and the rest like \fBgit show\fR\(aqs commit header\&.
 241 .sp
 242 A naive color\-coded diff of diffs is actually a bit hard to read, though, as it colors the entire lines red or green\&. The line that added "What is unexpected" in the old commit, for example, is completely red, even if the intent of the old commit was to add something\&.
 243 .sp
 244 To help with that, \fBrange\fR uses the \fB\-\-dual\-color\fR mode by default\&. In this mode, the diff of diffs will retain the original diff colors, and prefix the lines with \-/+ markers that have their \fBbackground\fR red or green, to make it more obvious that they describe how the diff itself changed\&.
 245 .SH "ALGORITHM"
 246 .sp
 247 The general idea is this: we generate a cost matrix between the commits in both commit ranges, then solve the least\-cost assignment\&.
 248 .sp
 249 The cost matrix is populated thusly: for each pair of commits, both diffs are generated and the "diff of diffs" is generated, with 3 context lines, then the number of lines in that diff is used as cost\&.
 250 .sp
 251 To avoid false positives (e\&.g\&. when a patch has been removed, and an unrelated patch has been added between two iterations of the same patch series), the cost matrix is extended to allow for that, by adding fixed\-cost entries for wholesale deletes/adds\&.
 252 .sp
 253 Example: Let commits \fB1\-\-2\fR be the first iteration of a patch series and \fBA\-\-C\fR the second iteration\&. Let\(cqs assume that \fBA\fR is a cherry\-pick of \fB2,\fR and \fBC\fR is a cherry\-pick of \fB1\fR but with a small modification (say, a fixed typo)\&. Visualize the commits as a bipartite graph:
 254 .sp
 255 .if n \{\
 256 .RS 4
 257 .\}
 258 .nf
 259     1            A
 260
 261     2            B
 262
 263                  C
 264 .fi
 265 .if n \{\
 266 .RE
 267 .\}
 268 .sp
 269 .sp
 270 We are looking for a "best" explanation of the new series in terms of the old one\&. We can represent an "explanation" as an edge in the graph:
 271 .sp
 272 .if n \{\
 273 .RS 4
 274 .\}
 275 .nf
 276     1            A
 277                /
 278     2 \-\-\-\-\-\-\-\-\(aq  B
 279
 280                  C
 281 .fi
 282 .if n \{\
 283 .RE
 284 .\}
 285 .sp
 286 .sp
 287 This explanation comes for "free" because there was no change\&. Similarly \fBC\fR could be explained using \fB1\fR, but that comes at some cost c>0 because of the modification:
 288 .sp
 289 .if n \{\
 290 .RS 4
 291 .\}
 292 .nf
 293     1 \-\-\-\-\&.      A
 294           |    /
 295     2 \-\-\-\-+\-\-\-\(aq  B
 296           |
 297           `\-\-\-\-\- C
 298           c>0
 299 .fi
 300 .if n \{\
 301 .RE
 302 .\}
 303 .sp
 304 .sp
 305 In mathematical terms, what we are looking for is some sort of a minimum cost bipartite matching; \(oq1` is matched to \fBC\fR at some cost, etc\&. The underlying graph is in fact a complete bipartite graph; the cost we associate with every edge is the size of the diff between the two commits\(cq patches\&. To explain also new commits, we introduce dummy nodes on both sides:
 306 .sp
 307 .if n \{\
 308 .RS 4
 309 .\}
 310 .nf
 311     1 \-\-\-\-\&.      A
 312           |    /
 313     2 \-\-\-\-+\-\-\-\(aq  B
 314           |
 315     o     `\-\-\-\-\- C
 316           c>0
 317     o            o
 318
 319     o            o
 320 .fi
 321 .if n \{\
 322 .RE
 323 .\}
 324 .sp
 325 .sp
 326 The cost of an edge \fBo\-\-C\fR is the size of \fBC\fR\(aqs diff, modified by a fudge factor that should be smaller than 100%\&. The cost of an edge \fBo\-\-o\fR is free\&. The fudge factor is necessary because even if \fB1\fR and \fBC\fR have nothing in common, they may still share a few empty lines and such, possibly making the assignment \fB1\-\-C\fR, \fBo\-\-o\fR slightly cheaper than \fB1\-\-o\fR, \fBo\-\-C\fR even if \fB1\fR and \fBC\fR have nothing in common\&. With the fudge factor we require a much larger common part to consider patches as corresponding\&.
 327 .sp
 328 The overall time needed to compute this algorithm is the time needed to compute n+m commit diffs and then n*m diffs of patches, plus the time needed to compute the least\-cost assignment between n and m diffs\&. Git uses an implementation of the Jonker\-Volgenant algorithm to solve the assignment problem, which has cubic runtime complexity\&. The matching found in this case will look like this:
 329 .sp
 330 .if n \{\
 331 .RS 4
 332 .\}
 333 .nf
 334     1 \-\-\-\-\&.      A
 335           |    /
 336     2 \-\-\-\-+\-\-\-\(aq  B
 337        \&.\-\-+\-\-\-\-\-\(aq
 338     o \-\(aq  `\-\-\-\-\- C
 339           c>0
 340     o \-\-\-\-\-\-\-\-\-\- o
 341
 342     o \-\-\-\-\-\-\-\-\-\- o
 343 .fi
 344 .if n \{\
 345 .RE
 346 .\}
 347 .sp
 348 .SH "SEE ALSO"
 349 .sp
 350 \fBgit-log\fR(1)
 351 .SH "GIT"
 352 .sp
 353 Part of the \fBgit\fR(1) suite