[Nagiosplug-checkins] nagiosplug/doc developer-guidelines.sgml,1.38,1.39
Ton Voon
tonvoon at users.sourceforge.net
Wed May 24 02:25:09 CEST 2006
Update of /cvsroot/nagiosplug/nagiosplug/doc
In directory sc8-pr-cvs7.sourceforge.net:/tmp/cvs-serv2703/doc
Modified Files:
developer-guidelines.sgml
Log Message:
Reminder of no inline variable declarations
Index: developer-guidelines.sgml
===================================================================
RCS file: /cvsroot/nagiosplug/nagiosplug/doc/developer-guidelines.sgml,v
retrieving revision 1.38
retrieving revision 1.39
diff -u -d -r1.38 -r1.39
--- developer-guidelines.sgml 19 May 2006 21:41:03 -0000 1.38
+++ developer-guidelines.sgml 24 May 2006 09:23:50 -0000 1.39
@@ -643,9 +643,16 @@
<section id="CodingGuidelines"><title>Coding guidelines</title>
<para>See <ulink url="http://www.gnu.org/prep/standards_toc.html">GNU
Coding standards</ulink> for general guidelines.</para>
- <section><title>Comments</title>
+ <section><title>C coding</title>
+
+ <para>Variables should be declared at the beginning of code blocks and
+ not inline because of portability with older compilers.</para>
+
<para>You should use /* */ for comments and not // as some compilers
do not handle the latter form.</para>
+ </section>
+
+ <section><title>Crediting sources</title>
<para>If you have copied a routine from another source, make sure the licence
from your source allows this. Add a comment referencing the ACKNOWLEDGEMENTS
file, where you can put more detail about the source.</para>
More information about the Commits
mailing list