Noratrieb/nilstrieb-c-style-guide-edition-2
1
0
Fork 0
mirror of https://github.com/Noratrieb/nilstrieb-c-style-guide-edition-2.git synced 2026-01-14 15:25:10 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

spelling and grammar

Browse source 
keep one spelling error as a treat
This commit is contained in:
Olive 2022-07-27 14:14:21 -07:00
parent 4f1378d642
commit b21f1c771d
2 changed files with 3 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

4
src/conventions.md
View file

@ -4,7 +4,7 @@ General conventions that C code should obey.
## Memory allocation
Always check the return value of `malloc`. If it is a null pointer, dereference it to immediately abort the processas as we cannot reasonable recover from OOM in most cases. If such a recovery is possible, recover instead. On some platforms, dereferencing a null pointer does _not_ abort the process. In these cases, the null pointer is a perfectly fine pointer, and just continue using it instead. Note that this derefence should usually be a volatile operation as the compiler would optimize it away otherwise. I have reported upstream issues on compilers about this, but they have not yet answered.
Always check the return value of `malloc`. If it is a null pointer, dereference it to immediately abort the processas as we cannot reasonably recover from OOM in most cases. If such a recovery is possible, recover instead. On some platforms, dereferencing a null pointer does _not_ abort the process. In these cases, the null pointer is a perfectly fine pointer, and just continue using it instead. Note that this derefence should usually be a volatile operation as the compiler would optimize it away otherwise. I have reported upstream issues on compilers about this, but they have not yet answered.
If the pointer is non-null, `free` it directly after the `malloc` call. This prevents memory leaks of all sorts. Afterwards,
you can use it freely in your program.
@ -19,7 +19,7 @@ All identifiers should be given meaningful english names. To work with ancient l
## Comments
Comments are vital to readability. Therefore, code should always be well commented. Comments must be written in the lingua franca of programming, swiss german.
Comments are vital to readability. Therefore, code should always be well commented. Comments must be written in the lingua franca of programming, Swiss German.
```c
int main() {

2
src/formatting.md
View file

@ -27,7 +27,7 @@ body cannot fit into a single line, make a new function instead.
## Identation
C code must be indented with 3 spaces. The toplevel should be indented as well.
C code must be indented with 3 spaces. The top-level should be indented as well.
```c
#include<stdio.h>