diff --git a/NEWS b/NEWS index 2eda1e3fdd..9c7b3c39ad 100644 --- a/NEWS +++ b/NEWS @@ -871,7 +871,7 @@ CHANGES WITH 258 in spe: * userdbctl gained a new switch --from-file=. If used the tool will not look up a user or group record from the system's user database but instead read it from the specified JSON file, and then present it in - the usual, human readable fashion. + the usual, human-readable fashion. * systemd-homed gained D-Bus API calls for listing, adding, removing and showing use record signing keys. @@ -8016,7 +8016,7 @@ CHANGES WITH 248: * systemd-hostnamed now exports the "HardwareVendor" and "HardwareModel" D-Bus properties, which are supposed to contain a - pair of cleaned up, human readable strings describing the system's + pair of cleaned up, human-readable strings describing the system's vendor and model. It's typically sourced from the firmware's DMI tables, but may be augmented from a new hwdb database. hostnamectl shows this in the status output. @@ -15502,7 +15502,7 @@ CHANGES WITH 220: journal-nocow.conf tmpfiles file. * systemd-journald will now translate audit message types to - human readable identifiers when writing them to the + human-readable identifiers when writing them to the journal. This should improve readability of audit messages. * The LUKS logic gained support for the offset= and skip= diff --git a/docs/CATALOG.md b/docs/CATALOG.md index f700ff07e2..4fb35e46bf 100644 --- a/docs/CATALOG.md +++ b/docs/CATALOG.md @@ -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. diff --git a/docs/PORTABILITY_AND_STABILITY.md b/docs/PORTABILITY_AND_STABILITY.md index 147fff5f89..42d86f278e 100644 --- a/docs/PORTABILITY_AND_STABILITY.md +++ b/docs/PORTABILITY_AND_STABILITY.md @@ -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 diff --git a/man/coredumpctl.xml b/man/coredumpctl.xml index 6179d6b760..9ad7608b27 100644 --- a/man/coredumpctl.xml +++ b/man/coredumpctl.xml @@ -52,7 +52,7 @@ matching specified characteristics. If no command is specified, this is the implied default. - The output is designed to be human readable and contains a table with the following + The output is designed to be human-readable and contains a table with the following columns: diff --git a/man/homectl.xml b/man/homectl.xml index 37a3a05b87..cf5b878e7a 100644 --- a/man/homectl.xml +++ b/man/homectl.xml @@ -138,7 +138,7 @@ short or off. If pretty human-friendly whitespace and newlines are inserted in the output to make the JSON data more readable. If short all superfluous whitespace is suppressed. If off (the - default) the user information is not shown in JSON format but in a friendly human readable formatting + default) the user information is not shown in JSON format but in a friendly human-readable formatting instead. The option picks pretty when run interactively and short otherwise. diff --git a/man/org.freedesktop.login1.xml b/man/org.freedesktop.login1.xml index 1902032195..5561c98606 100644 --- a/man/org.freedesktop.login1.xml +++ b/man/org.freedesktop.login1.xml @@ -743,8 +743,8 @@ node /org/freedesktop/login1 { handle-suspend-key, handle-hibernate-key, handle-lid-switch, separated by colons, for inhibiting poweroff/reboot, suspend/hibernate, the automatic idle logic, or hardware key handling. who should be - a short human readable string identifying the application taking the lock. why - should be a short human readable string identifying the reason why the lock is taken. Finally, + a short human-readable string identifying the application taking the lock. why + should be a short human-readable string identifying the reason why the lock is taken. Finally, mode is either block or delay which encodes whether the inhibit shall be consider mandatory or whether it should just delay the operation to a certain maximum time, while the block-weak and variants will create an inhibitor diff --git a/man/org.freedesktop.systemd1.xml b/man/org.freedesktop.systemd1.xml index 3cf0e18709..f5066e4834 100644 --- a/man/org.freedesktop.systemd1.xml +++ b/man/org.freedesktop.systemd1.xml @@ -1370,7 +1370,7 @@ node /org/freedesktop/systemd1 { The primary unit name as string - The human readable description string + The human-readable description string The load state (i.e. whether the unit file has been loaded successfully) @@ -2518,7 +2518,7 @@ node /org/freedesktop/systemd1/unit/avahi_2ddaemon_2eservice { the dependencies and their inverse dependencies (where this applies) as configured in the unit file or determined automatically. - Description contains the human readable description string for the + Description contains the human-readable description string for the unit. SourcePath contains the path to a configuration file this unit is @@ -2638,7 +2638,7 @@ node /org/freedesktop/systemd1/unit/avahi_2ddaemon_2eservice { LoadError contains a pair of strings. If the unit failed to load (as encoded in LoadState, see above), then this will include a D-Bus error pair consisting of - the error ID and an explanatory human readable string of what happened. If it loaded successfully, this + the error ID and an explanatory human-readable string of what happened. If it loaded successfully, this will be a pair of empty strings. Transient contains a boolean that indicates whether the unit was created as a diff --git a/man/os-release.xml b/man/os-release.xml index ca5ab0fce3..aa1ef03a40 100644 --- a/man/os-release.xml +++ b/man/os-release.xml @@ -455,7 +455,7 @@ produces the OS. This field is optional. This name is intended to be exposed in "About this system" UIs or software update UIs when - needed to distinguish the OS vendor from the OS itself. It is intended to be human readable. + needed to distinguish the OS vendor from the OS itself. It is intended to be human-readable. Examples: VENDOR_NAME="Fedora Project" for Fedora Linux, VENDOR_NAME="Canonical" for Ubuntu. diff --git a/man/sd_bus_message_new_method_error.xml b/man/sd_bus_message_new_method_error.xml index 64ceb18a1e..c0ddaef68b 100644 --- a/man/sd_bus_message_new_method_error.xml +++ b/man/sd_bus_message_new_method_error.xml @@ -76,7 +76,7 @@ example an error name such as org.freedesktop.DBus.Error.NotSupported or the equivalent symbolic SD_BUS_ERROR_NOT_SUPPORTED), and the - message field is set as the human readable error message + message field is set as the human-readable error message string if present. The error e must have the name field set, see sd_bus_error_is_set3. diff --git a/man/systemd-notify.xml b/man/systemd-notify.xml index 25b5e2d041..b64610dbba 100644 --- a/man/systemd-notify.xml +++ b/man/systemd-notify.xml @@ -161,7 +161,7 @@ - Send a free-form human readable status string for the daemon to the service + Send a free-form human-readable status string for the daemon to the service manager. This option takes the status string as argument. This is equivalent to systemd-notify STATUS=…. For details about the semantics of this option see sd_notify3. This diff --git a/man/systemd-stub.xml b/man/systemd-stub.xml index 9ac1426c60..abba8834fb 100644 --- a/man/systemd-stub.xml +++ b/man/systemd-stub.xml @@ -374,7 +374,7 @@ similar format as .osrel (i.e. an environment-variable-assignment-block-like list of newline separated strings). Currently two fields are defined: ID= is supposed to carry a short identifying string that identifies the profile - (e.g. ID=factory-reset). TITLE= should contain a human readable + (e.g. ID=factory-reset). TITLE= should contain a human-readable string that may appear in the boot menu entry for this profile (e.g. TITLE='Factory Reset this Device'). diff --git a/man/systemd.unit.xml b/man/systemd.unit.xml index 055c913349..04ba9e95ed 100644 --- a/man/systemd.unit.xml +++ b/man/systemd.unit.xml @@ -597,7 +597,7 @@ Description= - A short human readable title of the unit. This may be used by + A short human-readable title of the unit. This may be used by systemd (and other UIs) as a user-visible label for the unit, so this string should identify the unit rather than describe it, despite the name. This string also should not just repeat the unit name. Apache2 Web Server is a good example. Bad examples are diff --git a/man/sysupdate.features.xml b/man/sysupdate.features.xml index 9a1cfcc6ee..606292e269 100644 --- a/man/sysupdate.features.xml +++ b/man/sysupdate.features.xml @@ -71,7 +71,7 @@ Description= - A short human readable description of this feature. + A short human-readable description of this feature. This may be used as a label for this feature, so the string should meaningfully identify the feature among the features available in sysupdate.d/. diff --git a/man/userdbctl.xml b/man/userdbctl.xml index 194f8e0e6f..c705b6a783 100644 --- a/man/userdbctl.xml +++ b/man/userdbctl.xml @@ -61,7 +61,7 @@ friendly, table or json. If classic, an output very close to the format of /etc/passwd or /etc/group is generated. If friendly, a more comprehensive and - user friendly, human readable output is generated. If table, a minimal, tabular + user friendly, human-readable output is generated. If table, a minimal, tabular output is generated. If json, a JSON formatted output is generated. Defaults to friendly if a user/group is specified on the command line, table otherwise. diff --git a/src/boot/boot.c b/src/boot/boot.c index b765b7f32d..74b2884caf 100644 --- a/src/boot/boot.c +++ b/src/boot/boot.c @@ -100,9 +100,9 @@ typedef struct BootEntry { char16_t *id; /* The unique identifier for this entry (typically the filename of the file defining the entry, possibly suffixed with a profile id) */ char16_t *id_without_profile; /* same, but without any profile id suffixed */ char16_t *title_show; /* The string to actually display (this is made unique before showing) */ - char16_t *title; /* The raw (human readable) title string of the entry (not necessarily unique) */ + char16_t *title; /* The raw (human-readable) title string of the entry (not necessarily unique) */ char16_t *sort_key; /* The string to use as primary sort key, usually ID= from os-release, possibly suffixed */ - char16_t *version; /* The raw (human readable) version string of the entry */ + char16_t *version; /* The raw (human-readable) version string of the entry */ char16_t *machine_id; EFI_HANDLE *device; LoaderType type; diff --git a/src/core/unit.c b/src/core/unit.c index 9b95834263..1bacb56801 100644 --- a/src/core/unit.c +++ b/src/core/unit.c @@ -2393,7 +2393,7 @@ static int unit_log_resources(Unit *u) { return log_oom(); /* Invoked whenever a unit enters failed or dead state. Logs information about consumed resources if resource - * accounting was enabled for a unit. It does this in two ways: a friendly human readable string with reduced + * accounting was enabled for a unit. It does this in two ways: a friendly human-readable string with reduced * information and the complete data in structured fields. */ (void) unit_get_cpu_usage(u, &cpu_nsec); diff --git a/src/fundamental/bootspec-fundamental.c b/src/fundamental/bootspec-fundamental.c index b2841e3342..5ca6674029 100644 --- a/src/fundamental/bootspec-fundamental.c +++ b/src/fundamental/bootspec-fundamental.c @@ -17,8 +17,8 @@ bool bootspec_pick_name_version_sort_key( const sd_char *good_name, *good_version, *good_sort_key; - /* Find the best human readable title, version string and sort key for a boot entry (using the - * os-release(5) fields). Precise is preferred over vague, and human readable over machine + /* Find the best human-readable title, version string and sort key for a boot entry (using the + * os-release(5) fields). Precise is preferred over vague, and human-readable over machine * readable. Thus: * * 1. First priority gets the PRETTY_NAME field, which is the primary string intended for display, @@ -28,7 +28,7 @@ bool bootspec_pick_name_version_sort_key( * 2. Otherwise we go for IMAGE_ID and IMAGE_VERSION (thus we show details about the image, * i.e. specific combination of packages and configuration), if that concept applies. * - * 3. Otherwise we go for NAME and VERSION (i.e. human readable OS name and version) + * 3. Otherwise we go for NAME and VERSION (i.e. human-readable OS name and version) * * 4. Otherwise we go for ID and VERSION_ID (i.e. machine readable OS name and version) * diff --git a/src/shared/ask-password-api.h b/src/shared/ask-password-api.h index 4756e517b1..a470caf5da 100644 --- a/src/shared/ask-password-api.h +++ b/src/shared/ask-password-api.h @@ -19,7 +19,7 @@ typedef enum AskPasswordFlags { /* Encapsulates the mostly static fields of a password query */ typedef struct AskPasswordRequest { - const char *message; /* The human readable password prompt when asking interactively */ + const char *message; /* The human-readable password prompt when asking interactively */ const char *keyring; /* kernel keyring key name (key of "user" type) */ const char *icon; /* freedesktop icon spec name */ const char *id; /* some identifier used for this prompt for the "ask-password" protocol */ diff --git a/src/systemctl/systemctl.c b/src/systemctl/systemctl.c index c62a514777..3e241254cd 100644 --- a/src/systemctl/systemctl.c +++ b/src/systemctl/systemctl.c @@ -271,7 +271,7 @@ static int systemctl_help(void) { " For kill, wait until service stopped\n" " --no-block Do not wait until operation finished\n" " --no-wall Don't send wall message before halt/power-off/reboot\n" - " --message=MESSAGE Specify human readable reason for system shutdown\n" + " --message=MESSAGE Specify human-readable reason for system shutdown\n" " --no-reload Don't reload daemon after en-/dis-abling unit files\n" " --legend=BOOL Enable/disable the legend (column headers and hints)\n" " --no-pager Do not pipe output into a pager\n" diff --git a/src/systemd/sd-daemon.h b/src/systemd/sd-daemon.h index cd9b401e92..b6ec734656 100644 --- a/src/systemd/sd-daemon.h +++ b/src/systemd/sd-daemon.h @@ -189,9 +189,9 @@ int sd_is_mq(int fd, const char *path); that describes the daemon state. This is free-form and can be used for various purposes: general state feedback, fsck-like programs could pass completion - percentages and failing programs could pass a human - readable error message. Example: "STATUS=Completed - 66% of file system check..." + percentages and failing programs could pass a + human-readable error message. Example: + "STATUS=Completed 66% of file system check..." NOTIFYACCESS=... Reset the access to the service status notification socket.