1// Please don't remove this comment as asciidoc behaves badly when 2// the first non-empty line is ifdef/ifndef. The symptom is that 3// without this comment the <git-diff-core> attribute conditionally 4// defined below ends up being defined unconditionally. 5// Last checked with asciidoc 7.0.2. 6 7ifndef::git-format-patch[] 8ifndef::git-diff[] 9ifndef::git-log[] 10:git-diff-core: 1 11endif::git-log[] 12endif::git-diff[] 13endif::git-format-patch[] 14 15ifdef::git-format-patch[] 16-p:: 17--no-stat:: 18 Generate plain patches without any diffstats. 19endif::git-format-patch[] 20 21ifndef::git-format-patch[] 22-p:: 23-u:: 24--patch:: 25 Generate patch (see section on generating patches). 26ifdef::git-diff[] 27 This is the default. 28endif::git-diff[] 29 30-s:: 31--no-patch:: 32 Suppress diff output. Useful for commands like `git show` that 33 show the patch by default, or to cancel the effect of `--patch`. 34endif::git-format-patch[] 35 36-U<n>:: 37--unified=<n>:: 38 Generate diffs with <n> lines of context instead of 39 the usual three. 40ifndef::git-format-patch[] 41 Implies `-p`. 42endif::git-format-patch[] 43 44ifndef::git-format-patch[] 45--raw:: 46ifndef::git-log[] 47 Generate the diff in raw format. 48ifdef::git-diff-core[] 49 This is the default. 50endif::git-diff-core[] 51endif::git-log[] 52ifdef::git-log[] 53 For each commit, show a summary of changes using the raw diff 54 format. See the "RAW OUTPUT FORMAT" section of 55 linkgit:git-diff[1]. This is different from showing the log 56 itself in raw format, which you can achieve with 57 `--format=raw`. 58endif::git-log[] 59endif::git-format-patch[] 60 61ifndef::git-format-patch[] 62--patch-with-raw:: 63 Synonym for `-p --raw`. 64endif::git-format-patch[] 65 66include::diff-heuristic-options.txt[] 67 68--minimal:: 69 Spend extra time to make sure the smallest possible 70 diff is produced. 71 72--patience:: 73 Generate a diff using the "patience diff" algorithm. 74 75--histogram:: 76 Generate a diff using the "histogram diff" algorithm. 77 78--diff-algorithm={patience|minimal|histogram|myers}:: 79 Choose a diff algorithm. The variants are as follows: 80+ 81-- 82`default`, `myers`;; 83 The basic greedy diff algorithm. Currently, this is the default. 84`minimal`;; 85 Spend extra time to make sure the smallest possible diff is 86 produced. 87`patience`;; 88 Use "patience diff" algorithm when generating patches. 89`histogram`;; 90 This algorithm extends the patience algorithm to "support 91 low-occurrence common elements". 92-- 93+ 94For instance, if you configured diff.algorithm variable to a 95non-default value and want to use the default one, then you 96have to use `--diff-algorithm=default` option. 97 98--stat[=<width>[,<name-width>[,<count>]]]:: 99 Generate a diffstat. By default, as much space as necessary 100 will be used for the filename part, and the rest for the graph 101 part. Maximum width defaults to terminal width, or 80 columns 102 if not connected to a terminal, and can be overridden by 103 `<width>`. The width of the filename part can be limited by 104 giving another width `<name-width>` after a comma. The width 105 of the graph part can be limited by using 106 `--stat-graph-width=<width>` (affects all commands generating 107 a stat graph) or by setting `diff.statGraphWidth=<width>` 108 (does not affect `git format-patch`). 109 By giving a third parameter `<count>`, you can limit the 110 output to the first `<count>` lines, followed by `...` if 111 there are more. 112+ 113These parameters can also be set individually with `--stat-width=<width>`, 114`--stat-name-width=<name-width>` and `--stat-count=<count>`. 115 116--numstat:: 117 Similar to `--stat`, but shows number of added and 118 deleted lines in decimal notation and pathname without 119 abbreviation, to make it more machine friendly. For 120 binary files, outputs two `-` instead of saying 121 `0 0`. 122 123--shortstat:: 124 Output only the last line of the `--stat` format containing total 125 number of modified files, as well as number of added and deleted 126 lines. 127 128--dirstat[=<param1,param2,...>]:: 129 Output the distribution of relative amount of changes for each 130 sub-directory. The behavior of `--dirstat` can be customized by 131 passing it a comma separated list of parameters. 132 The defaults are controlled by the `diff.dirstat` configuration 133 variable (see linkgit:git-config[1]). 134 The following parameters are available: 135+ 136-- 137`changes`;; 138 Compute the dirstat numbers by counting the lines that have been 139 removed from the source, or added to the destination. This ignores 140 the amount of pure code movements within a file. In other words, 141 rearranging lines in a file is not counted as much as other changes. 142 This is the default behavior when no parameter is given. 143`lines`;; 144 Compute the dirstat numbers by doing the regular line-based diff 145 analysis, and summing the removed/added line counts. (For binary 146 files, count 64-byte chunks instead, since binary files have no 147 natural concept of lines). This is a more expensive `--dirstat` 148 behavior than the `changes` behavior, but it does count rearranged 149 lines within a file as much as other changes. The resulting output 150 is consistent with what you get from the other `--*stat` options. 151`files`;; 152 Compute the dirstat numbers by counting the number of files changed. 153 Each changed file counts equally in the dirstat analysis. This is 154 the computationally cheapest `--dirstat` behavior, since it does 155 not have to look at the file contents at all. 156`cumulative`;; 157 Count changes in a child directory for the parent directory as well. 158 Note that when using `cumulative`, the sum of the percentages 159 reported may exceed 100%. The default (non-cumulative) behavior can 160 be specified with the `noncumulative` parameter. 161<limit>;; 162 An integer parameter specifies a cut-off percent (3% by default). 163 Directories contributing less than this percentage of the changes 164 are not shown in the output. 165-- 166+ 167Example: The following will count changed files, while ignoring 168directories with less than 10% of the total amount of changed files, 169and accumulating child directory counts in the parent directories: 170`--dirstat=files,10,cumulative`. 171 172--summary:: 173 Output a condensed summary of extended header information 174 such as creations, renames and mode changes. 175 176ifndef::git-format-patch[] 177--patch-with-stat:: 178 Synonym for `-p --stat`. 179endif::git-format-patch[] 180 181ifndef::git-format-patch[] 182 183-z:: 184ifdef::git-log[] 185 Separate the commits with NULs instead of with new newlines. 186+ 187Also, when `--raw` or `--numstat` has been given, do not munge 188pathnames and use NULs as output field terminators. 189endif::git-log[] 190ifndef::git-log[] 191 When `--raw`, `--numstat`, `--name-only` or `--name-status` has been 192 given, do not munge pathnames and use NULs as output field terminators. 193endif::git-log[] 194+ 195Without this option, pathnames with "unusual" characters are quoted as 196explained for the configuration variable `core.quotePath` (see 197linkgit:git-config[1]). 198 199--name-only:: 200 Show only names of changed files. 201 202--name-status:: 203 Show only names and status of changed files. See the description 204 of the `--diff-filter` option on what the status letters mean. 205 206--submodule[=<format>]:: 207 Specify how differences in submodules are shown. When specifying 208 `--submodule=short` the 'short' format is used. This format just 209 shows the names of the commits at the beginning and end of the range. 210 When `--submodule` or `--submodule=log` is specified, the 'log' 211 format is used. This format lists the commits in the range like 212 linkgit:git-submodule[1] `summary` does. When `--submodule=diff` 213 is specified, the 'diff' format is used. This format shows an 214 inline diff of the changes in the submodule contents between the 215 commit range. Defaults to `diff.submodule` or the 'short' format 216 if the config option is unset. 217 218--color[=<when>]:: 219 Show colored diff. 220 `--color` (i.e. without '=<when>') is the same as `--color=always`. 221 '<when>' can be one of `always`, `never`, or `auto`. 222ifdef::git-diff[] 223 It can be changed by the `color.ui` and `color.diff` 224 configuration settings. 225endif::git-diff[] 226 227--no-color:: 228 Turn off colored diff. 229ifdef::git-diff[] 230 This can be used to override configuration settings. 231endif::git-diff[] 232 It is the same as `--color=never`. 233 234--color-moved[=<mode>]:: 235 Moved lines of code are colored differently. 236ifdef::git-diff[] 237 It can be changed by the `diff.colorMoved` configuration setting. 238endif::git-diff[] 239 The <mode> defaults to 'no' if the option is not given 240 and to 'zebra' if the option with no mode is given. 241 The mode must be one of: 242+ 243-- 244no:: 245 Moved lines are not highlighted. 246default:: 247 Is a synonym for `zebra`. This may change to a more sensible mode 248 in the future. 249plain:: 250 Any line that is added in one location and was removed 251 in another location will be colored with 'color.diff.newMoved'. 252 Similarly 'color.diff.oldMoved' will be used for removed lines 253 that are added somewhere else in the diff. This mode picks up any 254 moved line, but it is not very useful in a review to determine 255 if a block of code was moved without permutation. 256zebra:: 257 Blocks of moved text of at least 20 alphanumeric characters 258 are detected greedily. The detected blocks are 259 painted using either the 'color.diff.{old,new}Moved' color or 260 'color.diff.{old,new}MovedAlternative'. The change between 261 the two colors indicates that a new block was detected. 262dimmed_zebra:: 263 Similar to 'zebra', but additional dimming of uninteresting parts 264 of moved code is performed. The bordering lines of two adjacent 265 blocks are considered interesting, the rest is uninteresting. 266-- 267 268--word-diff[=<mode>]:: 269 Show a word diff, using the <mode> to delimit changed words. 270 By default, words are delimited by whitespace; see 271 `--word-diff-regex` below. The <mode> defaults to 'plain', and 272 must be one of: 273+ 274-- 275color:: 276 Highlight changed words using only colors. Implies `--color`. 277plain:: 278 Show words as `[-removed-]` and `{+added+}`. Makes no 279 attempts to escape the delimiters if they appear in the input, 280 so the output may be ambiguous. 281porcelain:: 282 Use a special line-based format intended for script 283 consumption. Added/removed/unchanged runs are printed in the 284 usual unified diff format, starting with a `+`/`-`/` ` 285 character at the beginning of the line and extending to the 286 end of the line. Newlines in the input are represented by a 287 tilde `~` on a line of its own. 288none:: 289 Disable word diff again. 290-- 291+ 292Note that despite the name of the first mode, color is used to 293highlight the changed parts in all modes if enabled. 294 295--word-diff-regex=<regex>:: 296 Use <regex> to decide what a word is, instead of considering 297 runs of non-whitespace to be a word. Also implies 298 `--word-diff` unless it was already enabled. 299+ 300Every non-overlapping match of the 301<regex> is considered a word. Anything between these matches is 302considered whitespace and ignored(!) for the purposes of finding 303differences. You may want to append `|[^[:space:]]` to your regular 304expression to make sure that it matches all non-whitespace characters. 305A match that contains a newline is silently truncated(!) at the 306newline. 307+ 308For example, `--word-diff-regex=.` will treat each character as a word 309and, correspondingly, show differences character by character. 310+ 311The regex can also be set via a diff driver or configuration option, see 312linkgit:gitattributes[5] or linkgit:git-config[1]. Giving it explicitly 313overrides any diff driver or configuration setting. Diff drivers 314override configuration settings. 315 316--color-words[=<regex>]:: 317 Equivalent to `--word-diff=color` plus (if a regex was 318 specified) `--word-diff-regex=<regex>`. 319endif::git-format-patch[] 320 321--no-renames:: 322 Turn off rename detection, even when the configuration 323 file gives the default to do so. 324 325ifndef::git-format-patch[] 326--check:: 327 Warn if changes introduce conflict markers or whitespace errors. 328 What are considered whitespace errors is controlled by `core.whitespace` 329 configuration. By default, trailing whitespaces (including 330 lines that solely consist of whitespaces) and a space character 331 that is immediately followed by a tab character inside the 332 initial indent of the line are considered whitespace errors. 333 Exits with non-zero status if problems are found. Not compatible 334 with --exit-code. 335 336--ws-error-highlight=<kind>:: 337 Highlight whitespace errors in the `context`, `old` or `new` 338 lines of the diff. Multiple values are separated by comma, 339 `none` resets previous values, `default` reset the list to 340 `new` and `all` is a shorthand for `old,new,context`. When 341 this option is not given, and the configuration variable 342 `diff.wsErrorHighlight` is not set, only whitespace errors in 343 `new` lines are highlighted. The whitespace errors are colored 344 whith `color.diff.whitespace`. 345 346endif::git-format-patch[] 347 348--full-index:: 349 Instead of the first handful of characters, show the full 350 pre- and post-image blob object names on the "index" 351 line when generating patch format output. 352 353--binary:: 354 In addition to `--full-index`, output a binary diff that 355 can be applied with `git-apply`. 356 357--abbrev[=<n>]:: 358 Instead of showing the full 40-byte hexadecimal object 359 name in diff-raw format output and diff-tree header 360 lines, show only a partial prefix. This is 361 independent of the `--full-index` option above, which controls 362 the diff-patch output format. Non default number of 363 digits can be specified with `--abbrev=<n>`. 364 365-B[<n>][/<m>]:: 366--break-rewrites[=[<n>][/<m>]]:: 367 Break complete rewrite changes into pairs of delete and 368 create. This serves two purposes: 369+ 370It affects the way a change that amounts to a total rewrite of a file 371not as a series of deletion and insertion mixed together with a very 372few lines that happen to match textually as the context, but as a 373single deletion of everything old followed by a single insertion of 374everything new, and the number `m` controls this aspect of the -B 375option (defaults to 60%). `-B/70%` specifies that less than 30% of the 376original should remain in the result for Git to consider it a total 377rewrite (i.e. otherwise the resulting patch will be a series of 378deletion and insertion mixed together with context lines). 379+ 380When used with -M, a totally-rewritten file is also considered as the 381source of a rename (usually -M only considers a file that disappeared 382as the source of a rename), and the number `n` controls this aspect of 383the -B option (defaults to 50%). `-B20%` specifies that a change with 384addition and deletion compared to 20% or more of the file's size are 385eligible for being picked up as a possible source of a rename to 386another file. 387 388-M[<n>]:: 389--find-renames[=<n>]:: 390ifndef::git-log[] 391 Detect renames. 392endif::git-log[] 393ifdef::git-log[] 394 If generating diffs, detect and report renames for each commit. 395 For following files across renames while traversing history, see 396 `--follow`. 397endif::git-log[] 398 If `n` is specified, it is a threshold on the similarity 399 index (i.e. amount of addition/deletions compared to the 400 file's size). For example, `-M90%` means Git should consider a 401 delete/add pair to be a rename if more than 90% of the file 402 hasn't changed. Without a `%` sign, the number is to be read as 403 a fraction, with a decimal point before it. I.e., `-M5` becomes 404 0.5, and is thus the same as `-M50%`. Similarly, `-M05` is 405 the same as `-M5%`. To limit detection to exact renames, use 406 `-M100%`. The default similarity index is 50%. 407 408-C[<n>]:: 409--find-copies[=<n>]:: 410 Detect copies as well as renames. See also `--find-copies-harder`. 411 If `n` is specified, it has the same meaning as for `-M<n>`. 412 413--find-copies-harder:: 414 For performance reasons, by default, `-C` option finds copies only 415 if the original file of the copy was modified in the same 416 changeset. This flag makes the command 417 inspect unmodified files as candidates for the source of 418 copy. This is a very expensive operation for large 419 projects, so use it with caution. Giving more than one 420 `-C` option has the same effect. 421 422-D:: 423--irreversible-delete:: 424 Omit the preimage for deletes, i.e. print only the header but not 425 the diff between the preimage and `/dev/null`. The resulting patch 426 is not meant to be applied with `patch` or `git apply`; this is 427 solely for people who want to just concentrate on reviewing the 428 text after the change. In addition, the output obviously lacks 429 enough information to apply such a patch in reverse, even manually, 430 hence the name of the option. 431+ 432When used together with `-B`, omit also the preimage in the deletion part 433of a delete/create pair. 434 435-l<num>:: 436 The `-M` and `-C` options require O(n^2) processing time where n 437 is the number of potential rename/copy targets. This 438 option prevents rename/copy detection from running if 439 the number of rename/copy targets exceeds the specified 440 number. 441 442ifndef::git-format-patch[] 443--diff-filter=[(A|C|D|M|R|T|U|X|B)...[*]]:: 444 Select only files that are Added (`A`), Copied (`C`), 445 Deleted (`D`), Modified (`M`), Renamed (`R`), have their 446 type (i.e. regular file, symlink, submodule, ...) changed (`T`), 447 are Unmerged (`U`), are 448 Unknown (`X`), or have had their pairing Broken (`B`). 449 Any combination of the filter characters (including none) can be used. 450 When `*` (All-or-none) is added to the combination, all 451 paths are selected if there is any file that matches 452 other criteria in the comparison; if there is no file 453 that matches other criteria, nothing is selected. 454+ 455Also, these upper-case letters can be downcased to exclude. E.g. 456`--diff-filter=ad` excludes added and deleted paths. 457 458-S<string>:: 459 Look for differences that change the number of occurrences of 460 the specified string (i.e. addition/deletion) in a file. 461 Intended for the scripter's use. 462+ 463It is useful when you're looking for an exact block of code (like a 464struct), and want to know the history of that block since it first 465came into being: use the feature iteratively to feed the interesting 466block in the preimage back into `-S`, and keep going until you get the 467very first version of the block. 468 469-G<regex>:: 470 Look for differences whose patch text contains added/removed 471 lines that match <regex>. 472+ 473To illustrate the difference between `-S<regex> --pickaxe-regex` and 474`-G<regex>`, consider a commit with the following diff in the same 475file: 476+ 477---- 478+ return !regexec(regexp, two->ptr, 1, ®match, 0); 479... 480- hit = !regexec(regexp, mf2.ptr, 1, ®match, 0); 481---- 482+ 483While `git log -G"regexec\(regexp"` will show this commit, `git log 484-S"regexec\(regexp" --pickaxe-regex` will not (because the number of 485occurrences of that string did not change). 486+ 487See the 'pickaxe' entry in linkgit:gitdiffcore[7] for more 488information. 489 490--pickaxe-all:: 491 When `-S` or `-G` finds a change, show all the changes in that 492 changeset, not just the files that contain the change 493 in <string>. 494 495--pickaxe-regex:: 496 Treat the <string> given to `-S` as an extended POSIX regular 497 expression to match. 498endif::git-format-patch[] 499 500-O<orderfile>:: 501 Control the order in which files appear in the output. 502 This overrides the `diff.orderFile` configuration variable 503 (see linkgit:git-config[1]). To cancel `diff.orderFile`, 504 use `-O/dev/null`. 505+ 506The output order is determined by the order of glob patterns in 507<orderfile>. 508All files with pathnames that match the first pattern are output 509first, all files with pathnames that match the second pattern (but not 510the first) are output next, and so on. 511All files with pathnames that do not match any pattern are output 512last, as if there was an implicit match-all pattern at the end of the 513file. 514If multiple pathnames have the same rank (they match the same pattern 515but no earlier patterns), their output order relative to each other is 516the normal order. 517+ 518<orderfile> is parsed as follows: 519+ 520-- 521 - Blank lines are ignored, so they can be used as separators for 522 readability. 523 524 - Lines starting with a hash ("`#`") are ignored, so they can be used 525 for comments. Add a backslash ("`\`") to the beginning of the 526 pattern if it starts with a hash. 527 528 - Each other line contains a single pattern. 529-- 530+ 531Patterns have the same syntax and semantics as patterns used for 532fnmantch(3) without the FNM_PATHNAME flag, except a pathname also 533matches a pattern if removing any number of the final pathname 534components matches the pattern. For example, the pattern "`foo*bar`" 535matches "`fooasdfbar`" and "`foo/bar/baz/asdf`" but not "`foobarx`". 536 537ifndef::git-format-patch[] 538-R:: 539 Swap two inputs; that is, show differences from index or 540 on-disk file to tree contents. 541 542--relative[=<path>]:: 543 When run from a subdirectory of the project, it can be 544 told to exclude changes outside the directory and show 545 pathnames relative to it with this option. When you are 546 not in a subdirectory (e.g. in a bare repository), you 547 can name which subdirectory to make the output relative 548 to by giving a <path> as an argument. 549endif::git-format-patch[] 550 551-a:: 552--text:: 553 Treat all files as text. 554 555--ignore-space-at-eol:: 556 Ignore changes in whitespace at EOL. 557 558-b:: 559--ignore-space-change:: 560 Ignore changes in amount of whitespace. This ignores whitespace 561 at line end, and considers all other sequences of one or 562 more whitespace characters to be equivalent. 563 564-w:: 565--ignore-all-space:: 566 Ignore whitespace when comparing lines. This ignores 567 differences even if one line has whitespace where the other 568 line has none. 569 570--ignore-blank-lines:: 571 Ignore changes whose lines are all blank. 572 573--inter-hunk-context=<lines>:: 574 Show the context between diff hunks, up to the specified number 575 of lines, thereby fusing hunks that are close to each other. 576 Defaults to `diff.interHunkContext` or 0 if the config option 577 is unset. 578 579-W:: 580--function-context:: 581 Show whole surrounding functions of changes. 582 583ifndef::git-format-patch[] 584ifndef::git-log[] 585--exit-code:: 586 Make the program exit with codes similar to diff(1). 587 That is, it exits with 1 if there were differences and 588 0 means no differences. 589 590--quiet:: 591 Disable all output of the program. Implies `--exit-code`. 592endif::git-log[] 593endif::git-format-patch[] 594 595--ext-diff:: 596 Allow an external diff helper to be executed. If you set an 597 external diff driver with linkgit:gitattributes[5], you need 598 to use this option with linkgit:git-log[1] and friends. 599 600--no-ext-diff:: 601 Disallow external diff drivers. 602 603--textconv:: 604--no-textconv:: 605 Allow (or disallow) external text conversion filters to be run 606 when comparing binary files. See linkgit:gitattributes[5] for 607 details. Because textconv filters are typically a one-way 608 conversion, the resulting diff is suitable for human 609 consumption, but cannot be applied. For this reason, textconv 610 filters are enabled by default only for linkgit:git-diff[1] and 611 linkgit:git-log[1], but not for linkgit:git-format-patch[1] or 612 diff plumbing commands. 613 614--ignore-submodules[=<when>]:: 615 Ignore changes to submodules in the diff generation. <when> can be 616 either "none", "untracked", "dirty" or "all", which is the default. 617 Using "none" will consider the submodule modified when it either contains 618 untracked or modified files or its HEAD differs from the commit recorded 619 in the superproject and can be used to override any settings of the 620 'ignore' option in linkgit:git-config[1] or linkgit:gitmodules[5]. When 621 "untracked" is used submodules are not considered dirty when they only 622 contain untracked content (but they are still scanned for modified 623 content). Using "dirty" ignores all changes to the work tree of submodules, 624 only changes to the commits stored in the superproject are shown (this was 625 the behavior until 1.7.0). Using "all" hides all changes to submodules. 626 627--src-prefix=<prefix>:: 628 Show the given source prefix instead of "a/". 629 630--dst-prefix=<prefix>:: 631 Show the given destination prefix instead of "b/". 632 633--no-prefix:: 634 Do not show any source or destination prefix. 635 636--line-prefix=<prefix>:: 637 Prepend an additional prefix to every line of output. 638 639--ita-invisible-in-index:: 640 By default entries added by "git add -N" appear as an existing 641 empty file in "git diff" and a new file in "git diff --cached". 642 This option makes the entry appear as a new file in "git diff" 643 and non-existent in "git diff --cached". This option could be 644 reverted with `--ita-visible-in-index`. Both options are 645 experimental and could be removed in future. 646 647For more detailed explanation on these common options, see also 648linkgit:gitdiffcore[7].