diff options
| author | Robin Jarry <robin@jarry.cc> | 2022-11-27 11:29:34 +0100 |
|---|---|---|
| committer | Robin Jarry <robin@jarry.cc> | 2022-12-02 22:10:49 +0100 |
| commit | 23a05d17ac1d23466ff73efa19576d43d06efe4b (patch) | |
| tree | 49986587a62bdd89eb06ffa2aadf05f6d45cb3e7 /CONTRIBUTING.md | |
| parent | 70f46757449c8f24b818f4dfc5dcb87da7e327d6 (diff) | |
| download | aerc-23a05d17ac1d23466ff73efa19576d43d06efe4b.tar.gz | |
logging: rename package to log
Use the same name than the builtin "log" package. That way, we do not
risk logging in the wrong place.
Suggested-by: Tim Culverhouse <tim@timculverhouse.com>
Signed-off-by: Robin Jarry <robin@jarry.cc>
Tested-by: Bence Ferdinandy <bence@ferdinandy.com>
Acked-by: Tim Culverhouse <tim@timculverhouse.com>
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 03c606ac..44a567be 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -243,19 +243,19 @@ If gofumpt accepts your code it's most likely properly formatted. ### Logging Aerc allows logging messages to a file. Either by redirecting the output to -a file (e.g. `aerc > log`), or by configuring `log-file` in ``aerc.conf`. +a file (e.g. `aerc > aerc.log`), or by configuring `log-file` in ``aerc.conf`. Logging messages are associated with a severity level, from lowest to highest: `trace`, `debug`, `info`, `warn`, `error`. Messages can be sent to the log file by using the following functions: -- `logging.Errorf()`: Use to report serious (but non-fatal) errors. -- `logging.Warnf()`: Use to report issues that do not affect normal use. -- `logging.Infof()`: Use to display important messages that may concern +- `log.Errorf()`: Use to report serious (but non-fatal) errors. +- `log.Warnf()`: Use to report issues that do not affect normal use. +- `log.Infof()`: Use to display important messages that may concern non-developers. -- `logging.Debugf()`: Use to display non-important messages, or debuging +- `log.Debugf()`: Use to display non-important messages, or debuging details. -- `logging.Tracef()`: Use to display only low level debugging traces. +- `log.Tracef()`: Use to display only low level debugging traces. ### Man pages |