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

Subsystems: documentation, the rest

DORMANTno replies

2 messages, 2 authors, 2016-06-15 · open the first message on its own page

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

From: Christof Krüger <hidden>
Date: 2016-06-15 22:51:31

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

Signed-off-by: Christof Krüger <redacted>
---
 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

From: Sverre Rabbelier <hidden>
Date: 2016-06-15 22:51:31

Heya,

2011/6/22 Christof Krüger [off-list ref]:
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
Keyboard shortcuts
hback out one level
jnext message in thread
kprevious message in thread
ldrill in
Escclose help / fold thread tree
?toggle this help