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 --patience:
  44         Generate a diff using the "patience diff" algorithm.
  45
  46 --stat[=width[,name-width]]::
  47         Generate a diffstat.  You can override the default
  48         output width for 80-column terminal by "--stat=width".
  49         The width of the filename part can be controlled by
  50         giving another width to it separated by a comma.
  51
  52 --numstat::
  53         Similar to \--stat, but shows number of added and
  54         deleted lines in decimal notation and pathname without
  55         abbreviation, to make it more machine friendly.  For
  56         binary files, outputs two `-` instead of saying
  57         `0 0`.
  58
  59 --shortstat::
  60         Output only the last line of the --stat format containing total
  61         number of modified files, as well as number of added and deleted
  62         lines.
  63
  64 --dirstat[=limit]::
  65         Output the distribution of relative amount of changes (number of lines added or
  66         removed) for each sub-directory. Directories with changes below
  67         a cut-off percent (3% by default) are not shown. The cut-off percent
  68         can be set with "--dirstat=limit". Changes in a child directory is not
  69         counted for the parent directory, unless "--cumulative" is used.
  70
  71 --dirstat-by-file[=limit]::
  72         Same as --dirstat, but counts changed files instead of lines.
  73
  74 --summary::
  75         Output a condensed summary of extended header information
  76         such as creations, renames and mode changes.
  77
  78 --patch-with-stat::
  79         Synonym for "-p --stat".
  80         {git-format-patch? This is the default.}
  81
  82 -z::
  83         NUL-line termination on output.  This affects the --raw
  84         output field terminator.  Also output from commands such
  85         as "git-log" will be delimited with NUL between commits.
  86
  87 --name-only::
  88         Show only names of changed files.
  89
  90 --name-status::
  91         Show only names and status of changed files. See the description
  92         of the `--diff-filter` option on what the status letters mean.
  93
  94 --color::
  95         Show colored diff.
  96
  97 --no-color::
  98         Turn off colored diff, even when the configuration file
  99         gives the default to color output.
 100
 101 --color-words::
 102         Show colored word diff, i.e. color words which have changed.
 103
 104 --no-renames::
 105         Turn off rename detection, even when the configuration
 106         file gives the default to do so.
 107
 108 --check::
 109         Warn if changes introduce trailing whitespace
 110         or an indent that uses a space before a tab. Exits with
 111         non-zero status if problems are found. Not compatible with
 112         --exit-code.
 113
 114 --full-index::
 115         Instead of the first handful of characters, show the full
 116         pre- and post-image blob object names on the "index"
 117         line when generating patch format output.
 118
 119 --binary::
 120         In addition to --full-index, output "binary diff" that
 121         can be applied with "git apply".
 122
 123 --abbrev[=<n>]::
 124         Instead of showing the full 40-byte hexadecimal object
 125         name in diff-raw format output and diff-tree header
 126         lines, show only handful hexdigits prefix.  This is
 127         independent of --full-index option above, which controls
 128         the diff-patch output format.  Non default number of
 129         digits can be specified with --abbrev=<n>.
 130
 131 -B::
 132         Break complete rewrite changes into pairs of delete and create.
 133
 134 -M::
 135         Detect renames.
 136
 137 -C::
 138         Detect copies as well as renames.  See also `--find-copies-harder`.
 139
 140 --diff-filter=[ACDMRTUXB*]::
 141         Select only files that are Added (`A`), Copied (`C`),
 142         Deleted (`D`), Modified (`M`), Renamed (`R`), have their
 143         type (i.e. regular file, symlink, submodule, ...) changed (`T`),
 144         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 --ignore-submodules::
 238         Ignore changes to submodules in the diff generation.
 239
 240 --src-prefix=<prefix>::
 241         Show the given source prefix instead of "a/".
 242
 243 --dst-prefix=<prefix>::
 244         Show the given destination prefix instead of "b/".
 245
 246 --no-prefix::
 247         Do not show any source or destination prefix.
 248
 249 For more detailed explanation on these common options, see also
 250 linkgit:gitdiffcore[7].