From 5c7a4f21ddc26519e00ca2d20109492e70195b7c Mon Sep 17 00:00:00 2001 From: "Dmitry V. Levin" Date: Sun, 15 Jan 2023 08:00:00 +0000 Subject: [PATCH] docs, man: consistently use comma after "For example" --- docs/BUILDING_IMAGES.md | 2 +- docs/CGROUP_DELEGATION.md | 2 +- docs/CODING_STYLE.md | 2 +- docs/PORTABILITY_AND_STABILITY.md | 2 +- docs/USERDB_AND_DESKTOPS.md | 2 +- docs/USER_GROUP_API.md | 2 +- docs/USER_NAMES.md | 2 +- man/systemd-system.conf.xml | 2 +- man/systemd.unit.xml | 2 +- 9 files changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/BUILDING_IMAGES.md b/docs/BUILDING_IMAGES.md index fb802dbd0f7..c7f7d496385 100644 --- a/docs/BUILDING_IMAGES.md +++ b/docs/BUILDING_IMAGES.md @@ -161,7 +161,7 @@ the OS should take possession of the backing storage as necessary, dynamically using available space. Specifically: 1. Additional partitions should be created, that make no sense to ship - pre-built in the image. For example `/tmp/` or `/home/` partitions, or even + pre-built in the image. For example, `/tmp/` or `/home/` partitions, or even `/var/` or the root file system (see above). 2. Additional partitions should be created that shall function as A/B diff --git a/docs/CGROUP_DELEGATION.md b/docs/CGROUP_DELEGATION.md index 1ead5e79067..f5509fb8331 100644 --- a/docs/CGROUP_DELEGATION.md +++ b/docs/CGROUP_DELEGATION.md @@ -78,7 +78,7 @@ Note that cgroup v1 is currently the most deployed implementation, even though it's semantically broken in many ways, and in many cases doesn't actually do what people think it does. cgroup v2 is where things are going, and most new kernel features in this area are only added to cgroup v2, and not cgroup v1 -anymore. For example cgroup v2 provides proper cgroup-empty notifications, has +anymore. For example, cgroup v2 provides proper cgroup-empty notifications, has support for all kinds of per-cgroup BPF magic, supports secure delegation of cgroup trees to less privileged processes and so on, which all are not available on cgroup v1. diff --git a/docs/CODING_STYLE.md b/docs/CODING_STYLE.md index 26183ff3725..516207071bb 100644 --- a/docs/CODING_STYLE.md +++ b/docs/CODING_STYLE.md @@ -712,7 +712,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later ## Committing to git - Commit message subject lines should be prefixed with an appropriate component - name of some kind. For example "journal: ", "nspawn: " and so on. + name of some kind. For example, "journal: ", "nspawn: " and so on. - Do not use "Signed-Off-By:" in your commit messages. That's a kernel thing we don't do in the systemd project. diff --git a/docs/PORTABILITY_AND_STABILITY.md b/docs/PORTABILITY_AND_STABILITY.md index b1971f0e7eb..dfbca2352a6 100644 --- a/docs/PORTABILITY_AND_STABILITY.md +++ b/docs/PORTABILITY_AND_STABILITY.md @@ -155,7 +155,7 @@ without communicating with the `systemd` process: `systemd-sysusers`. Many other programs support operation without the system manager except when -the specific functionality requires such communication. For example +the specific functionality requires such communication. For example, `journalctl` operates almost independently, but will query the boot id when `--boot` option is used; it also requires `systemd-journald` (and thus `systemd`) to be running for options like `--flush` and `--sync`. diff --git a/docs/USERDB_AND_DESKTOPS.md b/docs/USERDB_AND_DESKTOPS.md index 7017d8d86ed..9006eeb5ec3 100644 --- a/docs/USERDB_AND_DESKTOPS.md +++ b/docs/USERDB_AND_DESKTOPS.md @@ -152,7 +152,7 @@ users registered in `/etc/passwd` or LDAP to users managed by ## Future Additions JSON user/group records are extensible, hence we can easily add any additional -fields desktop environments require. For example pattern-based authentication +fields desktop environments require. For example, pattern-based authentication is likely very useful on touch-based devices, and the user records should hence learn them natively. Fields for other authentication mechanisms, such as fingerprint authentication should be provided as well, eventually. diff --git a/docs/USER_GROUP_API.md b/docs/USER_GROUP_API.md index 30063135b69..45e3c9da27f 100644 --- a/docs/USER_GROUP_API.md +++ b/docs/USER_GROUP_API.md @@ -129,7 +129,7 @@ interface. Specifically: `systemd-machined.service` and provides records for the users and groups used by local containers that use user namespacing. -Other projects are invited to implement these services too. For example it +Other projects are invited to implement these services too. For example, it would make sense for LDAP/ActiveDirectory projects to implement these interfaces, which would provide them a way to do per-user resource management enforced by systemd and defined directly in LDAP directories. diff --git a/docs/USER_NAMES.md b/docs/USER_NAMES.md index 1da0cac32c4..74c24b5157a 100644 --- a/docs/USER_NAMES.md +++ b/docs/USER_NAMES.md @@ -151,7 +151,7 @@ user/group names accepted by the strict rules are also accepted by the relaxed rules, but not vice versa. Note that this relaxed mode does not refuse a couple of very questionable -syntaxes. For example it permits a leading or embedded period. A leading period +syntaxes. For example, it permits a leading or embedded period. A leading period is problematic because the matching home directory would typically be hidden from the user's/administrator's view. An embedded period is problematic since it creates ambiguity in traditional `chown` syntax (which is still accepted diff --git a/man/systemd-system.conf.xml b/man/systemd-system.conf.xml index 6406df13ae6..481fa31e014 100644 --- a/man/systemd-system.conf.xml +++ b/man/systemd-system.conf.xml @@ -464,7 +464,7 @@ of slice units. Defaults to 15% of the minimum of kernel.pid_max=, kernel.threads-max= and root cgroup pids.max. Kernel has a default value for kernel.pid_max= and an algorithm of counting in case of more than 32 cores. - For example with the default kernel.pid_max=, DefaultTasksMax= defaults to 4915, + For example, with the default kernel.pid_max=, DefaultTasksMax= defaults to 4915, but might be greater in other systems or smaller in OS containers. diff --git a/man/systemd.unit.xml b/man/systemd.unit.xml index 91015c8f47c..556fcad3a44 100644 --- a/man/systemd.unit.xml +++ b/man/systemd.unit.xml @@ -2329,7 +2329,7 @@ PrivateTmp=yes Top level drop-ins with template units Top level per-type drop-ins can be used to change some aspect of - all units of a particular type. For example by creating the + all units of a particular type. For example, by creating the /etc/systemd/system/service.d/ directory with a drop-in file, the contents of the drop-in file can be applied to all service units. We can take this further by having the -- 2.39.2