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