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