Merge branch 'maint'
authorJunio C Hamano <gitster@pobox.com>
Wed, 22 Jun 2011 21:01:18 +0000 (14:01 -0700)
committerJunio C Hamano <gitster@pobox.com>
Wed, 22 Jun 2011 21:01:18 +0000 (14:01 -0700)
* maint:
Documentation: git diff --check respects core.whitespace

1  2 
Documentation/diff-options.txt
index c7ed94635786789baca1de41d482cd6334d1181a,96e0a581a1206ff7c258c8f9e7235d16972d584e..24f189f96b760dc9201a202827351ca82aab6780
@@@ -66,49 -66,19 +66,49 @@@ endif::git-format-patch[
        number of modified files, as well as number of added and deleted
        lines.
  
 ---dirstat[=<limit>]::
 -      Output the distribution of relative amount of changes (number of lines added or
 -      removed) for each sub-directory. Directories with changes below
 -      a cut-off percent (3% by default) are not shown. The cut-off percent
 -      can be set with `--dirstat=<limit>`. Changes in a child directory are not
 -      counted for the parent directory, unless `--cumulative` is used.
 +--dirstat[=<param1,param2,...>]::
 +      Output the distribution of relative amount of changes for each
 +      sub-directory. The behavior of `--dirstat` can be customized by
 +      passing it a comma separated list of parameters.
 +      The defaults are controlled by the `diff.dirstat` configuration
 +      variable (see linkgit:git-config[1]).
 +      The following parameters are available:
  +
 -Note that the `--dirstat` option computes the changes while ignoring
 -the amount of pure code movements within a file.  In other words,
 -rearranging lines in a file is not counted as much as other changes.
 -
 ---dirstat-by-file[=<limit>]::
 -      Same as `--dirstat`, but counts changed files instead of lines.
 +--
 +`changes`;;
 +      Compute the dirstat numbers by counting the lines that have been
 +      removed from the source, or added to the destination. This ignores
 +      the amount of pure code movements within a file.  In other words,
 +      rearranging lines in a file is not counted as much as other changes.
 +      This is the default behavior when no parameter is given.
 +`lines`;;
 +      Compute the dirstat numbers by doing the regular line-based diff
 +      analysis, and summing the removed/added line counts. (For binary
 +      files, count 64-byte chunks instead, since binary files have no
 +      natural concept of lines). This is a more expensive `--dirstat`
 +      behavior than the `changes` behavior, but it does count rearranged
 +      lines within a file as much as other changes. The resulting output
 +      is consistent with what you get from the other `--*stat` options.
 +`files`;;
 +      Compute the dirstat numbers by counting the number of files changed.
 +      Each changed file counts equally in the dirstat analysis. This is
 +      the computationally cheapest `--dirstat` behavior, since it does
 +      not have to look at the file contents at all.
 +`cumulative`;;
 +      Count changes in a child directory for the parent directory as well.
 +      Note that when using `cumulative`, the sum of the percentages
 +      reported may exceed 100%. The default (non-cumulative) behavior can
 +      be specified with the `noncumulative` parameter.
 +<limit>;;
 +      An integer parameter specifies a cut-off percent (3% by default).
 +      Directories contributing less than this percentage of the changes
 +      are not shown in the output.
 +--
 ++
 +Example: The following will count changed files, while ignoring
 +directories with less than 10% of the total amount of changed files,
 +and accumulating child directory counts in the parent directories:
 +`--dirstat=files,10,cumulative`.
  
  --summary::
        Output a condensed summary of extended header information
@@@ -224,10 -194,14 +224,14 @@@ endif::git-format-patch[
  
  ifndef::git-format-patch[]
  --check::
-       Warn if changes introduce trailing whitespace
-       or an indent that uses a space before a tab. Exits with
-       non-zero status if problems are found. Not compatible with
-       --exit-code.
+       Warn if changes introduce whitespace errors.  What are
+       considered whitespace errors is controlled by `core.whitespace`
+       configuration.  By default, trailing whitespaces (including
+       lines that solely consist of whitespaces) and a space character
+       that is immediately followed by a tab character inside the
+       initial indent of the line are considered whitespace errors.
+       Exits with non-zero status if problems are found. Not compatible
+       with --exit-code.
  endif::git-format-patch[]
  
  --full-index::
@@@ -300,19 -274,6 +304,19 @@@ endif::git-log[
        projects, so use it with caution.  Giving more than one
        `-C` option has the same effect.
  
 +-D::
 +--irreversible-delete::
 +      Omit the preimage for deletes, i.e. print only the header but not
 +      the diff between the preimage and `/dev/null`. The resulting patch
 +      is not meant to be applied with `patch` nor `git apply`; this is
 +      solely for people who want to just concentrate on reviewing the
 +      text after the change. In addition, the output obviously lack
 +      enough information to apply such a patch in reverse, even manually,
 +      hence the name of the option.
 ++
 +When used together with `-B`, omit also the preimage in the deletion part
 +of a delete/create pair.
 +
  -l<num>::
        The `-M` and `-C` options require O(n^2) processing time where n
        is the number of potential rename/copy targets.  This