From a923fd6ae7599aee63934ed13c3033fdefc7a18e Mon Sep 17 00:00:00 2001 From: Josh Triplett Date: Sun, 15 Jul 2007 23:41:37 -0700 Subject: CodingStyle: add information about trailing whitespace Signed-off-by: Josh Triplett Signed-off-by: Andrew Morton Signed-off-by: Linus Torvalds --- Documentation/CodingStyle | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/Documentation/CodingStyle b/Documentation/CodingStyle index b49b92edb39..00bffa7b740 100644 --- a/Documentation/CodingStyle +++ b/Documentation/CodingStyle @@ -218,6 +218,18 @@ no space after the prefix increment & decrement unary operators: and no space around the '.' and "->" structure member operators. +Do not leave trailing whitespace at the ends of lines. Some editors with +"smart" indentation will insert whitespace at the beginning of new lines as +appropriate, so you can start typing the next line of code right away. +However, some such editors do not remove the whitespace if you end up not +putting a line of code there, such as if you leave a blank line. As a result, +you end up with lines containing trailing whitespace. + +Git will warn you about patches that introduce trailing whitespace, and can +optionally strip the trailing whitespace for you; however, if applying a series +of patches, this may make later patches in the series fail by changing their +context lines. + Chapter 4: Naming -- cgit v1.2.3