Documentation / diff-options.txton commit format-patch: Add "--no-stat" as a synonym for "-p" (2cfa833)
   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--no-stat::
  18        Generate plain patches without any diffstats.
  19endif::git-format-patch[]
  20
  21ifndef::git-format-patch[]
  22-p::
  23-u::
  24        Generate patch (see section on generating patches).
  25        {git-diff? This is the default.}
  26endif::git-format-patch[]
  27
  28-U<n>::
  29--unified=<n>::
  30        Generate diffs with <n> lines of context instead of
  31        the usual three.
  32ifndef::git-format-patch[]
  33        Implies `-p`.
  34endif::git-format-patch[]
  35
  36ifndef::git-format-patch[]
  37--raw::
  38        Generate the raw format.
  39        {git-diff-core? This is the default.}
  40endif::git-format-patch[]
  41
  42ifndef::git-format-patch[]
  43--patch-with-raw::
  44        Synonym for `-p --raw`.
  45endif::git-format-patch[]
  46
  47--patience::
  48        Generate a diff using the "patience diff" algorithm.
  49
  50--stat[=width[,name-width]]::
  51        Generate a diffstat.  You can override the default
  52        output width for 80-column terminal by `--stat=width`.
  53        The width of the filename part can be controlled by
  54        giving another width to it separated by a comma.
  55
  56--numstat::
  57        Similar to `\--stat`, but shows number of added and
  58        deleted lines in decimal notation and pathname without
  59        abbreviation, to make it more machine friendly.  For
  60        binary files, outputs two `-` instead of saying
  61        `0 0`.
  62
  63--shortstat::
  64        Output only the last line of the `--stat` format containing total
  65        number of modified files, as well as number of added and deleted
  66        lines.
  67
  68--dirstat[=limit]::
  69        Output the distribution of relative amount of changes (number of lines added or
  70        removed) for each sub-directory. Directories with changes below
  71        a cut-off percent (3% by default) are not shown. The cut-off percent
  72        can be set with `--dirstat=limit`. Changes in a child directory is not
  73        counted for the parent directory, unless `--cumulative` is used.
  74
  75--dirstat-by-file[=limit]::
  76        Same as `--dirstat`, but counts changed files instead of lines.
  77
  78--summary::
  79        Output a condensed summary of extended header information
  80        such as creations, renames and mode changes.
  81
  82ifndef::git-format-patch[]
  83--patch-with-stat::
  84        Synonym for `-p --stat`.
  85endif::git-format-patch[]
  86
  87ifndef::git-format-patch[]
  88-z::
  89        NUL-line termination on output.  This affects the `--raw`
  90        output field terminator.  Also output from commands such
  91        as `git-log` will be delimited with NUL between commits.
  92
  93--name-only::
  94        Show only names of changed files.
  95
  96--name-status::
  97        Show only names and status of changed files. See the description
  98        of the `--diff-filter` option on what the status letters mean.
  99
 100--color::
 101        Show colored diff.
 102
 103--no-color::
 104        Turn off colored diff, even when the configuration file
 105        gives the default to color output.
 106
 107--color-words[=<regex>]::
 108        Show colored word diff, i.e., color words which have changed.
 109        By default, words are separated by whitespace.
 110+
 111When a <regex> is specified, every non-overlapping match of the
 112<regex> is considered a word.  Anything between these matches is
 113considered whitespace and ignored(!) for the purposes of finding
 114differences.  You may want to append `|[^[:space:]]` to your regular
 115expression to make sure that it matches all non-whitespace characters.
 116A match that contains a newline is silently truncated(!) at the
 117newline.
 118+
 119The regex can also be set via a diff driver or configuration option, see
 120linkgit:gitattributes[1] or linkgit:git-config[1].  Giving it explicitly
 121overrides any diff driver or configuration setting.  Diff drivers
 122override configuration settings.
 123endif::git-format-patch[]
 124
 125--no-renames::
 126        Turn off rename detection, even when the configuration
 127        file gives the default to do so.
 128
 129ifndef::git-format-patch[]
 130--check::
 131        Warn if changes introduce trailing whitespace
 132        or an indent that uses a space before a tab. Exits with
 133        non-zero status if problems are found. Not compatible with
 134        --exit-code.
 135endif::git-format-patch[]
 136
 137--full-index::
 138        Instead of the first handful of characters, show the full
 139        pre- and post-image blob object names on the "index"
 140        line when generating patch format output.
 141
 142--binary::
 143        In addition to `--full-index`, output a binary diff that
 144        can be applied with `git-apply`.
 145
 146--abbrev[=<n>]::
 147        Instead of showing the full 40-byte hexadecimal object
 148        name in diff-raw format output and diff-tree header
 149        lines, show only a partial prefix.  This is
 150        independent of the `--full-index` option above, which controls
 151        the diff-patch output format.  Non default number of
 152        digits can be specified with `--abbrev=<n>`.
 153
 154-B::
 155        Break complete rewrite changes into pairs of delete and create.
 156
 157-M::
 158        Detect renames.
 159
 160-C::
 161        Detect copies as well as renames.  See also `--find-copies-harder`.
 162
 163ifndef::git-format-patch[]
 164--diff-filter=[ACDMRTUXB*]::
 165        Select only files that are Added (`A`), Copied (`C`),
 166        Deleted (`D`), Modified (`M`), Renamed (`R`), have their
 167        type (i.e. regular file, symlink, submodule, ...) changed (`T`),
 168        are Unmerged (`U`), are
 169        Unknown (`X`), or have had their pairing Broken (`B`).
 170        Any combination of the filter characters may be used.
 171        When `*` (All-or-none) is added to the combination, all
 172        paths are selected if there is any file that matches
 173        other criteria in the comparison; if there is no file
 174        that matches other criteria, nothing is selected.
 175endif::git-format-patch[]
 176
 177--find-copies-harder::
 178        For performance reasons, by default, `-C` option finds copies only
 179        if the original file of the copy was modified in the same
 180        changeset.  This flag makes the command
 181        inspect unmodified files as candidates for the source of
 182        copy.  This is a very expensive operation for large
 183        projects, so use it with caution.  Giving more than one
 184        `-C` option has the same effect.
 185
 186-l<num>::
 187        The `-M` and `-C` options require O(n^2) processing time where n
 188        is the number of potential rename/copy targets.  This
 189        option prevents rename/copy detection from running if
 190        the number of rename/copy targets exceeds the specified
 191        number.
 192
 193ifndef::git-format-patch[]
 194-S<string>::
 195        Look for differences that introduce or remove an instance of
 196        <string>. Note that this is different than the string simply
 197        appearing in diff output; see the 'pickaxe' entry in
 198        linkgit:gitdiffcore[7] for more details.
 199
 200--pickaxe-all::
 201        When `-S` finds a change, show all the changes in that
 202        changeset, not just the files that contain the change
 203        in <string>.
 204
 205--pickaxe-regex::
 206        Make the <string> not a plain string but an extended POSIX
 207        regex to match.
 208endif::git-format-patch[]
 209
 210-O<orderfile>::
 211        Output the patch in the order specified in the
 212        <orderfile>, which has one shell glob pattern per line.
 213
 214ifndef::git-format-patch[]
 215-R::
 216        Swap two inputs; that is, show differences from index or
 217        on-disk file to tree contents.
 218
 219--relative[=<path>]::
 220        When run from a subdirectory of the project, it can be
 221        told to exclude changes outside the directory and show
 222        pathnames relative to it with this option.  When you are
 223        not in a subdirectory (e.g. in a bare repository), you
 224        can name which subdirectory to make the output relative
 225        to by giving a <path> as an argument.
 226endif::git-format-patch[]
 227
 228-a::
 229--text::
 230        Treat all files as text.
 231
 232--ignore-space-at-eol::
 233        Ignore changes in whitespace at EOL.
 234
 235-b::
 236--ignore-space-change::
 237        Ignore changes in amount of whitespace.  This ignores whitespace
 238        at line end, and considers all other sequences of one or
 239        more whitespace characters to be equivalent.
 240
 241-w::
 242--ignore-all-space::
 243        Ignore whitespace when comparing lines.  This ignores
 244        differences even if one line has whitespace where the other
 245        line has none.
 246
 247--inter-hunk-context=<lines>::
 248        Show the context between diff hunks, up to the specified number
 249        of lines, thereby fusing hunks that are close to each other.
 250
 251ifndef::git-format-patch[]
 252--exit-code::
 253        Make the program exit with codes similar to diff(1).
 254        That is, it exits with 1 if there were differences and
 255        0 means no differences.
 256
 257--quiet::
 258        Disable all output of the program. Implies `--exit-code`.
 259endif::git-format-patch[]
 260
 261--ext-diff::
 262        Allow an external diff helper to be executed. If you set an
 263        external diff driver with linkgit:gitattributes[5], you need
 264        to use this option with linkgit:git-log[1] and friends.
 265
 266--no-ext-diff::
 267        Disallow external diff drivers.
 268
 269--ignore-submodules::
 270        Ignore changes to submodules in the diff generation.
 271
 272--src-prefix=<prefix>::
 273        Show the given source prefix instead of "a/".
 274
 275--dst-prefix=<prefix>::
 276        Show the given destination prefix instead of "b/".
 277
 278--no-prefix::
 279        Do not show any source or destination prefix.
 280
 281For more detailed explanation on these common options, see also
 282linkgit:gitdiffcore[7].