[PATCH] Documentation: git diff --check respects core.whitespace

[PATCH] Documentation: git diff --check respects core.whitespace

[Christof Krüger]

Fix documentation on "git diff --check" by adopting the description from
"git apply --whitespace".

Signed-off-by: Christof Krüger <git@christof-krueger.de>
---
 Documentation/diff-options.txt |   12 ++++++++----
 1 files changed, 8 insertions(+), 4 deletions(-)

diff --git a/Documentation/diff-options.txt b/Documentation/diff-options.txt
index c7ed946..24f189f 100644
--- a/Documentation/diff-options.txt
+++ b/Documentation/diff-options.txt
@@ -224,10 +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::
-- 
1.7.6.rc2

Re: [PATCH] Documentation: git diff --check respects core.whitespace

[Sverre Rabbelier]

Heya,

2011/6/22 Christof Krüger <git@christof-krueger.de>:
> What are considered whitespace errors is controlled by `core.whitespace`

Am I the only one who fees that "What are considered <plural>" would
sound better if phrased "What is considered a <singular>"? Is it
because I haven't heard the phrase much, or is the latter actually
better somehow?


-- 
Cheers,

Sverre Rabbelier

Re: [PATCH] Documentation: git diff --check respects core.whitespace

[Junio C Hamano]

Sverre Rabbelier <srabbelier@gmail.com> writes:

> Heya,
>
> 2011/6/22 Christof Krüger <git@christof-krueger.de>:
>> What are considered whitespace errors is controlled by `core.whitespace`
>
> Am I the only one who fees that "What are considered <plural>" would
> sound better if phrased "What is considered a <singular>"? Is it
> because I haven't heard the phrase much, or is the latter actually
> better somehow?

Perhaps. In any case, the original description seems to have been
inadequate for somebody to understand what it does, so the patch is an
improvement; I've queued it.

Thanks.