commit 47798453e83e62ffbd99a95f8cb282c4e987d878 parent 930ce7cdcbe96051dc2545ecbcd2ecb7f11c2715 Author: nibo <nibo@relim.de> Date: Sat, 14 Sep 2024 16:21:45 +0200 Add README Diffstat:
| A | README | | | 21 | +++++++++++++++++++++ |
1 file changed, 21 insertions(+), 0 deletions(-)
diff --git a/README b/README @@ -0,0 +1,21 @@ +## stderr + +There are four types of messages printed to stderr. +Text of the form '* failed' is a message for the developer. +The text before the word 'failed' is always a function name. +Furthermore text printed to stderr is either an ERR, WARN or INFO. +An ERR means the program can't continue execution. +A WARN means the program continues execution but recommends changing something. +An INFO is just a valuable information. +ERR, WARN and INFO messages can be directed at the developer or user. + +## memory leaks + +If the program encounters an ERR message memory doesn't have to be freed. +Because of the convention that the program exits when there is an ERR +message there is no need to free because the operating system takes +care of that anyway. + +There is one more case where memory leaks are tolerated. The library +fontconfig produces memory leaks according to valgrind. Fixing these +memory leaks is out of the scope of this project.