Skip to content

Commit 6d6eba5

Browse files
behrmannbluca
authored andcommitted
treewide: fix typos
- mostly: usecase -> use case - continously -> continuously - single typos in docs/FILE_DESCRIPTOR_STORE.md (cherry picked from commit 7227dd8)
1 parent c1404ff commit 6d6eba5

File tree

18 files changed

+40
-40
lines changed

18 files changed

+40
-40
lines changed

TODO

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -448,11 +448,11 @@ Features:
448448

449449
* add a new EFI tool "sd-fetch" or so. It looks in a PE section ".url" for an
450450
URL, then downloads the file from it using UEFI HTTP APIs, and executes it.
451-
Usecase: provide a minimal ESP with sd-boot and a couple of these sd-fetch
451+
Use case: provide a minimal ESP with sd-boot and a couple of these sd-fetch
452452
binaries in place of UKIs, and download them on-the-fly.
453453

454454
* maybe: systemd-loop-generator that sets up loopback devices if requested via kernel
455-
cmdline. usecase: include encrypted/verity root fs in UKI.
455+
cmdline. use case: include encrypted/verity root fs in UKI.
456456

457457
* systemd-gpt-auto-generator: add kernel cmdline option to override block
458458
device to dissect. also support dissecting a regular file. useccase: include
@@ -529,7 +529,7 @@ Features:
529529
inspiration from IMA log)
530530

531531
* provide an API (probably IPC) to apps to encrypt/decrypt
532-
credentials. usecase: allow bluez bluetooth daemon to pass pairings to initrd
532+
credentials. use case: allow bluez bluetooth daemon to pass pairings to initrd
533533
that way, without shelling out to our tools.
534534

535535
* revisit default PCR bindings in cryptenroll and systemd-creds. Currently they
@@ -587,7 +587,7 @@ Features:
587587

588588
* systemd-repart: in addition to the existing "factory reset" mode (which
589589
simply empties existing partitions marked for that). add a mode where
590-
partitions marked for it are entirely removed. Usecase: remove secondary OS
590+
partitions marked for it are entirely removed. Use case: remove secondary OS
591591
copy, and redundant partitions entirely, and recreate them anew.
592592

593593
* systemd-boot: maybe add support for collapsing menu entries of the same OS
@@ -633,7 +633,7 @@ Features:
633633
* add support for asymmetric LUKS2 TPM based encryption. i.e. allow preparing
634634
an encrypted image on some host given a public key belonging to a specific
635635
other host, so that only hosts possessing the private key in the TPM2 chip
636-
can decrypt the volume key and activate the volume. Usecase: systemd-confext
636+
can decrypt the volume key and activate the volume. Use case: systemd-confext
637637
for a central orchestrator to generate confext images securely that can only
638638
be activated on one specific host (which can be used for installing a bunch
639639
of creds in /etc/credstore/ for example). Extending on this: allow binding
@@ -646,7 +646,7 @@ Features:
646646
current system state, i.e. a combination of PCR information, local system
647647
time and TPM clock, running services, recent high-priority log
648648
messages/coredumps, system load/PSI, signed by the local TPM chip, to form an
649-
enhanced remote attestation quote. Usecase: a simple orchestrator could use
649+
enhanced remote attestation quote. Use case: a simple orchestrator could use
650650
this: have the report tool upload these reports every 3min somewhere. Then
651651
have the orchestrator collect these reports centrally over a 3min time
652652
window, and use them to determine what which node should now start/stop what,
@@ -701,7 +701,7 @@ Features:
701701
* Add "purpose" flag to partition flags in discoverable partition spec that
702702
indicate if partition is intended for sysext, for portable service, for
703703
booting and so on. Then, when dissecting DDI allow specifying a purpose to
704-
use as additional search condition. Usecase: images that combined a sysext
704+
use as additional search condition. Use case: images that combined a sysext
705705
partition with a portable service partition in one.
706706

707707
* On boot, auto-generate an asymmetric key pair from the TPM,
@@ -822,7 +822,7 @@ Features:
822822
usr=
823823
• systemd-homed: when initializing, look for a credential
824824
systemd.homed.register or so with JSON user records to automatically
825-
register if not registered yet. Usecase: deploy a system, and add an
825+
register if not registered yet. Use case: deploy a system, and add an
826826
account one can directly log into.
827827
• in gpt-auto-generator: check partition uuids against such uuids supplied via
828828
sd-stub credentials. That way, we can support parallel OS installations with
@@ -848,7 +848,7 @@ Features:
848848

849849
* sd-boot: instead of unconditionally deriving the ESP to search boot loader
850850
spec entries in from the paths of sd-boot binary, let's optionally allow it
851-
to be configured on sd-boot cmdline + efi var. Usecase: embed sd-boot in the
851+
to be configured on sd-boot cmdline + efi var. Use case: embed sd-boot in the
852852
UEFI firmware (for example, ovmf supports that via qemu cmdline option), and
853853
use it to load stuff from the ESP.
854854

@@ -888,7 +888,7 @@ Features:
888888
* homed/userdb: maybe define a "companion" dir for home directories where apps
889889
can safely put privileged stuff in. Would not be writable by the user, but
890890
still conceptually belong to the user. Would be included in user's quota if
891-
possible, even if files are not owned by UID of user. Usecase: container
891+
possible, even if files are not owned by UID of user. Use case: container
892892
images that owned by arbitrary UIDs, and are owned/managed by the users, but
893893
are not directly belonging to the user's UID. Goal: we shouldn't place more
894894
privileged dirs inside of unprivileged dirs, and thus containers really
@@ -995,7 +995,7 @@ Features:
995995
look for right in the sd-boot binary. i.e. take inspiration from sd-stub
996996
logic: allow combining sd-boot via ukify with kernels to enumerate, .conf
997997
files, drivers, keys to enroll and so on. Then, add whatever we find that way
998-
to the menu. Usecase: allow building a single PE image you can boot into via
998+
to the menu. Use case: allow building a single PE image you can boot into via
999999
UEFI HTTP boot.
10001000

10011001
* maybe add a new UEFI stub binary "sd-http". It works similar to sd-stub, but
@@ -1016,7 +1016,7 @@ Features:
10161016
* maybe add a generator that reads /proc/cmdline, looks for
10171017
systemd.pull-raw-portable=, systemd-pull-raw-sysext= and similar switches
10181018
that take a URL as parameter. It then generates service units for
1019-
systemd-pull calls that download these URLs if not installed yet. usecase:
1019+
systemd-pull calls that download these URLs if not installed yet. Use case:
10201020
invoke a VM or nspawn container in a way it automatically deploys/runs these
10211021
images as OS payloads. i.e. have a generic OS image you can point to any
10221022
payload you like, which is then downloaded, securely verified and run.
@@ -1126,9 +1126,9 @@ Features:
11261126

11271127
* add tiny service that decrypts encrypted user records passed via initrd
11281128
credential logic and drops them into /run where nss-systemd can pick them up,
1129-
similar to /run/host/userdb/. Usecase: drop a root user JSON record there,
1129+
similar to /run/host/userdb/. Use case: drop a root user JSON record there,
11301130
and use it in the initrd to log in as root with locally selected password,
1131-
for debugging purposes. Other usecase: boot into qemu with regular user
1131+
for debugging purposes. Other use case: boot into qemu with regular user
11321132
mounted from host. maybe put this in systemd-user-sessions.service?
11331133

11341134
* drop dependency on libcap, replace by direct syscalls based on
@@ -1242,7 +1242,7 @@ Features:
12421242
the resulting fd to the service program via socket activation proto.
12431243

12441244
* Add a concept of ListenStream=anonymous to socket units: listen on a socket
1245-
that is deleted in the fs. Usecase would be with ConnectSocket= above.
1245+
that is deleted in the fs. Use case would be with ConnectSocket= above.
12461246

12471247
* importd: support image signature verification with PKCS#7 + OpenBSD signify
12481248
logic, as alternative to crummy gpg
@@ -1539,7 +1539,7 @@ Features:
15391539
else. Similar, ManagerSlice= should exist so that PID1's own scope unit could
15401540
be moved somewhere else too. Finally machined and logind should get similar
15411541
options so that it is possible to move user session scopes and machines to a
1542-
different slice too by default. Usecase: people who want to put resources on
1542+
different slice too by default. Use case: people who want to put resources on
15431543
the entire system, with the exception of one specific service. See:
15441544
https://lists.freedesktop.org/archives/systemd-devel/2018-February/040369.html
15451545

@@ -1839,7 +1839,7 @@ Features:
18391839
- generate better errors when people try to set transient properties
18401840
that are not supported...
18411841
https://lists.freedesktop.org/archives/systemd-devel/2015-February/028076.html
1842-
- maybe introduce WantsMountsFor=? Usecase:
1842+
- maybe introduce WantsMountsFor=? Use case:
18431843
https://lists.freedesktop.org/archives/systemd-devel/2015-January/027729.html
18441844
- recreate systemd's D-Bus private socket file on SIGUSR2
18451845
- move PAM code into its own binary
@@ -1911,7 +1911,7 @@ Features:
19111911
* BootLoaderSpec: Define a way how an installer can figure out whether a BLS
19121912
compliant boot loader is installed.
19131913

1914-
* think about requeuing jobs when daemon-reload is issued? usecase:
1914+
* think about requeuing jobs when daemon-reload is issued? use case:
19151915
the initrd issues a reload after fstab from the host is accessible
19161916
and we might want to requeue the mounts local-fs acquired through
19171917
that automatically.

docs/FILE_DESCRIPTOR_STORE.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ maintains a duplicate of it (in the sense of UNIX
3232
also in possession of the service itself, and it may (and is expected to)
3333
invoke any operations on it that it likes.
3434

35-
The primary usecase of this logic is to permit services to restart seamlessly
35+
The primary use case of this logic is to permit services to restart seamlessly
3636
(for example to update them to a newer version), without losing execution
3737
context, dropping pinned resources, terminating established connections or even
3838
just momentarily losing connectivity. In fact, as the file descriptors can be
@@ -81,7 +81,7 @@ And that's already the gist of it.
8181
A system service that provides a client-facing interface that shall be able to
8282
seamlessly restart can make use of this in a scheme like the following:
8383
whenever a new connection comes in it uploads its fd immediately into its
84-
fdstore. At approporate times it also serializes its state into a memfd it
84+
fdstore. At appropriate times it also serializes its state into a memfd it
8585
uploads to the service manager — either whenever the state changed
8686
sufficiently, or simply right before it terminates. (The latter of course means
8787
that state only survives on *clean* restarts and abnormal termination implies the
@@ -104,7 +104,7 @@ lifecycle management (i.e. `KillMode=none` must be set), which disables large
104104
parts of the service managers state tracking, resource management (as resource
105105
counters cannot start at zero during service activation anymore, since the old
106106
processes remaining skew them), security policies (as processes with possibly
107-
out-of-date security policies – selinux, AppArmor, any LSM, seccomp, BPF — in
107+
out-of-date security policies – SElinux, AppArmor, any LSM, seccomp, BPF — in
108108
effect remain), and similar.
109109

110110
# File Descriptor Store Lifecycle
@@ -176,7 +176,7 @@ This mechanism can be enabled either by making sure the service survives until
176176
the very end (i.e. by setting `DefaultDependencies=no` so that it keeps running
177177
for the whole system lifetime without being regularly deactivated at shutdown)
178178
or by setting `FileDescriptorStorePresever=yes` (and referencing the unit
179-
continously).
179+
continuously).
180180

181181
# Debugging
182182

man/repart.d.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -487,7 +487,7 @@
487487
together the former is applied first. If a directory listed already exists no operation is executed
488488
(in particular, the ownership/access mode of the directories is left as is).</para>
489489

490-
<para>The primary usecase for this option is to create a minimal set of directories that may be
490+
<para>The primary use case for this option is to create a minimal set of directories that may be
491491
mounted over by other partitions contained in the same disk image. For example, a disk image where
492492
the root file system is formatted at first boot might want to automatically pre-create
493493
<filename>/usr/</filename> in it this way, so that the <literal>usr</literal> partition may

man/sd_listen_fds.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,7 @@
114114
for details. For file descriptors pushed into the file descriptor
115115
store (see above), the name is set via the
116116
<varname>FDNAME=</varname> field transmitted via
117-
<function>sd_pid_notify_with_fds()</function>. The primary usecase
117+
<function>sd_pid_notify_with_fds()</function>. The primary use case
118118
for these names are services which accept a variety of file
119119
descriptors which are not recognizable with functions like
120120
<function>sd_is_socket()</function> alone, and thus require

man/systemd.resource-control.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -755,7 +755,7 @@ CPUWeight=20 DisableControllers=cpu / \
755755
not applied to any sockets passed into the service via socket activation. Thus, it is usually a
756756
good idea to replicate the IP access lists on both the socket and the service unit. Nevertheless,
757757
it may make sense to maintain one list more open and the other one more restricted, depending on
758-
the usecase.</para>
758+
the use case.</para>
759759

760760
<para>If these settings are used multiple times in the same unit the specified lists are combined. If an
761761
empty string is assigned to these settings the specific access list is reset and all previous settings undone.</para>
@@ -993,7 +993,7 @@ RestrictNetworkInterfaces=~eth1</programlisting>
993993
for it. Conversely, the IP filter programs configured for the service are not applied to any sockets passed into
994994
the service via socket activation. Thus, it is usually a good idea, to replicate the IP filter programs on both
995995
the socket and the service unit, however it often makes sense to maintain one configuration more open and the other
996-
one more restricted, depending on the usecase.</para>
996+
one more restricted, depending on the use case.</para>
997997

998998
<para>Note that these settings might not be supported on some systems (for example if eBPF control group
999999
support is not enabled in the underlying kernel or container manager). These settings will fail the service in

src/basic/macro.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414

1515
/* Note: on GCC "no_sanitize_address" is a function attribute only, on llvm it may also be applied to global
1616
* variables. We define a specific macro which knows this. Note that on GCC we don't need this decorator so much, since
17-
* our primary usecase for this attribute is registration structures placed in named ELF sections which shall not be
17+
* our primary use case for this attribute is registration structures placed in named ELF sections which shall not be
1818
* padded, but GCC doesn't pad those anyway if AddressSanitizer is enabled. */
1919
#if HAS_FEATURE_ADDRESS_SANITIZER && defined(__clang__)
2020
#define _variable_no_sanitize_address_ __attribute__((__no_sanitize_address__))

src/basic/special.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@
5757
* Rules regarding adding further high level targets like the above:
5858
*
5959
* - Be conservative, only add more of these when we really need
60-
* them. We need strong usecases for further additions.
60+
* them. We need strong use cases for further additions.
6161
*
6262
* - When there can be multiple implementations running side-by-side,
6363
* it needs to be a .target unit which can pull in all

src/boot/efi/bcd.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ assert_cc(offsetof(BaseBlock, type) == 28);
4242
assert_cc(offsetof(BaseBlock, root_cell_offset) == 36);
4343

4444
/* All offsets are relative to the base block and technically point to a hive
45-
* cell struct. But for our usecase we don't need to bother about that one,
45+
* cell struct. But for our use case we don't need to bother about that one,
4646
* so skip over the cell_size uint32_t. */
4747
#define HIVE_CELL_OFFSET (sizeof(BaseBlock) + 4)
4848

src/cgtop/cgtop.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,7 @@ static bool is_root_cgroup(const char *path) {
139139
*
140140
* Note that checking for a container environment is kinda ugly, since in theory people could use cgtop from
141141
* inside a container where cgroup namespacing is turned off to watch the host system. However, that's mostly a
142-
* theoretic usecase, and if people actually try all they'll lose is accounting for the top-level cgroup. Which
142+
* theoretic use case, and if people actually try all they'll lose is accounting for the top-level cgroup. Which
143143
* isn't too bad. */
144144

145145
if (detect_container() > 0)

src/core/dbus-execute.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2459,7 +2459,7 @@ int bus_exec_context_set_transient_property(
24592459
* and we should not "lose precision" in our types on the way. That said, I am pretty sure
24602460
* actually encoding binary data as unit metadata is not a good idea. Hence we actually refuse
24612461
* any actual binary data, and only accept UTF-8. This allows us to eventually lift this
2462-
* limitation, should a good, valid usecase arise. */
2462+
* limitation, should a good, valid use case arise. */
24632463

24642464
r = sd_bus_message_read_array(message, 'y', &p, &sz);
24652465
if (r < 0)

0 commit comments

Comments
 (0)