hyprwm
/
wlroots-hyprland
mirror of https://github.com/hyprwm/wlroots-hyprland.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

CONTRIBUTING.md: update init/finish description

This commit is contained in:
Kirill Primak 2022-04-27 18:34:01 +03:00
parent a1e1e9aba8
commit ec2af17674
1 changed files with 6 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
CONTRIBUTING.md
View File

@ -167,7 +167,6 @@ if (condition1 && condition2 && ...
Try to break the line in the place which you think is the most appropriate. Try to break the line in the place which you think is the most appropriate.
### Line Length ### Line Length
Try to keep your lines under 80 columns, but you can go up to 100 if it Try to keep your lines under 80 columns, but you can go up to 100 if it
@ -190,16 +189,18 @@ Functions that are responsible for constructing objects should take one of the
two following forms: two following forms:
* `init`: for functions which accept a pointer to a pre-allocated object (e.g. * `init`: for functions which accept a pointer to a pre-allocated object (e.g.
a member of a struct) and initialize it. a member of a struct) and initialize it. Such functions must call `memset()`
to zero out the memory before initializing it to avoid leaving unset fields.
* `create`: for functions which allocate the memory for an object, initialize * `create`: for functions which allocate the memory for an object, initialize
it, and return a pointer. it, and return a pointer. Such functions should allocate the memory with
`calloc()` to avoid leaving unset fields.
Likewise, functions that are responsible for destructing objects should take Likewise, functions that are responsible for destructing objects should take
one of the two following forms: one of the two following forms:
* `finish`: for functions which accept a pointer to an object and deinitialize * `finish`: for functions which accept a pointer to an object and deinitialize
it. Such functions should always be able to accept an already deinitialized it. If a finished object isn't destroyed but kept for future use, it must be
object. reinitialized to be used again.
* `destroy`: for functions which accept a pointer to an object, deinitialize * `destroy`: for functions which accept a pointer to an object, deinitialize
it, and free the memory. Such functions should always be able to accept a NULL it, and free the memory. Such functions should always be able to accept a NULL
pointer. pointer.