aboutsummaryrefslogtreecommitdiff
path: root/CONTRIBUTING
diff options
context:
space:
mode:
authorBill Fischofer <bill.fischofer@linaro.org>2014-07-10 17:05:40 -0500
committerMaxim Uvarov <maxim.uvarov@linaro.org>2014-07-11 17:44:06 +0400
commit8e03663cb66cae7b1f4b0aa6e36f25c261c68d2d (patch)
tree9505c86f414498d9a53172afb67e4c604d3be215 /CONTRIBUTING
parenta356c0a87e8f566fcaa01bde09c44bbd63ef7815 (diff)
Added info on removing trailing whitespace
Signed-off-by: Bill Fischofer <bill.fischofer@linaro.org>
Diffstat (limited to 'CONTRIBUTING')
-rw-r--r--CONTRIBUTING13
1 files changed, 13 insertions, 0 deletions
diff --git a/CONTRIBUTING b/CONTRIBUTING
index 0508a9f..37330ca 100644
--- a/CONTRIBUTING
+++ b/CONTRIBUTING
@@ -34,6 +34,19 @@ compiler:
./scripts/checkpatch.pl file.patch
+ Note: A common issue that causes patches to fail checkpatch is the
+ presense of trailing whitespace. Emacs users can use the command:
+
+ Meta-X delete-trailing-whitespace
+
+ to scrub the file prior to saving to avoid these issues. Vim users
+ can accomplish the same with the command:
+
+ :%s/\s\+$//
+
+ Please ensure submitted patches are checkpatch clean before submitting
+ them to avoid having them automatically returned for rework.
+
[1] https://git.kernel.org/cgit/linux/kernel/git/torvalds/linux.git/tree/Documentation/CodingStyle
[2] https://git.kernel.org/cgit/linux/kernel/git/torvalds/linux.git/tree/Documentation/SubmittingPatches
[3] refer to README file.