[PATCH] Proposed change to Documentation/CodingStyle regardingnewline at end of file

[Jesper Juhl]

Having found a few files in the source that did not end in a newline
(patches for those submitted earlier) I thought it might be good to add a
small bit to Documentation/CodingStyle telling people to please ensure
their files end in newline.

Here's a patch with the Change I propose, comments are welcome. Btw, I
could not find any maintainer listed for this document, so I just send
this to linux-kernel - if someone specific should be send the patch please
inform me.


--- linux-2.6.7-rc2/Documentation/CodingStyle-orig	2004-06-05 02:25:45.000000000 +0200
+++ linux-2.6.7-rc2/Documentation/CodingStyle	2004-06-05 02:32:21.000000000 +0200
@@ -47,7 +47,7 @@
 Get a decent editor and don't leave whitespace at the end of lines.


-		Chapter 2: Breaking long lines and strings
+		Chapter 2: Breaking long lines and strings and NL at EOF

 Coding style is all about readability and maintainability using commonly
 available tools.
@@ -69,6 +69,12 @@
 		next_statement;
 }

+Please also make sure that your files have a newline at the end of the file.
+Files that do not end in a newline are not as friendly to tools such grep,
+cat, sed and various others. A missing newline will also needlessly cause
+gcc to emit a warning message for your file.
+
+
 		Chapter 3: Placing Braces

 The other issue that always comes up in C styling is the placement of
@@ -220,6 +226,7 @@
 	return result;
 }

+
 		Chapter 7: Commenting

 Comments are good, but there is also a danger of over-commenting.  NEVER
@@ -428,4 +435,4 @@
 language C, URL: http://std.dkuug.dk/JTC1/SC22/WG14/

 --
-Last updated on 16 February 2004 by a community effort on LKML.
+Last updated on 05 June 2004 by a community effort on LKML.


--
Jesper Juhl <juhl-lkml@xxxxxx>
-
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Please read the FAQ at  http://www.tux.org/lkml/