shaba/systemd
1
0
Fork 0
mirror of https://github.com/systemd/systemd.git synced 2024-10-26 08:55:40 +03:00
Code

docs/CODING_STYLE: beef up docs regarding period and "ignoring" in errors

Browse Source 
Prompted by https://github.com/systemd/systemd/pull/34799#discussion_r1807924665
This commit is contained in:
Mike Yuan 2024-10-24 20:04:57 +02:00
parent 4e69da071d
commit d95b6887f6
No known key found for this signature in database
GPG Key ID: 417471C0A40F58B3
1 changed files with 15 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
docs/CODING_STYLE.md
View File

@ -519,6 +519,21 @@ SPDX-License-Identifier: LGPL-2.1-or-later
return log_error_errno(SYNTHETIC_ERRNO(EIO), "Failed to read ...");
```
- If the error shall be ignored rather than propagated, insert ", ignoring"
at the end:
```c
r = parse(...);
if (r < 0)
log_debug_errno(r, "Failed to parse ..., ignoring: %m");
else
parsed = r;
```
- Insert a period at the end of the log message if no errno shall be logged.
Bus errors however should not end with a period, because they are passed to
the client where the message could be embedded within other texts.
## Memory Allocation
- Always check OOM. There is no excuse. In program code, you can use