aboutsummaryrefslogtreecommitdiff
path: root/contributing.md
diff options
context:
space:
mode:
authorLoek Le Blansch <loek@pipeframe.xyz>2024-12-17 20:30:13 +0100
committerLoek Le Blansch <loek@pipeframe.xyz>2024-12-17 20:30:13 +0100
commit81404db80bbf9463c3d535ae389e7fbb753a902c (patch)
tree2fac8a57e381d3a34d16e02b6ef73e6d8ff40b2c /contributing.md
parent977b63e96c5ad26035b21444e896a892c1847738 (diff)
update contributing.md
Diffstat (limited to 'contributing.md')
-rw-r--r--contributing.md26
1 files changed, 26 insertions, 0 deletions
diff --git a/contributing.md b/contributing.md
index 0faed2b..5555892 100644
--- a/contributing.md
+++ b/contributing.md
@@ -827,6 +827,32 @@ that you can click on to open them.
int bar = foo[0];
```
</td></tr></table></details>
+- <details><summary>
+ Always explicitly check against <code>NULL</code> (for C APIs) or
+ <code>nullptr</code> (for C++ APIs) when checking if a pointer is valid
+ </summary><table><tr><th>Good</th><th>Bad</th></tr><tr><td>
+
+ ```cpp
+ string foo = "Hello world";
+ if (foo.c_str() == nullptr)
+ // ...
+
+ void * bar = malloc();
+ if (bar == NULL)
+ // ...
+ ```
+ </td><td>
+
+ ```cpp
+ string foo = "Hello world";
+ if (!foo.c_str())
+ // ...
+
+ void * bar = malloc();
+ if (!bar)
+ // ...
+ ```
+ </td></tr></table></details>
## CMakeLists-specific