Documentation/diff-options.txt

   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
   7 ifndef::git-format-patch[]
   8 ifndef::git-diff[]
   9 ifndef::git-log[]
  10 :git-diff-core: 1
  11 endif::git-log[]
  12 endif::git-diff[]
  13 endif::git-format-patch[]
  14
  15 ifdef::git-format-patch[]
  16 -p::
  17         Generate patches without diffstat.
  18 endif::git-format-patch[]
  19
  20 ifndef::git-format-patch[]
  21 -p::
  22         Generate patch (see section on generating patches).
  23         {git-diff? This is the default.}
  24 endif::git-format-patch[]
  25
  26 -u::
  27         Synonym for "-p".
  28
  29 -U<n>::
  30         Shorthand for "--unified=<n>".
  31
  32 --unified=<n>::
  33         Generate diffs with <n> lines of context instead of
  34         the usual three. Implies "-p".
  35
  36 --raw::
  37         Generate the raw format.
  38         {git-diff-core? This is the default.}
  39
  40 --patch-with-raw::
  41         Synonym for "-p --raw".
  42
  43 --stat[=width[,name-width]]::
  44         Generate a diffstat.  You can override the default
  45         output width for 80-column terminal by "--stat=width".
  46         The width of the filename part can be controlled by
  47         giving another width to it separated by a comma.
  48
  49 --numstat::
  50         Similar to \--stat, but shows number of added and
  51         deleted lines in decimal notation and pathname without
  52         abbreviation, to make it more machine friendly.  For
  53         binary files, outputs two `-` instead of saying
  54         `0 0`.
  55
  56 --shortstat::
  57         Output only the last line of the --stat format containing total
  58         number of modified files, as well as number of added and deleted
  59         lines.
  60
  61 --dirstat[=limit]::
  62         Output only the sub-directories that are impacted by a diff,
  63         and to what degree they are impacted.  You can override the
  64         default cut-off in percent (3) by "--dirstat=limit".  If you
  65         want to enable "cumulative" directory statistics, you can use
  66         the "--cumulative" flag, which adds up percentages recursively
  67         even when they have been already reported for a sub-directory.
  68
  69 --summary::
  70         Output a condensed summary of extended header information
  71         such as creations, renames and mode changes.
  72
  73 --patch-with-stat::
  74         Synonym for "-p --stat".
  75         {git-format-patch? This is the default.}
  76
  77 -z::
  78         NUL-line termination on output.  This affects the --raw
  79         output field terminator.  Also output from commands such
  80         as "git-log" will be delimited with NUL between commits.
  81
  82 --name-only::
  83         Show only names of changed files.
  84
  85 --name-status::
  86         Show only names and status of changed files. See the description
  87         of the `--diff-filter` option on what the status letters mean.
  88
  89 --color::
  90         Show colored diff.
  91
  92 --no-color::
  93         Turn off colored diff, even when the configuration file
  94         gives the default to color output.
  95
  96 --color-words[=<set>]::
  97         Show colored word diff, i.e. color words which have changed.
  98 +
  99 If a set of characters is specified, it is interpreted as the range of
 100 word characters.  Example: "0-9A-Fa-f".  As a convenience, "[:alnum:]"
 101 and "[:alpha:]" expand to alpha-numeric and alpha characters,
 102 respectively.  This argument overrides the config setting
 103 'diff.wordCharacters'.
 104
 105 --no-renames::
 106         Turn off rename detection, even when the configuration
 107         file gives the default to do so.
 108
 109 --check::
 110         Warn if changes introduce trailing whitespace
 111         or an indent that uses a space before a tab. Exits with
 112         non-zero status if problems are found. Not compatible with
 113         --exit-code.
 114
 115 --full-index::
 116         Instead of the first handful characters, show full
 117         object name of pre- and post-image blob on the "index"
 118         line when generating a patch format output.
 119
 120 --binary::
 121         In addition to --full-index, output "binary diff" that
 122         can be applied with "git apply".
 123
 124 --abbrev[=<n>]::
 125         Instead of showing the full 40-byte hexadecimal object
 126         name in diff-raw format output and diff-tree header
 127         lines, show only handful hexdigits prefix.  This is
 128         independent of --full-index option above, which controls
 129         the diff-patch output format.  Non default number of
 130         digits can be specified with --abbrev=<n>.
 131
 132 -B::
 133         Break complete rewrite changes into pairs of delete and create.
 134
 135 -M::
 136         Detect renames.
 137
 138 -C::
 139         Detect copies as well as renames.  See also `--find-copies-harder`.
 140
 141 --diff-filter=[ACDMRTUXB*]::
 142         Select only files that are Added (`A`), Copied (`C`),
 143         Deleted (`D`), Modified (`M`), Renamed (`R`), have their
 144         type (mode) changed (`T`), are Unmerged (`U`), are
 145         Unknown (`X`), or have had their pairing Broken (`B`).
 146         Any combination of the filter characters may be used.
 147         When `*` (All-or-none) is added to the combination, all
 148         paths are selected if there is any file that matches
 149         other criteria in the comparison; if there is no file
 150         that matches other criteria, nothing is selected.
 151
 152 --find-copies-harder::
 153         For performance reasons, by default, `-C` option finds copies only
 154         if the original file of the copy was modified in the same
 155         changeset.  This flag makes the command
 156         inspect unmodified files as candidates for the source of
 157         copy.  This is a very expensive operation for large
 158         projects, so use it with caution.  Giving more than one
 159         `-C` option has the same effect.
 160
 161 -l<num>::
 162         -M and -C options require O(n^2) processing time where n
 163         is the number of potential rename/copy targets.  This
 164         option prevents rename/copy detection from running if
 165         the number of rename/copy targets exceeds the specified
 166         number.
 167
 168 -S<string>::
 169         Look for differences that contain the change in <string>.
 170
 171 --pickaxe-all::
 172         When -S finds a change, show all the changes in that
 173         changeset, not just the files that contain the change
 174         in <string>.
 175
 176 --pickaxe-regex::
 177         Make the <string> not a plain string but an extended POSIX
 178         regex to match.
 179
 180 -O<orderfile>::
 181         Output the patch in the order specified in the
 182         <orderfile>, which has one shell glob pattern per line.
 183
 184 -R::
 185         Swap two inputs; that is, show differences from index or
 186         on-disk file to tree contents.
 187
 188 --relative[=<path>]::
 189         When run from a subdirectory of the project, it can be
 190         told to exclude changes outside the directory and show
 191         pathnames relative to it with this option.  When you are
 192         not in a subdirectory (e.g. in a bare repository), you
 193         can name which subdirectory to make the output relative
 194         to by giving a <path> as an argument.
 195
 196 --text::
 197         Treat all files as text.
 198
 199 -a::
 200         Shorthand for "--text".
 201
 202 --ignore-space-at-eol::
 203         Ignore changes in whitespace at EOL.
 204
 205 --ignore-space-change::
 206         Ignore changes in amount of whitespace.  This ignores whitespace
 207         at line end, and considers all other sequences of one or
 208         more whitespace characters to be equivalent.
 209
 210 -b::
 211         Shorthand for "--ignore-space-change".
 212
 213 --ignore-all-space::
 214         Ignore whitespace when comparing lines.  This ignores
 215         differences even if one line has whitespace where the other
 216         line has none.
 217
 218 -w::
 219         Shorthand for "--ignore-all-space".
 220
 221 --exit-code::
 222         Make the program exit with codes similar to diff(1).
 223         That is, it exits with 1 if there were differences and
 224         0 means no differences.
 225
 226 --quiet::
 227         Disable all output of the program. Implies --exit-code.
 228
 229 --ext-diff::
 230         Allow an external diff helper to be executed. If you set an
 231         external diff driver with linkgit:gitattributes[5], you need
 232         to use this option with linkgit:git-log[1] and friends.
 233
 234 --no-ext-diff::
 235         Disallow external diff drivers.
 236
 237 --src-prefix=<prefix>::
 238         Show the given source prefix instead of "a/".
 239
 240 --dst-prefix=<prefix>::
 241         Show the given destination prefix instead of "b/".
 242
 243 --no-prefix::
 244         Do not show any source or destination prefix.
 245
 246 For more detailed explanation on these common options, see also
 247 link:diffcore.html[diffcore documentation].