Mirror/FairLogger
1
0
Fork 0
mirror of https://github.com/FairRootGroup/FairLogger.git synced 2025-10-13 08:41:12 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update docs

Browse Source
This commit is contained in:
Alexey Rybalchenko 2020-06-18 11:14:07 +02:00
parent a0ff4eba50
commit 8446c6db0c
1 changed files with 25 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

39
README.md
View File

@ -42,7 +42,7 @@ If FairLogger is built with `-DUSE_BOOST_PRETTY_FUNCTION=ON` and/or `-DUSE_EXTER
```cmake ```cmake
find_package(FairLogger) find_package(FairLogger)
foreach(dep IN LISTS FairLogger_PACKAGE_DEPENDENCIES) foreach(dep IN LISTS FairLogger_PACKAGE_DEPENDENCIES)
 find_package(${dep} ${FairLogger_${dep}_VERSION}) find_package(${dep} ${FairLogger_${dep}_VERSION})
endforeach() endforeach()
``` ```
@ -87,21 +87,32 @@ where severity level is one of the following:
```C++ ```C++
"nolog", "nolog",
"fatal",
"error",
"warn",
"state",
"info",
"debug",
"debug1",
"debug2",
"debug3",
"debug4",
"trace", "trace",
"debug4",
"debug3",
"debug2",
"debug1",
"debug",
"info",
"state",
"warn",
"error",
"fatal",
``` ```
Logger will log the chosen severity and all above it (except "nolog", which deactivates logging for that sink completely). Fatal severity is always logged. Logger will log the chosen severity and all above it (except "nolog", which deactivates logging for that sink completely). Fatal severity is always logged.
## 3.1 Compile-time severity switch
The minimum severity level can be configured at compile time via definition of `FAIR_MIN_SEVERITY`:
```C++
#define FAIR_MIN_SEVERITY warn // only allow severities >= warn
#include <fairlogger/Logger.h>
```
When `FAIR_MIN_SEVERITY` is not provided, it will be set to `info` if `NDEBUG` is defined, otherwise all severities will be enabled.
## 4. Verbosity ## 4. Verbosity
The log verbosity is controlled via: The log verbosity is controlled via:
@ -213,14 +224,14 @@ By default, `<fairlogger/Logger.h>` defines unprefixed macros: `LOG`, `LOGV`, `L
Define an option `FAIR_NO_LOG*` to prevent the above unprefixed macros to be defined, e.g. Define an option `FAIR_NO_LOG*` to prevent the above unprefixed macros to be defined, e.g.
\```cpp ```C++
#define FAIR_NO_LOG #define FAIR_NO_LOG
#define FAIR_NO_LOGF #define FAIR_NO_LOGF
#include <fairlogger/Logger.h> #include <fairlogger/Logger.h>
\``` ```
## License ## License
GNU Lesser General Public Licence (LGPL) version 3, see [LICENSE](LICENSE). GNU Lesser General Public Licence (LGPL) version 3, see [LICENSE](LICENSE).
Copyright (C) 2017-2018 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH Copyright (C) 2017-2020 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH