upstream/monitoring-plugins
1
0
Fork 0
mirror of https://github.com/monitoring-plugins/monitoring-plugins.git synced 2026-02-03 18:49:29 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

Adapted the coding guidelines slightly + typo

Browse source
This commit is contained in:
RincewindsHat 2024-10-15 09:33:34 +02:00
parent 2b1b5c1ce9
commit 1b293a4032
1 changed files with 4 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
doc/developer-guidelines.sgml
View file

@ -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