[PATCH] Document check option to git diff.
From: Bill Lear <rael@zopyra.com>
Signed-off-by: Bill Lear <rael@zopyra.com>
---
Documentation/SubmittingPatches | 3 ++-
Documentation/diff-options.txt | 5 +++++
Documentation/git-diff.txt | 6 ++++++
3 files changed, 13 insertions(+), 1 deletions(-)
diff --git a/Documentation/SubmittingPatches b/Documentation/SubmittingPatches
index 41b76d8..ce85d06 100644
--- a/Documentation/SubmittingPatches
+++ b/Documentation/SubmittingPatches
@@ -23,7 +23,8 @@ probably need to split up your commit to finer grained pieces.
Oh, another thing. I am picky about whitespaces. Make sure your
changes do not trigger errors with the sample pre-commit hook shipped
-in templates/hooks--pre-commit.
+in templates/hooks--pre-commit. To help ensure this does not happen,
+run git diff --check on your changes before you commit.
(2) Generate your patch using git tools out of your commits.
diff --git a/Documentation/diff-options.txt b/Documentation/diff-options.txt
index da1cc60..501e0df 100644
--- a/Documentation/diff-options.txt
+++ b/Documentation/diff-options.txt
@@ -58,6 +58,11 @@
Turn off rename detection, even when the configuration
file gives the default to do so.
+--check::
+ Check whether differences form a valid patch. Warns if
+ differences include a space before a tab or a space at the end
+ of a line.
+
--full-index::
Instead of the first handful characters, show full
object name of pre- and post-image blob on the "index"
diff --git a/Documentation/git-diff.txt b/Documentation/git-diff.txt
index 6a098df..5054fb7 100644
--- a/Documentation/git-diff.txt
+++ b/Documentation/git-diff.txt
@@ -70,6 +70,7 @@ Various ways to check your working tree::
$ git diff <1>
$ git diff --cached <2>
$ git diff HEAD <3>
+$ git diff --check <4>
------------
+
<1> changes in the working tree not yet staged for the next commit.
@@ -77,6 +78,11 @@ $ git diff HEAD <3>
would be committing if you run "git commit" without "-a" option.
<3> changes in the working tree since your last commit; what you
would be committing if you run "git commit -a"
+<4> display whether what you are about to commit is a valid patch,
+including whether you have spaces at the end of lines, or spaces
+before tabs. Violations are displayed in this form:
+
+<file name>:<line number>:<violation>:<offending line>
Comparing with arbitrary commits::
+
--
1.5.0-rc2.GIT-dirty
rael@zopyra.com <rael@zopyra.com>