summaryrefslogtreecommitdiff
path: root/Documentation/diff-options.txt
diff options
context:
space:
mode:
authorChristof Krüger <git@christof-krueger.de>2011-06-22 15:33:02 (GMT)
committerJunio C Hamano <gitster@pobox.com>2011-06-22 18:40:32 (GMT)
commit4f8303905eafaa04fd08a20a08a81436aea2d4b9 (patch)
treeedc0c9bfdfe3ad7361eadeb8076655dcf6e2b064 /Documentation/diff-options.txt
parenta598ded1e2e9cc9f4ce93d091808b475839e6867 (diff)
downloadgit-4f8303905eafaa04fd08a20a08a81436aea2d4b9.zip
git-4f8303905eafaa04fd08a20a08a81436aea2d4b9.tar.gz
git-4f8303905eafaa04fd08a20a08a81436aea2d4b9.tar.bz2
Documentation: git diff --check respects core.whitespace
Fix documentation on "git diff --check" by adopting the description from "git apply --whitespace". Signed-off-by: Christof Krüger <git@christof-krueger.de> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/diff-options.txt')
-rw-r--r--Documentation/diff-options.txt12
1 files changed, 8 insertions, 4 deletions
diff --git a/Documentation/diff-options.txt b/Documentation/diff-options.txt
index 80fd817..96e0a58 100644
--- a/Documentation/diff-options.txt
+++ b/Documentation/diff-options.txt
@@ -194,10 +194,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::