diff options
| author |  Ton Voon <tonvoon@users.sourceforge.net>
| 2006-05-24 09:23:50 +0000 |
|---|---|---|
| committer | Ton Voon <tonvoon@users.sourceforge.net>
| 2006-05-24 09:23:50 +0000 |
| commit | 49f15b6bbfa6d1be2f4d24a77086e2cde6db2a91 (patch) | |
| tree | 0aa1b7a11ed2cf2e443119f667c426d467d77fdf /doc/developer-guidelines.sgml | |
| parent | f7bb6d16e6732f04d8b9de081e23be0c5bb02857 (diff) | |
| download | monitoring-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.sgml | 9 |
1 files changed, 8 insertions, 1 deletions
diff --git a/doc/developer-guidelines.sgml b/doc/developer-guidelines.sgml index 1861e956..6d5c813c 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. <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> |