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 the distribution of relative amount of changes (number of lines added or
  63         removed) for each sub-directory. Directories with changes below
  64         a cut-off percent (3% by default) are not shown. The cut-off percent
  65         can be set with "--dirstat=limit". Changes in a child directory is not
  66         counted for the parent directory, unless "--cumulative" is used.
  67
  68 --dirstat-by-file[=limit]::
  69         Same as --dirstat, but counts changed files instead of lines.
  70
  71 --summary::
  72         Output a condensed summary of extended header information
  73         such as creations, renames and mode changes.
  74
  75 --patch-with-stat::
  76         Synonym for "-p --stat".
  77         {git-format-patch? This is the default.}
  78
  79 -z::
  80         NUL-line termination on output.  This affects the --raw
  81         output field terminator.  Also output from commands such
  82         as "git-log" will be delimited with NUL between commits.
  83
  84 --name-only::
  85         Show only names of changed files.
  86
  87 --name-status::
  88         Show only names and status of changed files. See the description
  89         of the `--diff-filter` option on what the status letters mean.
  90
  91 --color::
  92         Show colored diff.
  93
  94 --no-color::
  95         Turn off colored diff, even when the configuration file
  96         gives the default to color output.
  97
  98 --color-words::
  99         Show colored word diff, i.e. color words which have changed.
 100
 101 --no-renames::
 102         Turn off rename detection, even when the configuration
 103         file gives the default to do so.
 104
 105 --check::
 106         Warn if changes introduce trailing whitespace
 107         or an indent that uses a space before a tab. Exits with
 108         non-zero status if problems are found. Not compatible with
 109         --exit-code.
 110
 111 --full-index::
 112         Instead of the first handful of characters, show the full
 113         pre- and post-image blob object names on the "index"
 114         line when generating patch format output.
 115
 116 --binary::
 117         In addition to --full-index, output "binary diff" that
 118         can be applied with "git apply".
 119
 120 --abbrev[=<n>]::
 121         Instead of showing the full 40-byte hexadecimal object
 122         name in diff-raw format output and diff-tree header
 123         lines, show only handful hexdigits prefix.  This is
 124         independent of --full-index option above, which controls
 125         the diff-patch output format.  Non default number of
 126         digits can be specified with --abbrev=<n>.
 127
 128 -B::
 129         Break complete rewrite changes into pairs of delete and create.
 130
 131 -M::
 132         Detect renames.
 133
 134 -C::
 135         Detect copies as well as renames.  See also `--find-copies-harder`.
 136
 137 --diff-filter=[ACDMRTUXB*]::
 138         Select only files that are Added (`A`), Copied (`C`),
 139         Deleted (`D`), Modified (`M`), Renamed (`R`), have their
 140         type (mode) changed (`T`), are Unmerged (`U`), are
 141         Unknown (`X`), or have had their pairing Broken (`B`).
 142         Any combination of the filter characters may be used.
 143         When `*` (All-or-none) is added to the combination, all
 144         paths are selected if there is any file that matches
 145         other criteria in the comparison; if there is no file
 146         that matches other criteria, nothing is selected.
 147
 148 --find-copies-harder::
 149         For performance reasons, by default, `-C` option finds copies only
 150         if the original file of the copy was modified in the same
 151         changeset.  This flag makes the command
 152         inspect unmodified files as candidates for the source of
 153         copy.  This is a very expensive operation for large
 154         projects, so use it with caution.  Giving more than one
 155         `-C` option has the same effect.
 156
 157 -l<num>::
 158         -M and -C options require O(n^2) processing time where n
 159         is the number of potential rename/copy targets.  This
 160         option prevents rename/copy detection from running if
 161         the number of rename/copy targets exceeds the specified
 162         number.
 163
 164 -S<string>::
 165         Look for differences that contain the change in <string>.
 166
 167 --pickaxe-all::
 168         When -S finds a change, show all the changes in that
 169         changeset, not just the files that contain the change
 170         in <string>.
 171
 172 --pickaxe-regex::
 173         Make the <string> not a plain string but an extended POSIX
 174         regex to match.
 175
 176 -O<orderfile>::
 177         Output the patch in the order specified in the
 178         <orderfile>, which has one shell glob pattern per line.
 179
 180 -R::
 181         Swap two inputs; that is, show differences from index or
 182         on-disk file to tree contents.
 183
 184 --relative[=<path>]::
 185         When run from a subdirectory of the project, it can be
 186         told to exclude changes outside the directory and show
 187         pathnames relative to it with this option.  When you are
 188         not in a subdirectory (e.g. in a bare repository), you
 189         can name which subdirectory to make the output relative
 190         to by giving a <path> as an argument.
 191
 192 --text::
 193         Treat all files as text.
 194
 195 -a::
 196         Shorthand for "--text".
 197
 198 --ignore-space-at-eol::
 199         Ignore changes in whitespace at EOL.
 200
 201 --ignore-space-change::
 202         Ignore changes in amount of whitespace.  This ignores whitespace
 203         at line end, and considers all other sequences of one or
 204         more whitespace characters to be equivalent.
 205
 206 -b::
 207         Shorthand for "--ignore-space-change".
 208
 209 --ignore-all-space::
 210         Ignore whitespace when comparing lines.  This ignores
 211         differences even if one line has whitespace where the other
 212         line has none.
 213
 214 -w::
 215         Shorthand for "--ignore-all-space".
 216
 217 --exit-code::
 218         Make the program exit with codes similar to diff(1).
 219         That is, it exits with 1 if there were differences and
 220         0 means no differences.
 221
 222 --quiet::
 223         Disable all output of the program. Implies --exit-code.
 224
 225 --ext-diff::
 226         Allow an external diff helper to be executed. If you set an
 227         external diff driver with linkgit:gitattributes[5], you need
 228         to use this option with linkgit:git-log[1] and friends.
 229
 230 --no-ext-diff::
 231         Disallow external diff drivers.
 232
 233 --ignore-submodules::
 234         Ignore changes to submodules in the diff generation.
 235
 236 --src-prefix=<prefix>::
 237         Show the given source prefix instead of "a/".
 238
 239 --dst-prefix=<prefix>::
 240         Show the given destination prefix instead of "b/".
 241
 242 --no-prefix::
 243         Do not show any source or destination prefix.
 244
 245 For more detailed explanation on these common options, see also
 246 linkgit:gitdiffcore[7].