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). 26 {git-diff? This is the default.} 27endif::git-format-patch[] 28 29-U<n>:: 30--unified=<n>:: 31 Generate diffs with <n> lines of context instead of 32 the usual three. 33ifndef::git-format-patch[] 34 Implies `-p`. 35endif::git-format-patch[] 36 37ifndef::git-format-patch[] 38--raw:: 39 Generate the raw format. 40 {git-diff-core? This is the default.} 41endif::git-format-patch[] 42 43ifndef::git-format-patch[] 44--patch-with-raw:: 45 Synonym for `-p --raw`. 46endif::git-format-patch[] 47 48--patience:: 49 Generate a diff using the "patience diff" algorithm. 50 51--stat[=<width>[,<name-width>]]:: 52 Generate a diffstat. You can override the default 53 output width for 80-column terminal by `--stat=<width>`. 54 The width of the filename part can be controlled by 55 giving another width to it separated by a comma. 56 57--numstat:: 58 Similar to `\--stat`, but shows number of added and 59 deleted lines in decimal notation and pathname without 60 abbreviation, to make it more machine friendly. For 61 binary files, outputs two `-` instead of saying 62 `0 0`. 63 64--shortstat:: 65 Output only the last line of the `--stat` format containing total 66 number of modified files, as well as number of added and deleted 67 lines. 68 69--dirstat[=<param1,param2,...>]:: 70 Output the distribution of relative amount of changes for each 71 sub-directory. The behavior of `--dirstat` can be customized by 72 passing it a comma separated list of parameters. 73 The defaults are controlled by the `diff.dirstat` configuration 74 variable (see linkgit:git-config[1]). 75 The following parameters are available: 76+ 77-- 78`changes`;; 79 Compute the dirstat numbers by counting the lines that have been 80 removed from the source, or added to the destination. This ignores 81 the amount of pure code movements within a file. In other words, 82 rearranging lines in a file is not counted as much as other changes. 83 This is the default behavior when no parameter is given. 84`lines`;; 85 Compute the dirstat numbers by doing the regular line-based diff 86 analysis, and summing the removed/added line counts. (For binary 87 files, count 64-byte chunks instead, since binary files have no 88 natural concept of lines). This is a more expensive `--dirstat` 89 behavior than the `changes` behavior, but it does count rearranged 90 lines within a file as much as other changes. The resulting output 91 is consistent with what you get from the other `--*stat` options. 92`files`;; 93 Compute the dirstat numbers by counting the number of files changed. 94 Each changed file counts equally in the dirstat analysis. This is 95 the computationally cheapest `--dirstat` behavior, since it does 96 not have to look at the file contents at all. 97`cumulative`;; 98 Count changes in a child directory for the parent directory as well. 99 Note that when using `cumulative`, the sum of the percentages 100 reported may exceed 100%. The default (non-cumulative) behavior can 101 be specified with the `noncumulative` parameter. 102<limit>;; 103 An integer parameter specifies a cut-off percent (3% by default). 104 Directories contributing less than this percentage of the changes 105 are not shown in the output. 106-- 107+ 108Example: The following will count changed files, while ignoring 109directories with less than 10% of the total amount of changed files, 110and accumulating child directory counts in the parent directories: 111`--dirstat=files,10,cumulative`. 112 113--summary:: 114 Output a condensed summary of extended header information 115 such as creations, renames and mode changes. 116 117ifndef::git-format-patch[] 118--patch-with-stat:: 119 Synonym for `-p --stat`. 120endif::git-format-patch[] 121 122ifndef::git-format-patch[] 123 124-z:: 125ifdef::git-log[] 126 Separate the commits with NULs instead of with new newlines. 127+ 128Also, when `--raw` or `--numstat` has been given, do not munge 129pathnames and use NULs as output field terminators. 130endif::git-log[] 131ifndef::git-log[] 132 When `--raw`, `--numstat`, `--name-only` or `--name-status` has been 133 given, do not munge pathnames and use NULs as output field terminators. 134endif::git-log[] 135+ 136Without this option, each pathname output will have TAB, LF, double quotes, 137and backslash characters replaced with `\t`, `\n`, `\"`, and `\\`, 138respectively, and the pathname will be enclosed in double quotes if 139any of those replacements occurred. 140 141--name-only:: 142 Show only names of changed files. 143 144--name-status:: 145 Show only names and status of changed files. See the description 146 of the `--diff-filter` option on what the status letters mean. 147 148--submodule[=<format>]:: 149 Chose the output format for submodule differences. <format> can be one of 150 'short' and 'log'. 'short' just shows pairs of commit names, this format 151 is used when this option is not given. 'log' is the default value for this 152 option and lists the commits in that commit range like the 'summary' 153 option of linkgit:git-submodule[1] does. 154 155--color[=<when>]:: 156 Show colored diff. 157 The value must be `always` (the default for `<when>`), `never`, or `auto`. 158 The default value is `never`. 159ifdef::git-diff[] 160 It can be changed by the `color.ui` and `color.diff` 161 configuration settings. 162endif::git-diff[] 163 164--no-color:: 165 Turn off colored diff. 166ifdef::git-diff[] 167 This can be used to override configuration settings. 168endif::git-diff[] 169 It is the same as `--color=never`. 170 171--word-diff[=<mode>]:: 172 Show a word diff, using the <mode> to delimit changed words. 173 By default, words are delimited by whitespace; see 174 `--word-diff-regex` below. The <mode> defaults to 'plain', and 175 must be one of: 176+ 177-- 178color:: 179 Highlight changed words using only colors. Implies `--color`. 180plain:: 181 Show words as `[-removed-]` and `{+added+}`. Makes no 182 attempts to escape the delimiters if they appear in the input, 183 so the output may be ambiguous. 184porcelain:: 185 Use a special line-based format intended for script 186 consumption. Added/removed/unchanged runs are printed in the 187 usual unified diff format, starting with a `+`/`-`/` ` 188 character at the beginning of the line and extending to the 189 end of the line. Newlines in the input are represented by a 190 tilde `~` on a line of its own. 191none:: 192 Disable word diff again. 193-- 194+ 195Note that despite the name of the first mode, color is used to 196highlight the changed parts in all modes if enabled. 197 198--word-diff-regex=<regex>:: 199 Use <regex> to decide what a word is, instead of considering 200 runs of non-whitespace to be a word. Also implies 201 `--word-diff` unless it was already enabled. 202+ 203Every non-overlapping match of the 204<regex> is considered a word. Anything between these matches is 205considered whitespace and ignored(!) for the purposes of finding 206differences. You may want to append `|[^[:space:]]` to your regular 207expression to make sure that it matches all non-whitespace characters. 208A match that contains a newline is silently truncated(!) at the 209newline. 210+ 211The regex can also be set via a diff driver or configuration option, see 212linkgit:gitattributes[1] or linkgit:git-config[1]. Giving it explicitly 213overrides any diff driver or configuration setting. Diff drivers 214override configuration settings. 215 216--color-words[=<regex>]:: 217 Equivalent to `--word-diff=color` plus (if a regex was 218 specified) `--word-diff-regex=<regex>`. 219endif::git-format-patch[] 220 221--no-renames:: 222 Turn off rename detection, even when the configuration 223 file gives the default to do so. 224 225ifndef::git-format-patch[] 226--check:: 227 Warn if changes introduce whitespace errors. What are 228 considered whitespace errors is controlled by `core.whitespace` 229 configuration. By default, trailing whitespaces (including 230 lines that solely consist of whitespaces) and a space character 231 that is immediately followed by a tab character inside the 232 initial indent of the line are considered whitespace errors. 233 Exits with non-zero status if problems are found. Not compatible 234 with --exit-code. 235endif::git-format-patch[] 236 237--full-index:: 238 Instead of the first handful of characters, show the full 239 pre- and post-image blob object names on the "index" 240 line when generating patch format output. 241 242--binary:: 243 In addition to `--full-index`, output a binary diff that 244 can be applied with `git-apply`. 245 246--abbrev[=<n>]:: 247 Instead of showing the full 40-byte hexadecimal object 248 name in diff-raw format output and diff-tree header 249 lines, show only a partial prefix. This is 250 independent of the `--full-index` option above, which controls 251 the diff-patch output format. Non default number of 252 digits can be specified with `--abbrev=<n>`. 253 254-B[<n>][/<m>]:: 255--break-rewrites[=[<n>][/<m>]]:: 256 Break complete rewrite changes into pairs of delete and 257 create. This serves two purposes: 258+ 259It affects the way a change that amounts to a total rewrite of a file 260not as a series of deletion and insertion mixed together with a very 261few lines that happen to match textually as the context, but as a 262single deletion of everything old followed by a single insertion of 263everything new, and the number `m` controls this aspect of the -B 264option (defaults to 60%). `-B/70%` specifies that less than 30% of the 265original should remain in the result for git to consider it a total 266rewrite (i.e. otherwise the resulting patch will be a series of 267deletion and insertion mixed together with context lines). 268+ 269When used with -M, a totally-rewritten file is also considered as the 270source of a rename (usually -M only considers a file that disappeared 271as the source of a rename), and the number `n` controls this aspect of 272the -B option (defaults to 50%). `-B20%` specifies that a change with 273addition and deletion compared to 20% or more of the file's size are 274eligible for being picked up as a possible source of a rename to 275another file. 276 277-M[<n>]:: 278--find-renames[=<n>]:: 279ifndef::git-log[] 280 Detect renames. 281endif::git-log[] 282ifdef::git-log[] 283 If generating diffs, detect and report renames for each commit. 284 For following files across renames while traversing history, see 285 `--follow`. 286endif::git-log[] 287 If `n` is specified, it is a threshold on the similarity 288 index (i.e. amount of addition/deletions compared to the 289 file's size). For example, `-M90%` means git should consider a 290 delete/add pair to be a rename if more than 90% of the file 291 hasn't changed. 292 293-C[<n>]:: 294--find-copies[=<n>]:: 295 Detect copies as well as renames. See also `--find-copies-harder`. 296 If `n` is specified, it has the same meaning as for `-M<n>`. 297 298--find-copies-harder:: 299 For performance reasons, by default, `-C` option finds copies only 300 if the original file of the copy was modified in the same 301 changeset. This flag makes the command 302 inspect unmodified files as candidates for the source of 303 copy. This is a very expensive operation for large 304 projects, so use it with caution. Giving more than one 305 `-C` option has the same effect. 306 307-D:: 308--irreversible-delete:: 309 Omit the preimage for deletes, i.e. print only the header but not 310 the diff between the preimage and `/dev/null`. The resulting patch 311 is not meant to be applied with `patch` nor `git apply`; this is 312 solely for people who want to just concentrate on reviewing the 313 text after the change. In addition, the output obviously lack 314 enough information to apply such a patch in reverse, even manually, 315 hence the name of the option. 316+ 317When used together with `-B`, omit also the preimage in the deletion part 318of a delete/create pair. 319 320-l<num>:: 321 The `-M` and `-C` options require O(n^2) processing time where n 322 is the number of potential rename/copy targets. This 323 option prevents rename/copy detection from running if 324 the number of rename/copy targets exceeds the specified 325 number. 326 327ifndef::git-format-patch[] 328--diff-filter=[(A|C|D|M|R|T|U|X|B)...[*]]:: 329 Select only files that are Added (`A`), Copied (`C`), 330 Deleted (`D`), Modified (`M`), Renamed (`R`), have their 331 type (i.e. regular file, symlink, submodule, ...) changed (`T`), 332 are Unmerged (`U`), are 333 Unknown (`X`), or have had their pairing Broken (`B`). 334 Any combination of the filter characters (including none) can be used. 335 When `*` (All-or-none) is added to the combination, all 336 paths are selected if there is any file that matches 337 other criteria in the comparison; if there is no file 338 that matches other criteria, nothing is selected. 339 340-S<string>:: 341 Look for differences that introduce or remove an instance of 342 <string>. Note that this is different than the string simply 343 appearing in diff output; see the 'pickaxe' entry in 344 linkgit:gitdiffcore[7] for more details. 345 346-G<regex>:: 347 Look for differences whose added or removed line matches 348 the given <regex>. 349 350--pickaxe-all:: 351 When `-S` or `-G` finds a change, show all the changes in that 352 changeset, not just the files that contain the change 353 in <string>. 354 355--pickaxe-regex:: 356 Make the <string> not a plain string but an extended POSIX 357 regex to match. 358endif::git-format-patch[] 359 360-O<orderfile>:: 361 Output the patch in the order specified in the 362 <orderfile>, which has one shell glob pattern per line. 363 364ifndef::git-format-patch[] 365-R:: 366 Swap two inputs; that is, show differences from index or 367 on-disk file to tree contents. 368 369--relative[=<path>]:: 370 When run from a subdirectory of the project, it can be 371 told to exclude changes outside the directory and show 372 pathnames relative to it with this option. When you are 373 not in a subdirectory (e.g. in a bare repository), you 374 can name which subdirectory to make the output relative 375 to by giving a <path> as an argument. 376endif::git-format-patch[] 377 378-a:: 379--text:: 380 Treat all files as text. 381 382--ignore-space-at-eol:: 383 Ignore changes in whitespace at EOL. 384 385-b:: 386--ignore-space-change:: 387 Ignore changes in amount of whitespace. This ignores whitespace 388 at line end, and considers all other sequences of one or 389 more whitespace characters to be equivalent. 390 391-w:: 392--ignore-all-space:: 393 Ignore whitespace when comparing lines. This ignores 394 differences even if one line has whitespace where the other 395 line has none. 396 397--inter-hunk-context=<lines>:: 398 Show the context between diff hunks, up to the specified number 399 of lines, thereby fusing hunks that are close to each other. 400 401ifndef::git-format-patch[] 402--exit-code:: 403 Make the program exit with codes similar to diff(1). 404 That is, it exits with 1 if there were differences and 405 0 means no differences. 406 407--quiet:: 408 Disable all output of the program. Implies `--exit-code`. 409endif::git-format-patch[] 410 411--ext-diff:: 412 Allow an external diff helper to be executed. If you set an 413 external diff driver with linkgit:gitattributes[5], you need 414 to use this option with linkgit:git-log[1] and friends. 415 416--no-ext-diff:: 417 Disallow external diff drivers. 418 419--textconv:: 420--no-textconv:: 421 Allow (or disallow) external text conversion filters to be run 422 when comparing binary files. See linkgit:gitattributes[5] for 423 details. Because textconv filters are typically a one-way 424 conversion, the resulting diff is suitable for human 425 consumption, but cannot be applied. For this reason, textconv 426 filters are enabled by default only for linkgit:git-diff[1] and 427 linkgit:git-log[1], but not for linkgit:git-format-patch[1] or 428 diff plumbing commands. 429 430--ignore-submodules[=<when>]:: 431 Ignore changes to submodules in the diff generation. <when> can be 432 either "none", "untracked", "dirty" or "all", which is the default 433 Using "none" will consider the submodule modified when it either contains 434 untracked or modified files or its HEAD differs from the commit recorded 435 in the superproject and can be used to override any settings of the 436 'ignore' option in linkgit:git-config[1] or linkgit:gitmodules[5]. When 437 "untracked" is used submodules are not considered dirty when they only 438 contain untracked content (but they are still scanned for modified 439 content). Using "dirty" ignores all changes to the work tree of submodules, 440 only changes to the commits stored in the superproject are shown (this was 441 the behavior until 1.7.0). Using "all" hides all changes to submodules. 442 443--src-prefix=<prefix>:: 444 Show the given source prefix instead of "a/". 445 446--dst-prefix=<prefix>:: 447 Show the given destination prefix instead of "b/". 448 449--no-prefix:: 450 Do not show any source or destination prefix. 451 452For more detailed explanation on these common options, see also 453linkgit:gitdiffcore[7].