d34efd521835a2004ab193063a37ed2a92b4827a
   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--patch::
  25        Generate patch (see section on generating patches).
  26        {git-diff? This is the default.}
  27endif::git-format-patch[]
  28
  29-U<n>::
  30--unified=<n>::
  31        Generate diffs with <n> lines of context instead of
  32        the usual three.
  33ifndef::git-format-patch[]
  34        Implies `-p`.
  35endif::git-format-patch[]
  36
  37ifndef::git-format-patch[]
  38--raw::
  39        Generate the raw format.
  40        {git-diff-core? This is the default.}
  41endif::git-format-patch[]
  42
  43ifndef::git-format-patch[]
  44--patch-with-raw::
  45        Synonym for `-p --raw`.
  46endif::git-format-patch[]
  47
  48--minimal::
  49        Spend extra time to make sure the smallest possible
  50        diff is produced.
  51
  52--patience::
  53        Generate a diff using the "patience diff" algorithm.
  54
  55--stat[=<width>[,<name-width>[,<count>]]]::
  56        Generate a diffstat. By default, as much space as necessary
  57        will be used for the filename part, and the rest for
  58        the graph part. Maximum width defaults to terminal width,
  59        or 80 columns if not connected to a terminal, and can be
  60        overriden by `<width>`. The width of the filename part can be
  61        limited by giving another width `<name-width>` after a comma.
  62        The width of the graph part can be limited by using
  63        `--stat-graph-width=<width>`.
  64        By giving a third parameter `<count>`, you can limit the
  65        output to the first `<count>` lines, followed by `...` if
  66        there are more.
  67+
  68These parameters can also be set individually with `--stat-width=<width>`,
  69`--stat-name-width=<name-width>` and `--stat-count=<count>`.
  70
  71--numstat::
  72        Similar to `\--stat`, but shows number of added and
  73        deleted lines in decimal notation and pathname without
  74        abbreviation, to make it more machine friendly.  For
  75        binary files, outputs two `-` instead of saying
  76        `0 0`.
  77
  78--shortstat::
  79        Output only the last line of the `--stat` format containing total
  80        number of modified files, as well as number of added and deleted
  81        lines.
  82
  83--dirstat[=<param1,param2,...>]::
  84        Output the distribution of relative amount of changes for each
  85        sub-directory. The behavior of `--dirstat` can be customized by
  86        passing it a comma separated list of parameters.
  87        The defaults are controlled by the `diff.dirstat` configuration
  88        variable (see linkgit:git-config[1]).
  89        The following parameters are available:
  90+
  91--
  92`changes`;;
  93        Compute the dirstat numbers by counting the lines that have been
  94        removed from the source, or added to the destination. This ignores
  95        the amount of pure code movements within a file.  In other words,
  96        rearranging lines in a file is not counted as much as other changes.
  97        This is the default behavior when no parameter is given.
  98`lines`;;
  99        Compute the dirstat numbers by doing the regular line-based diff
 100        analysis, and summing the removed/added line counts. (For binary
 101        files, count 64-byte chunks instead, since binary files have no
 102        natural concept of lines). This is a more expensive `--dirstat`
 103        behavior than the `changes` behavior, but it does count rearranged
 104        lines within a file as much as other changes. The resulting output
 105        is consistent with what you get from the other `--*stat` options.
 106`files`;;
 107        Compute the dirstat numbers by counting the number of files changed.
 108        Each changed file counts equally in the dirstat analysis. This is
 109        the computationally cheapest `--dirstat` behavior, since it does
 110        not have to look at the file contents at all.
 111`cumulative`;;
 112        Count changes in a child directory for the parent directory as well.
 113        Note that when using `cumulative`, the sum of the percentages
 114        reported may exceed 100%. The default (non-cumulative) behavior can
 115        be specified with the `noncumulative` parameter.
 116<limit>;;
 117        An integer parameter specifies a cut-off percent (3% by default).
 118        Directories contributing less than this percentage of the changes
 119        are not shown in the output.
 120--
 121+
 122Example: The following will count changed files, while ignoring
 123directories with less than 10% of the total amount of changed files,
 124and accumulating child directory counts in the parent directories:
 125`--dirstat=files,10,cumulative`.
 126
 127--summary::
 128        Output a condensed summary of extended header information
 129        such as creations, renames and mode changes.
 130
 131ifndef::git-format-patch[]
 132--patch-with-stat::
 133        Synonym for `-p --stat`.
 134endif::git-format-patch[]
 135
 136ifndef::git-format-patch[]
 137
 138-z::
 139ifdef::git-log[]
 140        Separate the commits with NULs instead of with new newlines.
 141+
 142Also, when `--raw` or `--numstat` has been given, do not munge
 143pathnames and use NULs as output field terminators.
 144endif::git-log[]
 145ifndef::git-log[]
 146        When `--raw`, `--numstat`, `--name-only` or `--name-status` has been
 147        given, do not munge pathnames and use NULs as output field terminators.
 148endif::git-log[]
 149+
 150Without this option, each pathname output will have TAB, LF, double quotes,
 151and backslash characters replaced with `\t`, `\n`, `\"`, and `\\`,
 152respectively, and the pathname will be enclosed in double quotes if
 153any of those replacements occurred.
 154
 155--name-only::
 156        Show only names of changed files.
 157
 158--name-status::
 159        Show only names and status of changed files. See the description
 160        of the `--diff-filter` option on what the status letters mean.
 161
 162--submodule[=<format>]::
 163        Chose the output format for submodule differences. <format> can be one of
 164        'short' and 'log'. 'short' just shows pairs of commit names, this format
 165        is used when this option is not given. 'log' is the default value for this
 166        option and lists the commits in that commit range like the 'summary'
 167        option of linkgit:git-submodule[1] does.
 168
 169--color[=<when>]::
 170        Show colored diff.
 171        The value must be `always` (the default for `<when>`), `never`, or `auto`.
 172        The default value is `never`.
 173ifdef::git-diff[]
 174        It can be changed by the `color.ui` and `color.diff`
 175        configuration settings.
 176endif::git-diff[]
 177
 178--no-color::
 179        Turn off colored diff.
 180ifdef::git-diff[]
 181        This can be used to override configuration settings.
 182endif::git-diff[]
 183        It is the same as `--color=never`.
 184
 185--word-diff[=<mode>]::
 186        Show a word diff, using the <mode> to delimit changed words.
 187        By default, words are delimited by whitespace; see
 188        `--word-diff-regex` below.  The <mode> defaults to 'plain', and
 189        must be one of:
 190+
 191--
 192color::
 193        Highlight changed words using only colors.  Implies `--color`.
 194plain::
 195        Show words as `[-removed-]` and `{+added+}`.  Makes no
 196        attempts to escape the delimiters if they appear in the input,
 197        so the output may be ambiguous.
 198porcelain::
 199        Use a special line-based format intended for script
 200        consumption.  Added/removed/unchanged runs are printed in the
 201        usual unified diff format, starting with a `+`/`-`/` `
 202        character at the beginning of the line and extending to the
 203        end of the line.  Newlines in the input are represented by a
 204        tilde `~` on a line of its own.
 205none::
 206        Disable word diff again.
 207--
 208+
 209Note that despite the name of the first mode, color is used to
 210highlight the changed parts in all modes if enabled.
 211
 212--word-diff-regex=<regex>::
 213        Use <regex> to decide what a word is, instead of considering
 214        runs of non-whitespace to be a word.  Also implies
 215        `--word-diff` unless it was already enabled.
 216+
 217Every non-overlapping match of the
 218<regex> is considered a word.  Anything between these matches is
 219considered whitespace and ignored(!) for the purposes of finding
 220differences.  You may want to append `|[^[:space:]]` to your regular
 221expression to make sure that it matches all non-whitespace characters.
 222A match that contains a newline is silently truncated(!) at the
 223newline.
 224+
 225The regex can also be set via a diff driver or configuration option, see
 226linkgit:gitattributes[1] or linkgit:git-config[1].  Giving it explicitly
 227overrides any diff driver or configuration setting.  Diff drivers
 228override configuration settings.
 229
 230--color-words[=<regex>]::
 231        Equivalent to `--word-diff=color` plus (if a regex was
 232        specified) `--word-diff-regex=<regex>`.
 233endif::git-format-patch[]
 234
 235--no-renames::
 236        Turn off rename detection, even when the configuration
 237        file gives the default to do so.
 238
 239ifndef::git-format-patch[]
 240--check::
 241        Warn if changes introduce whitespace errors.  What are
 242        considered whitespace errors is controlled by `core.whitespace`
 243        configuration.  By default, trailing whitespaces (including
 244        lines that solely consist of whitespaces) and a space character
 245        that is immediately followed by a tab character inside the
 246        initial indent of the line are considered whitespace errors.
 247        Exits with non-zero status if problems are found. Not compatible
 248        with --exit-code.
 249endif::git-format-patch[]
 250
 251--full-index::
 252        Instead of the first handful of characters, show the full
 253        pre- and post-image blob object names on the "index"
 254        line when generating patch format output.
 255
 256--binary::
 257        In addition to `--full-index`, output a binary diff that
 258        can be applied with `git-apply`.
 259
 260--abbrev[=<n>]::
 261        Instead of showing the full 40-byte hexadecimal object
 262        name in diff-raw format output and diff-tree header
 263        lines, show only a partial prefix.  This is
 264        independent of the `--full-index` option above, which controls
 265        the diff-patch output format.  Non default number of
 266        digits can be specified with `--abbrev=<n>`.
 267
 268-B[<n>][/<m>]::
 269--break-rewrites[=[<n>][/<m>]]::
 270        Break complete rewrite changes into pairs of delete and
 271        create. This serves two purposes:
 272+
 273It affects the way a change that amounts to a total rewrite of a file
 274not as a series of deletion and insertion mixed together with a very
 275few lines that happen to match textually as the context, but as a
 276single deletion of everything old followed by a single insertion of
 277everything new, and the number `m` controls this aspect of the -B
 278option (defaults to 60%). `-B/70%` specifies that less than 30% of the
 279original should remain in the result for git to consider it a total
 280rewrite (i.e. otherwise the resulting patch will be a series of
 281deletion and insertion mixed together with context lines).
 282+
 283When used with -M, a totally-rewritten file is also considered as the
 284source of a rename (usually -M only considers a file that disappeared
 285as the source of a rename), and the number `n` controls this aspect of
 286the -B option (defaults to 50%). `-B20%` specifies that a change with
 287addition and deletion compared to 20% or more of the file's size are
 288eligible for being picked up as a possible source of a rename to
 289another file.
 290
 291-M[<n>]::
 292--find-renames[=<n>]::
 293ifndef::git-log[]
 294        Detect renames.
 295endif::git-log[]
 296ifdef::git-log[]
 297        If generating diffs, detect and report renames for each commit.
 298        For following files across renames while traversing history, see
 299        `--follow`.
 300endif::git-log[]
 301        If `n` is specified, it is a threshold on the similarity
 302        index (i.e. amount of addition/deletions compared to the
 303        file's size). For example, `-M90%` means git should consider a
 304        delete/add pair to be a rename if more than 90% of the file
 305        hasn't changed.
 306
 307-C[<n>]::
 308--find-copies[=<n>]::
 309        Detect copies as well as renames.  See also `--find-copies-harder`.
 310        If `n` is specified, it has the same meaning as for `-M<n>`.
 311
 312--find-copies-harder::
 313        For performance reasons, by default, `-C` option finds copies only
 314        if the original file of the copy was modified in the same
 315        changeset.  This flag makes the command
 316        inspect unmodified files as candidates for the source of
 317        copy.  This is a very expensive operation for large
 318        projects, so use it with caution.  Giving more than one
 319        `-C` option has the same effect.
 320
 321-D::
 322--irreversible-delete::
 323        Omit the preimage for deletes, i.e. print only the header but not
 324        the diff between the preimage and `/dev/null`. The resulting patch
 325        is not meant to be applied with `patch` nor `git apply`; this is
 326        solely for people who want to just concentrate on reviewing the
 327        text after the change. In addition, the output obviously lack
 328        enough information to apply such a patch in reverse, even manually,
 329        hence the name of the option.
 330+
 331When used together with `-B`, omit also the preimage in the deletion part
 332of a delete/create pair.
 333
 334-l<num>::
 335        The `-M` and `-C` options require O(n^2) processing time where n
 336        is the number of potential rename/copy targets.  This
 337        option prevents rename/copy detection from running if
 338        the number of rename/copy targets exceeds the specified
 339        number.
 340
 341ifndef::git-format-patch[]
 342--diff-filter=[(A|C|D|M|R|T|U|X|B)...[*]]::
 343        Select only files that are Added (`A`), Copied (`C`),
 344        Deleted (`D`), Modified (`M`), Renamed (`R`), have their
 345        type (i.e. regular file, symlink, submodule, ...) changed (`T`),
 346        are Unmerged (`U`), are
 347        Unknown (`X`), or have had their pairing Broken (`B`).
 348        Any combination of the filter characters (including none) can be used.
 349        When `*` (All-or-none) is added to the combination, all
 350        paths are selected if there is any file that matches
 351        other criteria in the comparison; if there is no file
 352        that matches other criteria, nothing is selected.
 353
 354-S<string>::
 355        Look for differences that introduce or remove an instance of
 356        <string>. Note that this is different than the string simply
 357        appearing in diff output; see the 'pickaxe' entry in
 358        linkgit:gitdiffcore[7] for more details.
 359
 360-G<regex>::
 361        Look for differences whose added or removed line matches
 362        the given <regex>.
 363
 364--pickaxe-all::
 365        When `-S` or `-G` finds a change, show all the changes in that
 366        changeset, not just the files that contain the change
 367        in <string>.
 368
 369--pickaxe-regex::
 370        Make the <string> not a plain string but an extended POSIX
 371        regex to match.
 372endif::git-format-patch[]
 373
 374-O<orderfile>::
 375        Output the patch in the order specified in the
 376        <orderfile>, which has one shell glob pattern per line.
 377
 378ifndef::git-format-patch[]
 379-R::
 380        Swap two inputs; that is, show differences from index or
 381        on-disk file to tree contents.
 382
 383--relative[=<path>]::
 384        When run from a subdirectory of the project, it can be
 385        told to exclude changes outside the directory and show
 386        pathnames relative to it with this option.  When you are
 387        not in a subdirectory (e.g. in a bare repository), you
 388        can name which subdirectory to make the output relative
 389        to by giving a <path> as an argument.
 390endif::git-format-patch[]
 391
 392-a::
 393--text::
 394        Treat all files as text.
 395
 396--ignore-space-at-eol::
 397        Ignore changes in whitespace at EOL.
 398
 399-b::
 400--ignore-space-change::
 401        Ignore changes in amount of whitespace.  This ignores whitespace
 402        at line end, and considers all other sequences of one or
 403        more whitespace characters to be equivalent.
 404
 405-w::
 406--ignore-all-space::
 407        Ignore whitespace when comparing lines.  This ignores
 408        differences even if one line has whitespace where the other
 409        line has none.
 410
 411--inter-hunk-context=<lines>::
 412        Show the context between diff hunks, up to the specified number
 413        of lines, thereby fusing hunks that are close to each other.
 414
 415-W::
 416--function-context::
 417        Show whole surrounding functions of changes.
 418
 419ifndef::git-format-patch[]
 420ifndef::git-log[]
 421--exit-code::
 422        Make the program exit with codes similar to diff(1).
 423        That is, it exits with 1 if there were differences and
 424        0 means no differences.
 425
 426--quiet::
 427        Disable all output of the program. Implies `--exit-code`.
 428endif::git-log[]
 429endif::git-format-patch[]
 430
 431--ext-diff::
 432        Allow an external diff helper to be executed. If you set an
 433        external diff driver with linkgit:gitattributes[5], you need
 434        to use this option with linkgit:git-log[1] and friends.
 435
 436--no-ext-diff::
 437        Disallow external diff drivers.
 438
 439--textconv::
 440--no-textconv::
 441        Allow (or disallow) external text conversion filters to be run
 442        when comparing binary files. See linkgit:gitattributes[5] for
 443        details. Because textconv filters are typically a one-way
 444        conversion, the resulting diff is suitable for human
 445        consumption, but cannot be applied. For this reason, textconv
 446        filters are enabled by default only for linkgit:git-diff[1] and
 447        linkgit:git-log[1], but not for linkgit:git-format-patch[1] or
 448        diff plumbing commands.
 449
 450--ignore-submodules[=<when>]::
 451        Ignore changes to submodules in the diff generation. <when> can be
 452        either "none", "untracked", "dirty" or "all", which is the default
 453        Using "none" will consider the submodule modified when it either contains
 454        untracked or modified files or its HEAD differs from the commit recorded
 455        in the superproject and can be used to override any settings of the
 456        'ignore' option in linkgit:git-config[1] or linkgit:gitmodules[5]. When
 457        "untracked" is used submodules are not considered dirty when they only
 458        contain untracked content (but they are still scanned for modified
 459        content). Using "dirty" ignores all changes to the work tree of submodules,
 460        only changes to the commits stored in the superproject are shown (this was
 461        the behavior until 1.7.0). Using "all" hides all changes to submodules.
 462
 463--src-prefix=<prefix>::
 464        Show the given source prefix instead of "a/".
 465
 466--dst-prefix=<prefix>::
 467        Show the given destination prefix instead of "b/".
 468
 469--no-prefix::
 470        Do not show any source or destination prefix.
 471
 472For more detailed explanation on these common options, see also
 473linkgit:gitdiffcore[7].