summaryrefslogtreecommitdiffstats
path: root/doc/developer-guidelines.sgml
diff options
context:
space:
mode:
authorTon Voon <tonvoon@users.sourceforge.net>2006-05-24 09:23:50 (GMT)
committerTon Voon <tonvoon@users.sourceforge.net>2006-05-24 09:23:50 (GMT)
commit49f15b6bbfa6d1be2f4d24a77086e2cde6db2a91 (patch)
tree0aa1b7a11ed2cf2e443119f667c426d467d77fdf /doc/developer-guidelines.sgml
parentf7bb6d16e6732f04d8b9de081e23be0c5bb02857 (diff)
downloadmonitoring-plugins-49f15b6bbfa6d1be2f4d24a77086e2cde6db2a91.tar.gz
Reminder of no inline variable declarations
git-svn-id: https://nagiosplug.svn.sourceforge.net/svnroot/nagiosplug/nagiosplug/trunk@1400 f882894a-f735-0410-b71e-b25c423dba1c
Diffstat (limited to 'doc/developer-guidelines.sgml')
-rw-r--r--doc/developer-guidelines.sgml9
1 files changed, 8 insertions, 1 deletions
diff --git a/doc/developer-guidelines.sgml b/doc/developer-guidelines.sgml
index 1861e95..6d5c813 100644
--- a/doc/developer-guidelines.sgml
+++ b/doc/developer-guidelines.sgml
@@ -643,9 +643,16 @@ setup the tests. Run "make test" to run all the tests.
643<section id="CodingGuidelines"><title>Coding guidelines</title> 643<section id="CodingGuidelines"><title>Coding guidelines</title>
644 <para>See <ulink url="http://www.gnu.org/prep/standards_toc.html">GNU 644 <para>See <ulink url="http://www.gnu.org/prep/standards_toc.html">GNU
645 Coding standards</ulink> for general guidelines.</para> 645 Coding standards</ulink> for general guidelines.</para>
646 <section><title>Comments</title> 646 <section><title>C coding</title>
647
648 <para>Variables should be declared at the beginning of code blocks and
649 not inline because of portability with older compilers.</para>
650
647 <para>You should use /* */ for comments and not // as some compilers 651 <para>You should use /* */ for comments and not // as some compilers
648 do not handle the latter form.</para> 652 do not handle the latter form.</para>
653 </section>
654
655 <section><title>Crediting sources</title>
649 <para>If you have copied a routine from another source, make sure the licence 656 <para>If you have copied a routine from another source, make sure the licence
650 from your source allows this. Add a comment referencing the ACKNOWLEDGEMENTS 657 from your source allows this. Add a comment referencing the ACKNOWLEDGEMENTS
651 file, where you can put more detail about the source.</para> 658 file, where you can put more detail about the source.</para>