summaryrefslogtreecommitdiffstats
path: root/Documentation
diff options
context:
space:
mode:
authorJosh Triplett <josht@linux.vnet.ibm.com>2007-07-15 23:41:37 -0700
committerLinus Torvalds <torvalds@woody.linux-foundation.org>2007-07-16 09:05:50 -0700
commita923fd6ae7599aee63934ed13c3033fdefc7a18e (patch)
treeac1f5eac94ef7b6f3f92671146fc4be5a541a7fd /Documentation
parent9e8c4273ef4f631a896650bd2ade4c1b6487131b (diff)
downloadlinux-stable-a923fd6ae7599aee63934ed13c3033fdefc7a18e.tar.gz
linux-stable-a923fd6ae7599aee63934ed13c3033fdefc7a18e.tar.bz2
linux-stable-a923fd6ae7599aee63934ed13c3033fdefc7a18e.zip
CodingStyle: add information about trailing whitespace
Signed-off-by: Josh Triplett <josh@kernel.org> Signed-off-by: Andrew Morton <akpm@linux-foundation.org> Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/CodingStyle12
1 files changed, 12 insertions, 0 deletions
diff --git a/Documentation/CodingStyle b/Documentation/CodingStyle
index b49b92edb396..00bffa7b740e 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