From 0f3703e641f0f995a8abb40056cb5430b6c228c4 Mon Sep 17 00:00:00 2001 From: Jan Wagner Date: Fri, 14 Apr 2023 14:37:47 +0000 Subject: Fix a lot of typos reported by codespell --- doc/developer-guidelines.sgml | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) (limited to 'doc/developer-guidelines.sgml') diff --git a/doc/developer-guidelines.sgml b/doc/developer-guidelines.sgml index 28674e05..1982974f 100644 --- a/doc/developer-guidelines.sgml +++ b/doc/developer-guidelines.sgml @@ -31,7 +31,7 @@ Preface The purpose of this guidelines is to provide a reference for - the plugin developers and encourage the standarization of the + the plugin developers and encourage the standardization of the different kind of plugins: C, shell, perl, python, etc. Monitoring Plugins Development Guidelines Copyright (C) 2000-2013 @@ -374,7 +374,7 @@ s - seconds (also us, ms) % - percentage B - bytes (also KB, MB, TB) - c - a continous counter (such as bytes + c - a continuous counter (such as bytes transmitted on an interface) @@ -397,7 +397,7 @@
Don't execute system commands without specifying their full path Don't use exec(), popen(), etc. to execute external - commands without explicity using the full path of the external + commands without explicitly using the full path of the external program. Doing otherwise makes the plugin vulnerable to hijacking @@ -655,7 +655,7 @@ If possible when writing lists, use tokens to make the list easy to remember and non-order dependent - so check_disk uses '-c 10000,10%' so that it is clear which is - the precentage and which is the KB values (note that due to + the percentage and which is the KB values (note that due to my own lack of foresight, that used to be '-c 10000:10%' but such constructs should all be changed for consistency, though providing reverse compatibility is fairly @@ -686,7 +686,7 @@ all the current tests and report an overall success rate. These use perl's Test::More. To do a one time test, run "cd plugins && perl t/check_disk.t". -There will somtimes be failures seen in this output which are known failures that +There will sometimes be failures seen in this output which are known failures that need to be fixed. As long as the return code is 0, it will be reported as "test pass". (If you have a fix so that the specific test passes, that will be gratefully received!) @@ -846,7 +846,7 @@ setup the tests. Run "make test" to run all the tests. It is determined to be not redundant (for instance, we would not add a new version of check_disk just because someone had provide a plugin that had perf checking - we would incorporate the features - into an exisiting plugin) + into an existing plugin) One of the developers has had the time to audit the code and declare -- cgit v1.2.3-74-g34f1 From fbb9050c648f23863bcac71bb608f31fec1ea352 Mon Sep 17 00:00:00 2001 From: RincewindsHat <12514511+RincewindsHat@users.noreply.github.com> Date: Tue, 12 Sep 2023 15:48:44 +0200 Subject: Remove note about comments, we will accept // comments --- doc/developer-guidelines.sgml | 3 --- 1 file changed, 3 deletions(-) (limited to 'doc/developer-guidelines.sgml') diff --git a/doc/developer-guidelines.sgml b/doc/developer-guidelines.sgml index 1982974f..c900aeac 100644 --- a/doc/developer-guidelines.sgml +++ b/doc/developer-guidelines.sgml @@ -733,9 +733,6 @@ setup the tests. Run "make test" to run all the tests. Variables should be declared at the beginning of code blocks and not inline because of portability with older compilers. - You should use /* */ for comments and not // as some compilers - do not handle the latter form. - You should also avoid using the type "bool" and its values "true" and "false". Instead use the "int" type and the plugins' own "TRUE"/"FALSE" values to keep the code uniformly. -- cgit v1.2.3-74-g34f1 From 565e23a7df9a99ac60c3dbc9692b33497423188b Mon Sep 17 00:00:00 2001 From: RincewindsHat <12514511+RincewindsHat@users.noreply.github.com> Date: Tue, 12 Sep 2023 15:50:00 +0200 Subject: Switch guidelines to use bool instead of int for booleans --- doc/developer-guidelines.sgml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'doc/developer-guidelines.sgml') diff --git a/doc/developer-guidelines.sgml b/doc/developer-guidelines.sgml index c900aeac..37c963ed 100644 --- a/doc/developer-guidelines.sgml +++ b/doc/developer-guidelines.sgml @@ -733,9 +733,9 @@ setup the tests. Run "make test" to run all the tests. Variables should be declared at the beginning of code blocks and not inline because of portability with older compilers. - You should also avoid using the type "bool" and its values - "true" and "false". Instead use the "int" type and the plugins' own - "TRUE"/"FALSE" values to keep the code uniformly. + You should use the type "bool" and its values + "true" and "false" instead of the "int" type for booleans. +
Crediting sources -- cgit v1.2.3-74-g34f1