fix {depth} display, warnings and doc

- fix call stack depth display with {depth}: remove (5) stripped depths.
- fix warnings in tests
- Explain CLUTCHLOG_HAVE_UNIX_SYSINFO in the README.
This commit is contained in:
Johann Dreo 2021-12-19 08:30:19 +01:00
commit 44ffe6309a
4 changed files with 63 additions and 2 deletions

View file

@ -345,16 +345,33 @@ Note: the log levels constants are lower case (for example: `clutchlog::level::x
Limitations
===========
### System-dependent stack depth
Because the call stack depth and program name access are system-dependent,
the features relying on the depth of the call stack and the display of the program name
are only available for operating systems having the following headers:
`execinfo.h`, `stdlib.h` and `libgen.h` (so far, tested with Linux).
Clutchlog sets the `CLUTCHLOG_HAVE_UNIX_SYSINFO` to 1 if the headers are
available, and to 0 if they are not.
You can make portable code using something like:
```cpp
#if CLUTCHLOG_HAVE_UNIX_SYSINFO == 1
log.depth( x );
#endif
```
### Dependencies
Some colors/styles may not be supported by some exotic terminal emulators.
Clutchlog needs `C++-17` with the `filesystem` feature.
You may need to indicate `-std=c++17 -lstdc++fs` to some compilers.
### Features
What Clutchlog do not provide at the moment (but may in a near future):
- Super fast log writing.