commit: 08d548c30670bc1708e9620d7d8b43506646f27c
parent f7fca1baefffdfe38c08c485cc4c8b1db23d5a0e
Author: Haelwenn (lanodan) Monnier <contact@hacktivis.me>
Date: Fri, 20 Sep 2024 05:23:14 +0200
README: Document unified error/warning message formatting
Diffstat:
1 file changed, 2 insertions(+), 1 deletion(-)
diff --git a/README.md b/README.md
@@ -26,7 +26,8 @@ Set the `CC` and `CFLAGS` environment variables for your target, the usual `CROS
To compile the test binaries without running them, run `make build-checks`
## Design differences
-- All programs prefix their messages with their name. This way you don't end up with context-less messages in scripts.
+- Whenever possible programs prefix their messages with their name. This way you don't end up with context-less messages.
+- Error messages contain "error:", warning messages contain "warning:". To allow to easily find what went wrong in logs.
- When the output is structured data, a terminal gets human-oriented output, others like piped programs get machine-oriented output (no padding, line separation, CSV, JSON, …). Prior art: most `ls(1)` implementations, i3/sway, FreeBSD utils via `libxo`, …
- As the `utmp` and `wtmp` files are considered broken by design, utilities dependant on them like `who` and `lastlog` won't be implemented. Proper authentication logs shouldn't be writable into by multiple programs, some of them third-party (like SSH and Display Managers typically are).
- Minimal dependencies, allowing to bootstrap utils-std with barely having unix utilities.
