[PATCH] coding style addendum

Luben Tuikov (luben@splentec.com)
Mon, 10 Mar 2003 15:56:36 -0500


Someone may find this helpful and descriptive of how kernel code
should be developed.

--- linux-2.5.64/Documentation/CodingStyle.orig 2003-03-10 11:23:46.000000000 -0500
+++ linux-2.5.64/Documentation/CodingStyle 2003-03-10 11:37:18.000000000 -0500
@@ -1,3 +1,4 @@
+Updated: Mon Mar 10 16:34:35 UTC 2003

Linux kernel coding style

@@ -264,3 +265,26 @@

Remember: if another thread can find your data structure, and you don't
have a reference count on it, you almost certainly have a bug.
+
+
+ Chapter 9: Organization
+
+Writing efficient code is important in both complexity and
+implementation. In other words your code organization should NOT be
+too complex to understand. Complexity directly depends on the choice
+of data representation and code organization. To help you stay in
+line, here are a few guidelines to follow:
+
+ Modularize.
+ Use subroutines.
+ Each subroutine/module should do one thing well.
+ Make sure every module/subroutine hides something.
+ Localize input and output in subroutines.
+
+And the most important:
+
+ Choose the data representation that makes the program simple.
+
+
+ ----------
+

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