From 8e03663cb66cae7b1f4b0aa6e36f25c261c68d2d Mon Sep 17 00:00:00 2001 From: Bill Fischofer Date: Thu, 10 Jul 2014 17:05:40 -0500 Subject: Added info on removing trailing whitespace Signed-off-by: Bill Fischofer --- CONTRIBUTING | 13 +++++++++++++ 1 file changed, 13 insertions(+) (limited to 'CONTRIBUTING') diff --git a/CONTRIBUTING b/CONTRIBUTING index 0508a9f0f..37330caf3 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. -- cgit v1.2.3