Module: monitoring-plugins
Branch: master
Commit: 1b293a4032dfa87b8eeee5695ebe0c74a2b9a413
Author: RincewindsHat <[email protected]>
Date: Tue Oct 15 09:33:34 2024 +0200
URL:
https://www.monitoring-plugins.org/repositories/monitoring-plugins/commit/?id=1b293a4
Adapted the coding guidelines slightly + typo
---
doc/developer-guidelines.sgml | 9 ++++-----
1 file 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.
</section>
<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>
+ Coding standards</ulink> for general guidelines.
+ Some parts of the guidelines (namely and explicitly the coding style)
+ are not seen as best practice by us.</para>
<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 the type "bool" and its values
"true" and "false" instead of the "int" type for booleans.
</para>
</section>
<section><title>Crediting sources</title>
- <para>If you have copied a routine from another source, make sure the
licence
+ <para>If you have copied a routine from another source, make sure the
license
from your source allows this. Add a comment referencing the
ACKNOWLEDGEMENTS
file, where you can put more detail about the source.</para>
<para>For contributed code, do not add any named credits in the source
code
