From 566491c971730ea262e3df081cd91d67a3ab104c Mon Sep 17 00:00:00 2001 From: Colin Watson Date: Wed, 8 May 2024 15:01:01 +0100 Subject: [PATCH] docs,man: Avoid some ambiguous uses of "may not" Like much English text, the systemd documentation uses "may not" in the sense of both "will possibly not" and "is forbidden to". In many cases this is OK because the context makes it clear, but in others I felt it was possible to read the "is forbidden to" sense by mistake: in particular, I tripped over "the target file may not exist" in systemd.unit(5) before realizing the correct interpretation. Use "might not" or "may choose not to" in these cases to make it clear which sense we mean. --- docs/ENVIRONMENT.md | 2 +- man/homectl.xml | 2 +- man/integritytab.xml | 2 +- man/sd_bus_set_address.xml | 2 +- man/systemctl.xml | 2 +- man/systemd-cryptenroll.xml | 2 +- man/systemd.network.xml | 4 ++-- man/systemd.unit.xml | 4 ++-- 8 files changed, 10 insertions(+), 10 deletions(-) diff --git a/docs/ENVIRONMENT.md b/docs/ENVIRONMENT.md index 5903617296c..fd8aa0caf69 100644 --- a/docs/ENVIRONMENT.md +++ b/docs/ENVIRONMENT.md @@ -341,7 +341,7 @@ All tools: for cases where we don't need to track given unit type, e.g. `--user` manager often doesn't need to deal with device or swap units because they are handled by the `--system` manager (PID 1). Note that setting certain unit - type as unsupported may not prevent loading some units of that type if they + type as unsupported might not prevent loading some units of that type if they are referenced by other units of another supported type. * `$SYSTEMD_DEFAULT_MOUNT_RATE_LIMIT_BURST` — can be set to override the mount diff --git a/man/homectl.xml b/man/homectl.xml index effdb27f72a..43bde52e0d9 100644 --- a/man/homectl.xml +++ b/man/homectl.xml @@ -434,7 +434,7 @@ denotes 2048-bit RSA with PKCS#1.5 padding and SHA-256. eddsa denotes EDDSA over Curve25519 with SHA-512. - Note that your authenticator may not support some algorithms. + Note that your authenticator may choose not to support some algorithms. diff --git a/man/integritytab.xml b/man/integritytab.xml index 77ff4beb88e..519ed1ca0d8 100644 --- a/man/integritytab.xml +++ b/man/integritytab.xml @@ -80,7 +80,7 @@ Enable journaled, bitmapped or direct (passthrough) mode. Journaled mode is the default when this option is not specified. It provides safety against crashes, but can be slow because all data has to be written twice. - Bitmap mode is more efficient since it requires only a single write, but it is less reliable because if data corruption happens when the machine crashes, it may not be detected. + Bitmap mode is more efficient since it requires only a single write, but it is less reliable because if data corruption happens when the machine crashes, it might not be detected. Direct mode disables the journal and the bitmap. Corresponds to the "direct writes" mode documented in the dm-integrity documentation. Note that without a journal, if there is a crash, it is possible that the integrity tags and data will not match. If used, the journal-* diff --git a/man/sd_bus_set_address.xml b/man/sd_bus_set_address.xml index 35ebf330d09..603f153221c 100644 --- a/man/sd_bus_set_address.xml +++ b/man/sd_bus_set_address.xml @@ -101,7 +101,7 @@ If specified, the identifier returned by the peer after the connection is established will be checked and the connection will be rejected in case of a mismatch. - Note that the addresses passed to sd_bus_set_address() may not be verified + Note that the addresses passed to sd_bus_set_address() might not be verified immediately. If they are invalid, an error may be returned e.g. from a subsequent call to sd_bus_start3. diff --git a/man/systemctl.xml b/man/systemctl.xml index def2f8e0111..70fd91f45a6 100644 --- a/man/systemctl.xml +++ b/man/systemctl.xml @@ -350,7 +350,7 @@ Jan 12 10:46:45 example.com bluetoothd[8900]: gatt-time-server: Input/output err "fragment" and "drop-ins" (source files) of units. Each file is preceded by a comment which includes the file name. Note that this shows the contents of the backing files - on disk, which may not match the system manager's + on disk, which might not match the system manager's understanding of these units if any unit files were updated on disk and the daemon-reload command wasn't issued since. diff --git a/man/systemd-cryptenroll.xml b/man/systemd-cryptenroll.xml index 5a522e36f0f..8baab80dc76 100644 --- a/man/systemd-cryptenroll.xml +++ b/man/systemd-cryptenroll.xml @@ -370,7 +370,7 @@ denotes 2048-bit RSA with PKCS#1.5 padding and SHA-256. eddsa denotes EDDSA over Curve25519 with SHA-512. - Note that your authenticator may not support some algorithms. + Note that your authenticator may choose not to support some algorithms. diff --git a/man/systemd.network.xml b/man/systemd.network.xml index 9c41b24f80a..10876ae3095 100644 --- a/man/systemd.network.xml +++ b/man/systemd.network.xml @@ -2795,7 +2795,7 @@ NFTSet=prefix:netdev:filter:eth_ipv4_prefix prefix length after /. DHCP offers from servers in the list are rejected. Note that if AllowList= is configured then DenyList= is ignored. - Note that this filters only DHCP offers, so the filtering may not work when + Note that this filters only DHCP offers, so the filtering might not work when RapidCommit= is enabled. See also RapidCommit= in the above. @@ -2809,7 +2809,7 @@ NFTSet=prefix:netdev:filter:eth_ipv4_prefix A whitespace-separated list of IPv4 addresses. Each address can optionally take a prefix length after /. DHCP offers from servers in the list are accepted. - Note that this filters only DHCP offers, so the filtering may not work when + Note that this filters only DHCP offers, so the filtering might not work when RapidCommit= is enabled. See also RapidCommit= in the above. diff --git a/man/systemd.unit.xml b/man/systemd.unit.xml index 7c11598a941..e7288e81ad2 100644 --- a/man/systemd.unit.xml +++ b/man/systemd.unit.xml @@ -164,7 +164,7 @@ instance (if any) is always uniquely defined for a given unit and all its aliases. The target of alias symlink must point to a valid unit file location, i.e. the symlink target name must match the symlink source name as described, and the destination path must be in one of the unit search paths, see UNIT FILE - LOAD PATH section below for more details. Note that the target file may not exist, i.e. the symlink may + LOAD PATH section below for more details. Note that the target file might not exist, i.e. the symlink may be dangling. Unit files may specify aliases through the Alias= directive in the [Install] @@ -196,7 +196,7 @@ .wants/ or .requires/ must thus point to a valid unit file location, i.e. the symlink target name must satisfy the described requirements, and the destination path must be in one of the unit search paths, see UNIT FILE LOAD PATH section below for more details. Note - that the target file may not exist, i.e. the symlink may be dangling. + that the target file might not exist, i.e. the symlink may be dangling. Along with a unit file foo.service, a "drop-in" directory foo.service.d/ may exist. All files with the suffix