mirror of
https://github.com/systemd/systemd.git
synced 2026-08-12 12:16:06 +00:00
CODING_STYLE: add a brief log msg style guide
(cherry picked from commit 83b4a5bb3d)
This commit is contained in:
committed by
Luca Boccassi
parent
279c0be61c
commit
a0981c8d3e
@@ -689,6 +689,26 @@ SPDX-License-Identifier: LGPL-2.1-or-later
|
||||
return log_error_errno(SYNTHETIC_ERRNO(EIO), "Failed to read ...");
|
||||
```
|
||||
|
||||
- When generating log messages that contain filenames, user controlled strings,
|
||||
or similar, please enclose them in single ticks.
|
||||
|
||||
- Think about the log level you choose: for functions that are of the "logging"
|
||||
kind (see above), please ensure that failures we propagate should be logged
|
||||
about at `LOG_ERR` level. Failures that are noteworthy, but we proceed anyway,
|
||||
should be loged at `LOG_WARN` level. Important informational messages should
|
||||
use `LOG_NOTICE` and regular informational messages should use
|
||||
`LOG_INFO`. Note that the latter is the default maximum log level, i.e. only
|
||||
`LOG_DEBUG` messages are hidden by default.
|
||||
|
||||
- All log messages that show some failure which is not fatal for the immediate
|
||||
operation (i.e. generally those you'd log at `LOG_WARN` level, as described
|
||||
above) should be suffixed with a `…, ignoring: %m"` or similar. Or in other
|
||||
words, they should make clear not only in log level but also in English
|
||||
language that the issue is not fatal, but ignored. Depending on context you
|
||||
can also use `…, proceeding anyway: %m"`, `…, skipping: %m` or other language
|
||||
that makes clear that the failure is not actionable and doesn't strictly
|
||||
require immediate administrator attention.
|
||||
|
||||
## Memory Allocation
|
||||
|
||||
- Always check OOM. There is no excuse. In program code, you can use
|
||||
|
||||
Reference in New Issue
Block a user