From 211c99c7610395d151150a15b36ef0f57d1fd9e0 Mon Sep 17 00:00:00 2001 From: =?utf8?q?Zbigniew=20J=C4=99drzejewski-Szmek?= Date: Tue, 29 Sep 2020 10:04:12 +0200 Subject: [PATCH] man: do not index various /foobar/ paths For #17177. --- man/environment.d.xml | 2 +- man/systemd-hibernate-resume-generator.xml | 2 +- man/systemd-homed.service.xml | 6 +++--- man/systemd-nspawn.xml | 21 +++++++++++---------- man/systemd.exec.xml | 2 +- man/systemd.service.xml | 2 +- man/systemd.special.xml | 4 ++-- man/systemd.unit.xml | 4 ++-- 8 files changed, 22 insertions(+), 21 deletions(-) diff --git a/man/environment.d.xml b/man/environment.d.xml index 0f53b0fef1..4db44616a7 100644 --- a/man/environment.d.xml +++ b/man/environment.d.xml @@ -76,7 +76,7 @@ Setup environment to allow access to a program installed in <filename index="false">/opt/foo</filename> - /etc/environment.d/60-foo.conf: + /etc/environment.d/60-foo.conf: FOO_DEBUG=force-software-gl,log-verbose diff --git a/man/systemd-hibernate-resume-generator.xml b/man/systemd-hibernate-resume-generator.xml index f532a19a48..60d66b201d 100644 --- a/man/systemd-hibernate-resume-generator.xml +++ b/man/systemd-hibernate-resume-generator.xml @@ -49,7 +49,7 @@ Takes a path to the resume device. Both persistent block device paths like - /dev/disk/by-foo/bar and + /dev/disk/by-foo/bar and fstab5-style specifiers like FOO=bar are supported. diff --git a/man/systemd-homed.service.xml b/man/systemd-homed.service.xml index ab8bcab8cb..d6a239bc96 100644 --- a/man/systemd-homed.service.xml +++ b/man/systemd-homed.service.xml @@ -86,9 +86,9 @@ In order to migrate a home directory from a host foobar to another host quux it is hence sufficient to copy /var/lib/systemd/home/local.public from the host foobar to - quux, maybe calling the file on the destination - /var/lib/systemd/home/foobar.public, reflecting the origin of the key. If the user - record should be modifiable on quux the pair + quux, maybe calling the file on the destination /var/lib/systemd/home/foobar.public, reflecting the origin of the key. If the + user record should be modifiable on quux the pair /var/lib/systemd/home/local.public and /var/lib/systemd/home/local.private need to be copied from foobar to quux, and placed under the identical paths there, as currently only a single diff --git a/man/systemd-nspawn.xml b/man/systemd-nspawn.xml index 7c89bc4423..cfdd27d8c4 100644 --- a/man/systemd-nspawn.xml +++ b/man/systemd-nspawn.xml @@ -348,16 +348,17 @@ terminated. When the mode parameter is specified as (the default), the whole OS tree is made available writable (unless is specified, see above). - Note that if one of the volatile modes is chosen, its effect is limited to the root file system (or - /var/ in case of ), and any other mounts placed in the hierarchy are - unaffected — regardless if they are established automatically (e.g. the EFI system partition that might be - mounted to /efi/ or /boot/) or explicitly (e.g. through an additional - command line option such as , see below). This means, even if - is used changes to /efi/ or - /boot/ are prohibited in case such a partition exists in the container image operated on, - and even if is used the hypothetical file /etc/foobar is - potentially writable if if used to mount it from outside the read-only - container /etc directory. + Note that if one of the volatile modes is chosen, its effect is limited to the root file system + (or /var/ in case of ), and any other mounts placed in the + hierarchy are unaffected — regardless if they are established automatically (e.g. the EFI system + partition that might be mounted to /efi/ or /boot/) or + explicitly (e.g. through an additional command line option such as , see + below). This means, even if is used changes to + /efi/ or /boot/ are prohibited in case such a partition + exists in the container image operated on, and even if is used the + hypothetical file /etc/foobar is potentially writable if + if used to mount it from outside the read-only container + /etc directory. The option is closely related to this setting, and provides similar behaviour by making a temporary, ephemeral copy of the whole OS image and executing that. For further details, diff --git a/man/systemd.exec.xml b/man/systemd.exec.xml index ed657831f6..108e3c9bc6 100644 --- a/man/systemd.exec.xml +++ b/man/systemd.exec.xml @@ -1275,7 +1275,7 @@ CapabilityBoundingSet=~CAP_B CAP_C Example: if a system service unit has the following, RuntimeDirectory=foo/bar baz - the service manager creates /run/foo (if it does not exist), + the service manager creates /run/foo (if it does not exist), /run/foo/bar, and /run/baz. The directories /run/foo/bar and diff --git a/man/systemd.service.xml b/man/systemd.service.xml index d11e37da84..aec3a764a8 100644 --- a/man/systemd.service.xml +++ b/man/systemd.service.xml @@ -1307,7 +1307,7 @@ ls Simple service The following unit file creates a service that will - execute /usr/sbin/foo-daemon. Since no + execute /usr/sbin/foo-daemon. Since no Type= is specified, the default Type= will be assumed. systemd will assume the unit to be started immediately after the diff --git a/man/systemd.special.xml b/man/systemd.special.xml index a948969a8f..7011537d1f 100644 --- a/man/systemd.special.xml +++ b/man/systemd.special.xml @@ -862,8 +862,8 @@ pulled in via a dependency of the storage daemon and thus generally not be part of any transaction unless a storage daemon is used. The instance name for instances of this template unit must be a properly escaped block device node path, e.g. - blockdev@dev-mapper-foobar.target for the storage device - /dev/mapper/foobar. + blockdev@dev-mapper-foobar.target for the storage device + /dev/mapper/foobar. cryptsetup-pre.target diff --git a/man/systemd.unit.xml b/man/systemd.unit.xml index cc6606022b..1ab6e2b0b9 100644 --- a/man/systemd.unit.xml +++ b/man/systemd.unit.xml @@ -279,7 +279,7 @@ When the input qualifies as absolute file system path, this algorithm is extended slightly: the path to the root directory / is encoded as single dash -. In addition, any leading, trailing or duplicate / characters are removed from the string before transformation. Example: - /foo//bar/baz/ becomes foo-bar-baz. + /foo//bar/baz/ becomes foo-bar-baz. This escaping is fully reversible, as long as it is known whether the escaped string was a path (the unescaping results are different for paths and non-path strings). The @@ -1922,7 +1922,7 @@ ExecStart=/usr/sbin/foo-daemon After running systemctl enable, a symlink - /etc/systemd/system/multi-user.target.wants/foo.service + /etc/systemd/system/multi-user.target.wants/foo.service linking to the actual unit will be created. It tells systemd to pull in the unit when starting multi-user.target. The inverse -- 2.25.1