From 8bf9eb7e6b8ecefe7e1792e545c967e1785cbe96 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Zbigniew=20J=C4=99drzejewski-Szmek?= Date: Sat, 9 Jul 2022 17:42:07 +0200 Subject: [PATCH] man: update the description of taint flags We had a description in README, and an outdated list in the man page. I think we should keep a reference-style list in the man page. The description in README is more free-form. --- README | 4 +- man/org.freedesktop.systemd1.xml | 94 +++++++++++++++++++++++++++----- 2 files changed, 83 insertions(+), 15 deletions(-) diff --git a/README b/README index 566f1253b8a..0b9988ce20d 100644 --- a/README +++ b/README @@ -359,7 +359,7 @@ WARNINGS and TAINT FLAGS: will break if /usr is on a separate late-mounted partition, many of its dependencies very likely will break sooner or later in one form or another. For example, udev rules tend to refer to binaries in /usr, - binaries that link to libraries in /usr or binaries that refer to data + binaries that link to libraries in /usr, or binaries that refer to data files in /usr. Since these breakages are not always directly visible, systemd will warn about this. Such setups are not really supported by the basic set of Linux OS components. Taint flag 'split-usr' will be @@ -393,6 +393,8 @@ WARNINGS and TAINT FLAGS: busctl get-property org.freedesktop.systemd1 /org/freedesktop/systemd1 org.freedesktop.systemd1.Manager Tainted + See org.freedesktop.systemd1(5) for more information. + VALGRIND: To run systemd under valgrind, compile with meson option -Dvalgrind=true and have valgrind development headers installed diff --git a/man/org.freedesktop.systemd1.xml b/man/org.freedesktop.systemd1.xml index 79748335547..6a532def968 100644 --- a/man/org.freedesktop.systemd1.xml +++ b/man/org.freedesktop.systemd1.xml @@ -1494,21 +1494,87 @@ node /org/freedesktop/systemd1 { it is not part of the public API. Features encodes the features that have been enabled and disabled for this - build. Enabled options are prefixed with +, disabled options with -. + build. Enabled options are prefixed with +, disabled options with + -. - Tainted encodes a couple of taint flags as a colon-separated list. When - systemd detects it is running on a system with certain problems, it will set an appropriate taint - flag. Taints may be used to lower the chance of bogus bug reports. The following taints are currently - known: split-usr, mtab-not-symlink, - cgroups-missing, local-hwclock. split-usr is - set if /usr/ is not pre-mounted when systemd is first invoked. See - - Booting Without /usr is Broken - for details why this is bad. mtab-not-symlink indicates that - /etc/mtab is not a symlink to /proc/self/mounts as - required. cgroups-missing indicates that control groups have not been enabled in the - kernel. local-hwclock indicates that the local RTC is configured to be in local time - rather than UTC. + Tainted encodes taint flags as a colon-separated list. When systemd detects it + is running on a system with a certain problem, it will set an appropriate taint flag. Taints may be + used to lower the chance of bogus bug reports. The following taints are currently known: + + + + split-usr + + /usr/ was not available when systemd was first invoked. It + must either be part of the root file system, or it must be mounted before + systemd is invoked. See + + Booting Without /usr is Broken for details why this is bad. + + + + + unmerged-usr + + /bin, /sbin and + /lib* are not symlinks to their counterparts under /usr/. + For more information on this issue consult + + The Case for the /usr Merge + . + + + + + cgroups-missing + + Support for cgroups is unavailable. + + + + cgroupsv1 + + The system is using the old cgroup hierarchy. + + + + local-hwclock + + The local hardware clock (RTC) is configured to be in local time rather than + UTC. + + + + old-kernel + + The system is running a kernel version that is older than the minimum supported by + this version of systemd. + + + + var-run-bad + + /run/ does not exist or /var/run is not a + symlink to /run/. + + + + overflowuid-not-65534 + overflowgid-not-65534 + + The kernel overflow UID or GID have a value other than 65534. + + + + short-uid-range + short-gid-range + + The UID or GID range assigned to the running systemd instance covers less than + 0…65534. + + + + FirmwareTimestamp, FirmwareTimestampMonotonic, LoaderTimestamp, LoaderTimestampMonotonic,