summaryrefslogtreecommitdiffstats
path: root/doc/developer-guidelines.sgml
diff options
context:
space:
mode:
authorRincewindsHat <12514511+RincewindsHat@users.noreply.github.com>2024-10-15 07:33:34 (GMT)
committerRincewindsHat <12514511+RincewindsHat@users.noreply.github.com>2024-10-15 07:33:34 (GMT)
commit1b293a4032dfa87b8eeee5695ebe0c74a2b9a413 (patch)
treee31b8ac77797b6adad4b780af8f7d8d3cad0f303 /doc/developer-guidelines.sgml
parent2b1b5c1ce9c70df9853fa4ac01d740d6a7e45d37 (diff)
downloadmonitoring-plugins-1b293a4032dfa87b8eeee5695ebe0c74a2b9a413.tar.gz
Adapted the coding guidelines slightly + typorefs/pull/2027/head
Diffstat (limited to 'doc/developer-guidelines.sgml')
-rw-r--r--doc/developer-guidelines.sgml9
1 files changed, 4 insertions, 5 deletions
diff --git a/doc/developer-guidelines.sgml b/doc/developer-guidelines.sgml
index 4186ed7..0afa733 100644
--- a/doc/developer-guidelines.sgml
+++ b/doc/developer-guidelines.sgml
@@ -713,19 +713,18 @@ setup the tests. Run "make test" to run all the tests.
713</section> 713</section>
714<section id="CodingGuidelines"><title>Coding guidelines</title> 714<section id="CodingGuidelines"><title>Coding guidelines</title>
715 <para>See <ulink url="http://www.gnu.org/prep/standards_toc.html">GNU 715 <para>See <ulink url="http://www.gnu.org/prep/standards_toc.html">GNU
716 Coding standards</ulink> for general guidelines.</para> 716 Coding standards</ulink> for general guidelines.
717 Some parts of the guidelines (namely and explicitly the coding style)
718 are not seen as best practice by us.</para>
717 <section><title>C coding</title> 719 <section><title>C coding</title>
718 720
719 <para>Variables should be declared at the beginning of code blocks and
720 not inline because of portability with older compilers.</para>
721
722 <para>You should use the type "bool" and its values 721 <para>You should use the type "bool" and its values
723 "true" and "false" instead of the "int" type for booleans. 722 "true" and "false" instead of the "int" type for booleans.
724 </para> 723 </para>
725 </section> 724 </section>
726 725
727 <section><title>Crediting sources</title> 726 <section><title>Crediting sources</title>
728 <para>If you have copied a routine from another source, make sure the licence 727 <para>If you have copied a routine from another source, make sure the license
729 from your source allows this. Add a comment referencing the ACKNOWLEDGEMENTS 728 from your source allows this. Add a comment referencing the ACKNOWLEDGEMENTS
730 file, where you can put more detail about the source.</para> 729 file, where you can put more detail about the source.</para>
731 <para>For contributed code, do not add any named credits in the source code 730 <para>For contributed code, do not add any named credits in the source code