diff options
| author | Lorenz Kästle <12514511+RincewindsHat@users.noreply.github.com> | 2023-09-14 07:33:36 (GMT) |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-09-14 07:33:36 (GMT) |
| commit | 2ddc75e69db5a3dd379c896d8420c9af20ec1cee (patch) | |
| tree | 14e262366c94c8ece12ca820678d8beb8d01b6d4 | |
| parent | 7cf099cfb4a0e2f99943ae44bf42c23424bdc19d (diff) | |
| parent | 565e23a7df9a99ac60c3dbc9692b33497423188b (diff) | |
| download | monitoring-plugins-2ddc75e69db5a3dd379c896d8420c9af20ec1cee.tar.gz | |
Merge pull request #1922 from RincewindsHat/update_docs
Update docs regarding C coding style
| -rw-r--r-- | doc/developer-guidelines.sgml | 9 |
1 files changed, 3 insertions, 6 deletions
diff --git a/doc/developer-guidelines.sgml b/doc/developer-guidelines.sgml index 1982974..37c963e 100644 --- a/doc/developer-guidelines.sgml +++ b/doc/developer-guidelines.sgml | |||
| @@ -733,12 +733,9 @@ setup the tests. Run "make test" to run all the tests. | |||
| 733 | <para>Variables should be declared at the beginning of code blocks and | 733 | <para>Variables should be declared at the beginning of code blocks and |
| 734 | not inline because of portability with older compilers.</para> | 734 | not inline because of portability with older compilers.</para> |
| 735 | 735 | ||
| 736 | <para>You should use /* */ for comments and not // as some compilers | 736 | <para>You should use the type "bool" and its values |
| 737 | do not handle the latter form.</para> | 737 | "true" and "false" instead of the "int" type for booleans. |
| 738 | 738 | </para> | |
| 739 | <para>You should also avoid using the type "bool" and its values | ||
| 740 | "true" and "false". Instead use the "int" type and the plugins' own | ||
| 741 | "TRUE"/"FALSE" values to keep the code uniformly.</para> | ||
| 742 | </section> | 739 | </section> |
| 743 | 740 | ||
| 744 | <section><title>Crediting sources</title> | 741 | <section><title>Crediting sources</title> |