workflow: Update guidelines on use of pointers

the void * returned by malloc should not be explicitly cast
when checking pointers for validity, only use (ptr == NULL)

1 files changed, 8 insertions, 0 deletions

diff --git a/doc/workflow.txt b/doc/workflow.txt
index ee4afb95..e48375bb 100644
--- a/doc/workflow.txt
+++ b/doc/workflow.txt
@@ -21,6 +21,14 @@ int * a;
 instead of

 int *a;

 

+- don't explicitly cast malloc, but do

+

+your * = malloc (sizeof *your * len);

+

+- when checking for invalid pointers use

+

+if (ptr == NULL), instead of if (!ptr)

+

 3. Development workflow

 

 Git is used as a version tooling for the code. Releases are identified