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