summaryrefslogtreecommitdiff
path: root/docs/Contributing/c-coding-style.md
diff options
context:
space:
mode:
authorOmniscient <omniscient.oce@gmail.com>2024-05-20 10:48:01 +1000
committerOmniscient <omniscient.oce@gmail.com>2024-05-20 10:48:01 +1000
commitc91f86bd744df6f93a93e61d030c55393fb9ef0d (patch)
tree8f8dddade96b420d36489b2f03d0b791628d44aa /docs/Contributing/c-coding-style.md
parent5e2186b753c0058253299a651e5752776b88066c (diff)
parent02e84ee4d18e705e3362be1e327fdb6f1397a032 (diff)
Merge branch 'master' into realign
Diffstat (limited to 'docs/Contributing/c-coding-style.md')
-rw-r--r--docs/Contributing/c-coding-style.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/docs/Contributing/c-coding-style.md b/docs/Contributing/c-coding-style.md
new file mode 100644
index 0000000..4e268cc
--- /dev/null
+++ b/docs/Contributing/c-coding-style.md
@@ -0,0 +1,13 @@
+---
+title: C Coding Style
+---
+
+A lot of these should be forced onto you by `clang-format` and `clang-tidy` but for posterity here are
+a few of the styles that we stick to.
+
+* **Pointer next to type** - we use `type* variable` in function signatures and variable declarations e.g. `mat4* model`
+
+
+## Memory
+
+### Arena allocation