Documentation / diff-options.txton commit Merge branch 'js/maint-all-implies-HEAD' (f18e6be)
   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-u::
  23        Generate patch (see section on generating patches).
  24        {git-diff? This is the default.}
  25endif::git-format-patch[]
  26
  27-U<n>::
  28--unified=<n>::
  29        Generate diffs with <n> lines of context instead of
  30        the usual three. Implies "-p".
  31
  32--raw::
  33        Generate the raw format.
  34        {git-diff-core? This is the default.}
  35
  36--patch-with-raw::
  37        Synonym for "-p --raw".
  38
  39--patience::
  40        Generate a diff using the "patience diff" algorithm.
  41
  42--stat[=width[,name-width]]::
  43        Generate a diffstat.  You can override the default
  44        output width for 80-column terminal by "--stat=width".
  45        The width of the filename part can be controlled by
  46        giving another width to it separated by a comma.
  47
  48--numstat::
  49        Similar to \--stat, but shows number of added and
  50        deleted lines in decimal notation and pathname without
  51        abbreviation, to make it more machine friendly.  For
  52        binary files, outputs two `-` instead of saying
  53        `0 0`.
  54
  55--shortstat::
  56        Output only the last line of the --stat format containing total
  57        number of modified files, as well as number of added and deleted
  58        lines.
  59
  60--dirstat[=limit]::
  61        Output the distribution of relative amount of changes (number of lines added or
  62        removed) for each sub-directory. Directories with changes below
  63        a cut-off percent (3% by default) are not shown. The cut-off percent
  64        can be set with "--dirstat=limit". Changes in a child directory is not
  65        counted for the parent directory, unless "--cumulative" is used.
  66
  67--dirstat-by-file[=limit]::
  68        Same as --dirstat, but counts changed files instead of lines.
  69
  70--summary::
  71        Output a condensed summary of extended header information
  72        such as creations, renames and mode changes.
  73
  74--patch-with-stat::
  75        Synonym for "-p --stat".
  76        {git-format-patch? This is the default.}
  77
  78-z::
  79        NUL-line termination on output.  This affects the --raw
  80        output field terminator.  Also output from commands such
  81        as "git-log" will be delimited with NUL between commits.
  82
  83--name-only::
  84        Show only names of changed files.
  85
  86--name-status::
  87        Show only names and status of changed files. See the description
  88        of the `--diff-filter` option on what the status letters mean.
  89
  90--color::
  91        Show colored diff.
  92
  93--no-color::
  94        Turn off colored diff, even when the configuration file
  95        gives the default to color output.
  96
  97--color-words::
  98        Show colored word diff, i.e. color words which have changed.
  99
 100--no-renames::
 101        Turn off rename detection, even when the configuration
 102        file gives the default to do so.
 103
 104--check::
 105        Warn if changes introduce trailing whitespace
 106        or an indent that uses a space before a tab. Exits with
 107        non-zero status if problems are found. Not compatible with
 108        --exit-code.
 109
 110--full-index::
 111        Instead of the first handful of characters, show the full
 112        pre- and post-image blob object names on the "index"
 113        line when generating patch format output.
 114
 115--binary::
 116        In addition to --full-index, output "binary diff" that
 117        can be applied with "git apply".
 118
 119--abbrev[=<n>]::
 120        Instead of showing the full 40-byte hexadecimal object
 121        name in diff-raw format output and diff-tree header
 122        lines, show only a partial prefix.  This is
 123        independent of --full-index option above, which controls
 124        the diff-patch output format.  Non default number of
 125        digits can be specified with --abbrev=<n>.
 126
 127-B::
 128        Break complete rewrite changes into pairs of delete and create.
 129
 130-M::
 131        Detect renames.
 132
 133-C::
 134        Detect copies as well as renames.  See also `--find-copies-harder`.
 135
 136--diff-filter=[ACDMRTUXB*]::
 137        Select only files that are Added (`A`), Copied (`C`),
 138        Deleted (`D`), Modified (`M`), Renamed (`R`), have their
 139        type (i.e. regular file, symlink, submodule, ...) changed (`T`),
 140        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-a::
 193--text::
 194        Treat all files as text.
 195
 196--ignore-space-at-eol::
 197        Ignore changes in whitespace at EOL.
 198
 199-b::
 200--ignore-space-change::
 201        Ignore changes in amount of whitespace.  This ignores whitespace
 202        at line end, and considers all other sequences of one or
 203        more whitespace characters to be equivalent.
 204
 205-w::
 206--ignore-all-space::
 207        Ignore whitespace when comparing lines.  This ignores
 208        differences even if one line has whitespace where the other
 209        line has none.
 210
 211--inter-hunk-context=<lines>::
 212        Show the context between diff hunks, up to the specified number
 213        of lines, thereby fusing hunks that are close to each other.
 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--ignore-submodules::
 232        Ignore changes to submodules in the diff generation.
 233
 234--src-prefix=<prefix>::
 235        Show the given source prefix instead of "a/".
 236
 237--dst-prefix=<prefix>::
 238        Show the given destination prefix instead of "b/".
 239
 240--no-prefix::
 241        Do not show any source or destination prefix.
 242
 243For more detailed explanation on these common options, see also
 244linkgit:gitdiffcore[7].