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>
Christof Krüger committed
Jun 22, 2011 at 17:33 UTC
4f8303905eafaa04fd08a20a08a81436aea2d4b9
1 file changed
+8
-4
Documentation/diff-options.txt
+8
-4
@@ -194,10 +194,14 @@ endif::git-format-patch[]
194
195
ifndef::git-format-patch[]
196
--check::
197
- Warn if changes introduce trailing whitespace
198
- or an indent that uses a space before a tab. Exits with
199
- non-zero status if problems are found. Not compatible with
200
- --exit-code.
197
+ Warn if changes introduce whitespace errors. What are
198
+ considered whitespace errors is controlled by `core.whitespace`
199
+ configuration. By default, trailing whitespaces (including
200
+ lines that solely consist of whitespaces) and a space character
201
+ that is immediately followed by a tab character inside the
202
+ initial indent of the line are considered whitespace errors.
203
+ Exits with non-zero status if problems are found. Not compatible
204
+ with --exit-code.
205
endif::git-format-patch[]
206
207
--full-index::