[Initng-svn] r4373 - in initng-ifiles/trunk: doc

[svn at initng.thinktux.net]

Author: qupada
Date: Tue Jun  6 11:36:54 2006
New Revision: 4373

Modified:
   initng-ifiles/trunk/CODING_STANDARDS
   initng-ifiles/trunk/INSTALL
   initng-ifiles/trunk/README
   initng-ifiles/trunk/doc/iimanual.txt
   initng-ifiles/trunk/doc/imanual.txt

Log:
Spelling and readability again

Modified: initng-ifiles/trunk/CODING_STANDARDS
==============================================================================
--- initng-ifiles/trunk/CODING_STANDARDS	(original)
+++ initng-ifiles/trunk/CODING_STANDARDS	Tue Jun  6 11:36:54 2006
@@ -3,12 +3,13 @@
 
 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!
+* 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 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.
+	Note the @ symbols surround the binary, not command line arguments, "@/usr/bin/foo@ -f" not "@/usr/bin/foo -f@"
+* Scripts must be POSIX-compliant for portability.  Can be tested with bash or other POSIX-compliant shells.
+* No service or daemon should depend on system/initial.  Use "need = system/bootmisc;"
\ No newline at end of file

Modified: initng-ifiles/trunk/INSTALL
==============================================================================
--- initng-ifiles/trunk/INSTALL	(original)
+++ initng-ifiles/trunk/INSTALL	Tue Jun  6 11:36:54 2006
@@ -4,9 +4,8 @@
 For the most up-to-date installation instructions, please refer to the initng
 wiki: http://www.initng.org/wiki/Installation
 
-As of version 0.6.1, GNU autotools has been completely replaced with CMake.
-Autotools is NO LONGER SUPPORTED and will more likely than not, if it will
-compile at all, leave you with a semi-functional initng installation.
+Note: GNU autotools support has been completely removed, you will need CMake
+version 2.2.0 or later for installation.
 
 
 SYSTEM REQUIREMENTS
@@ -57,4 +56,4 @@
 # make install
 
 
-Initng-ifiles requires no further configuration.
+You can now continue with initng runlevel configuration.
\ No newline at end of file

Modified: initng-ifiles/trunk/README
==============================================================================
--- initng-ifiles/trunk/README	(original)
+++ initng-ifiles/trunk/README	Tue Jun  6 11:36:54 2006
@@ -1,2 +1,2 @@
-Read the documentation at http://www.initng.org/ .
-For installation also exists INSTALL.
+Read the documentation on thw wiki at http://www.initng.org/
+Installation instructions are provided in the INSTALL file
\ No newline at end of file

Modified: initng-ifiles/trunk/doc/iimanual.txt
==============================================================================
--- initng-ifiles/trunk/doc/iimanual.txt	(original)
+++ initng-ifiles/trunk/doc/iimanual.txt	Tue Jun  6 11:36:54 2006
@@ -9,7 +9,7 @@
 there are special constructs that can be used to generate distro-specic
 code.
 
-These construts are:
+These constructs are:
 
     #exec blocks
 

Modified: initng-ifiles/trunk/doc/imanual.txt
==============================================================================
--- initng-ifiles/trunk/doc/imanual.txt	(original)
+++ initng-ifiles/trunk/doc/imanual.txt	Tue Jun  6 11:36:54 2006
@@ -216,7 +216,7 @@
 
 This should give an incomplete list of the other directives not explained
 above. You can get a list of most available options with a short description
-if you type "ngc -O".
+of their purpose and required parameters if you type "ngc -O".
 
 
 require_network: