morgan/systemd
1
0
Fork 0
mirror of https://github.com/morgan9e/systemd synced 2026-04-14 00:14:32 +09:00
Code Issues Packages Projects Releases Wiki Activity

tree-wide: "human readable" → "human-readable"

Browse Source 
Apparently, the spelling with a hyphen is better style in the English
language.

Suggested by: #36165
This commit is contained in:
Lennart Poettering
2025-07-07 09:48:42 +02:00
parent 663108304a
commit d03714e4e4
20 changed files with 32 additions and 32 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/CATALOG.md
View File

@@ -51,7 +51,7 @@ The text format of the .catalog files is as follows:
* Simple, UTF-8 text files, with usual line breaks at 76 chars.
URLs and suchlike where line-breaks are undesirable may use longer lines.
As catalog files need to be usable on text consoles it is essential that the 76 char line break rule is otherwise followed for human readable text.
As catalog files need to be usable on text consoles it is essential that the 76 char line break rule is otherwise followed for human-readable text.
* Lines starting with `#` are ignored, and may be used for comments.
* The files consist of a series of entries.
@@ -63,7 +63,7 @@ The text format of the .catalog files is as follows:
Some header fields may appear more than once per entry.
The following header fields are currently known (but additional fields may be added later):
* Subject: A short, one-line human readable description of the message
* Subject: A short, one-line human-readable description of the message
* Defined-By: Who defined this message.
Usually a package name or suchlike
@@ -71,7 +71,7 @@ The text format of the .catalog files is as follows:
This can be a web URL or a telephone number in the tel:// namespace
* Documentation: URIs for further user, administrator or developer documentation on the log entry. URIs should be listed in order of relevance, the most relevant documentation first.
* An empty line
* The actual catalog entry payload, as human readable prose.
* The actual catalog entry payload, as human-readable prose.
Multiple paragraphs may be separated by empty lines.
The prose should first describe the message and when it occurs, possibly followed by recommendations how to deal with the message and (if it is an error message) correct the problem at hand.
This message text should be readable by users and administrators.

2
docs/PORTABILITY_AND_STABILITY.md
View File

@@ -18,7 +18,7 @@ The stable interfaces are:
* **The command line interface** of `systemd`, `systemctl`, `loginctl`, `journalctl`, and all other command line utilities installed in `$PATH` and documented in a man page.
We will make sure that scripts invoking these commands will continue to work with future versions of systemd.
Note however that the output generated by these commands is generally not included in the promise, unless it is documented in the man page.
Example: the output of `systemctl status` is not stable, but that of `systemctl show` is, because the former is intended to be human readable and the latter computer readable, and this is documented in the man page.
Example: the output of `systemctl status` is not stable, but that of `systemctl show` is, because the former is intended to be human-readable and the latter computer readable, and this is documented in the man page.
* **The protocol spoken on the socket referred to by `$NOTIFY_SOCKET`**, as documented in
[sd_notify(3)](https://www.freedesktop.org/software/systemd/man/sd_notify.html). Note that, although using