[Initng-svn] r4028 - initng/trunk/doc

[svn at initng.thinktux.net]

Author: qupada
Date: Sun May  7 11:50:41 2006
New Revision: 4028

Modified:
   initng/trunk/doc/CODING_STANDARDS

Log:
Spelling and suchlike in CODING_STANDARDS


Modified: initng/trunk/doc/CODING_STANDARDS
==============================================================================
--- initng/trunk/doc/CODING_STANDARDS	(original)
+++ initng/trunk/doc/CODING_STANDARDS	Sun May  7 11:50:41 2006
@@ -5,8 +5,8 @@
 
 * Please use 4 spaces to indent code blocks, not tabs.
 * Curly braces stand on their own.
-* Be generous with whitespace
-* Single line blocks do not require braces
+* Be generous with whitespace.
+* Single line blocks do not require braces.
 
 If you use indent, use these parameters:
 indent -sob -bad -bap -bbb -bl -bli0 -nce -cli4 -cbi4 -ss -npcs -nprs -npsl -i4 -lp -nut -fc1 -c45 -nsob *.[ch]
@@ -14,12 +14,12 @@
 
 For .ii-files:
 
-* Please use a tab for indent. What you set for a size for one tab, everybody can set in his editor. Spaces are dirty, because, everybody must use this size of indent and cannot resize it.
-* Curly braces stand stands behind the function. (POSIX)
-* Comments begin with a "# " not only "#". because there're #ifd ...
-* #ifd, #elsed ... shouldn't be indented.
-* Scripts are indented. (usually with 2 tabs.)
-* Variables should be in braces: ${var}. it's better to read and there were problems without, yet.
-* Every Executable stands in @xzy at . Only echo do not.
-* Script must be POSIX-konform. Can be tested with dash. We want, that's possible to use initng everywhere. Also with other POSIX-konformed shells.
-* All services/daemons never depends on system/initial or something like. Set dependency only on system/bootmisc!
+* Please use a tab for indenting (you can resize the width of tabs in your editor).  Spaces are dirty, using tabs here allows consistency.
+* Curly braces stand stands behind the function. (POSIX).
+* Comments should take the form "# comment" not just "#comment", as "#if" is an ifile processor statement.
+* #ifd, #elsed and other ifile processor tags should not be indented.
+* Scripts should be indented. (usually with 2 tabs.)
+* Variables should be in braces: ${var}.  This is both for clarity, and to prevent problems parsing the script.
+* Every executable must be prefixed and suffixed with '@', as @/usr/bin/foo at .  Note the 'echo' statement does not.
+* Script must be POSIX-compliant. We want initng to run everywhere.  Can be tested with bash or other POSIX-compliat shells.
+* All services/daemons must never depend on system/initial.  Set dependency to system/bootmisc.