From b0343f8c96e984211c24c3ba404f0a82b60244b4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Zbigniew=20J=C4=99drzejewski-Szmek?= Date: Thu, 21 Nov 2019 20:22:12 +0100 Subject: [PATCH] man: change noindex="true" to index="false" We nowadays prefer positive options over negative. --- man/coredumpctl.xml | 2 +- man/environment.d.xml | 2 +- man/systemd-analyze.xml | 6 +++--- man/systemd-cat.xml | 2 +- man/systemd-nspawn.xml | 2 +- man/systemd.automount.xml | 2 +- man/systemd.device.xml | 2 +- man/systemd.link.xml | 2 +- man/systemd.mount.xml | 2 +- man/systemd.net-naming-scheme.xml | 4 ++-- man/systemd.offline-updates.xml | 12 ++++++------ man/systemd.service.xml | 4 ++-- man/systemd.swap.xml | 2 +- man/systemd.unit.xml | 10 +++++----- man/tmpfiles.d.xml | 2 +- man/user@.service.xml | 28 ++++++++++++++-------------- tools/make-directive-index.py | 4 ++-- 17 files changed, 44 insertions(+), 44 deletions(-) diff --git a/man/coredumpctl.xml b/man/coredumpctl.xml index 2b0f62a28d..4e99bc0d69 100644 --- a/man/coredumpctl.xml +++ b/man/coredumpctl.xml @@ -321,7 +321,7 @@ Extract the last core dump of /usr/bin/bar to a file named - <filename noindex="true">bar.coredump</filename> + bar.coredump # coredumpctl -o bar.coredump dump /usr/bin/bar diff --git a/man/environment.d.xml b/man/environment.d.xml index 702154837b..69c156aacb 100644 --- a/man/environment.d.xml +++ b/man/environment.d.xml @@ -75,7 +75,7 @@ Example Setup environment to allow access to a program installed in - <filename noindex='true'>/opt/foo</filename> + /opt/foo /etc/environment.d/60-foo.conf: diff --git a/man/systemd-analyze.xml b/man/systemd-analyze.xml index dcb7cf29c1..911a00bc02 100644 --- a/man/systemd-analyze.xml +++ b/man/systemd-analyze.xml @@ -348,8 +348,8 @@ DATAERR 65 BSD <command>systemd-analyze condition <replaceable>CONDITION</replaceable>...</command> - This command will evaluate Condition*=... and - Assert*=... assignments, and print their values, and + This command will evaluate Condition*=... and + Assert*=... assignments, and print their values, and the resulting value of the combined condition set. See systemd.unit5 for a list of available conditions and asserts. @@ -602,7 +602,7 @@ Service b@0.service not loaded, b.socket cannot be started. policy is not validated too. - Analyze <filename noindex="true">systemd-logind.service</filename> + Analyze <filename index="false">systemd-logind.service</filename> $ systemd-analyze security --no-pager systemd-logind.service NAME DESCRIPTION EXPOSURE diff --git a/man/systemd-cat.xml b/man/systemd-cat.xml index f3d6f3785f..96d3072a1f 100644 --- a/man/systemd-cat.xml +++ b/man/systemd-cat.xml @@ -140,7 +140,7 @@ Invoke a program - This calls /bin/ls + This calls /bin/ls with standard output and error connected to the journal: # systemd-cat ls diff --git a/man/systemd-nspawn.xml b/man/systemd-nspawn.xml index 92987ff32f..f5d42350dd 100644 --- a/man/systemd-nspawn.xml +++ b/man/systemd-nspawn.xml @@ -1366,7 +1366,7 @@ # systemd-nspawn -bD /var/lib/machines/f&fedora_latest_version; This installs a minimal Fedora distribution into the - directory /var/lib/machines/f&fedora_latest_version; + directory /var/lib/machines/f&fedora_latest_version; and then boots an OS in a namespace container in it. Because the installation is located underneath the standard /var/lib/machines/ directory, it is also possible to start the machine using diff --git a/man/systemd.automount.xml b/man/systemd.automount.xml index 75302e07e9..f2ed761021 100644 --- a/man/systemd.automount.xml +++ b/man/systemd.automount.xml @@ -40,7 +40,7 @@ are configured in the [Automount] section. Automount units must be named after the automount directories they control. Example: the automount point - /home/lennart must be configured in a unit file + /home/lennart must be configured in a unit file home-lennart.automount. For details about the escaping logic used to convert a file system path to a unit name see systemd.unit5. Note that diff --git a/man/systemd.device.xml b/man/systemd.device.xml index ff7ab9ccce..ae786a3298 100644 --- a/man/systemd.device.xml +++ b/man/systemd.device.xml @@ -51,7 +51,7 @@ Device units are named after the /sys and /dev paths they control. Example: the - device /dev/sda5 is exposed in + device /dev/sda5 is exposed in systemd as dev-sda5.device. For details about the escaping logic used to convert a file system path to a unit name see diff --git a/man/systemd.link.xml b/man/systemd.link.xml index 5013e7e9b5..59d1434694 100644 --- a/man/systemd.link.xml +++ b/man/systemd.link.xml @@ -709,7 +709,7 @@ ID_NET_LINK_FILE=/usr/lib/systemd/network/99-default.link In this case, the interface was already renamed, so the policy specified as - the first option in 99-default.link means that the existing name is + the first option in 99-default.link means that the existing name is preserved. If was removed, or if were in boot before the renaming has happened, we might get the following instead: diff --git a/man/systemd.mount.xml b/man/systemd.mount.xml index a72a33240d..b2c9d60681 100644 --- a/man/systemd.mount.xml +++ b/man/systemd.mount.xml @@ -60,7 +60,7 @@ must be run as UID 0. Mount units must be named after the mount point directories they control. Example: the mount point /home/lennart must be configured in a unit file home-lennart.mount. + index="false">/home/lennart must be configured in a unit file home-lennart.mount. For details about the escaping logic used to convert a file system path to a unit name, see systemd.unit5. Note that mount units cannot be templated, nor is possible to add multiple names to a mount unit by creating additional symlinks to diff --git a/man/systemd.net-naming-scheme.xml b/man/systemd.net-naming-scheme.xml index 419fed62ea..ec3b8671f2 100644 --- a/man/systemd.net-naming-scheme.xml +++ b/man/systemd.net-naming-scheme.xml @@ -300,7 +300,7 @@ again. Previously, this naming policy applied implicitly, and now it must be explicitly requested. Effectively, this means that network devices will be renamed according to the configuration, even if they have been renamed already, if keep is not - specified as the naming policy in the .link file. See + specified as the naming policy in the .link file. See systemd.link5 for a description of NamePolicy=. @@ -310,7 +310,7 @@ was extended to set MAC addresses based on the device name. Previously addresses were only based on the - ID_NET_NAME_* attributes, which meant that interface names would + ID_NET_NAME_* attributes, which meant that interface names would never be generated for virtual devices. Now a persistent address will be generated for most devices, including in particular bridges. diff --git a/man/systemd.offline-updates.xml b/man/systemd.offline-updates.xml index 06390669de..89c12b598b 100644 --- a/man/systemd.offline-updates.xml +++ b/man/systemd.offline-updates.xml @@ -35,13 +35,13 @@ The package manager prepares system updates by downloading all (RPM or DEB or whatever) packages to update off-line in a special directory - /var/lib/system-update (or + /var/lib/system-update (or another directory of the package/upgrade manager's choice). When the user OK'ed the update, the symlink /system-update is - created that points to /var/lib/system-update (or + created that points to /var/lib/system-update (or wherever the directory with the upgrade files is located) and the system is rebooted. This symlink is in the root directory, since we need to check for it very early at boot, at a time where /var is not available yet. @@ -106,12 +106,12 @@ To make things a bit more robust we recommend hooking the update script into - system-update.target via a .wants/ + system-update.target via a .wants/ symlink in the distribution package, rather than depending on systemctl enable in the postinst scriptlets of your package. More specifically, for your update script create a .service file, without [Install] section, and then add a symlink like - /usr/lib/systemd/system-update.target.wants/foobar.service - → ../foobar.service to your package. + /usr/lib/systemd/system-update.target.wants/foobar.service + → ../foobar.service to your package. @@ -144,7 +144,7 @@ Wants=system-update-pre.target and Before=system-update-pre.target and add a symlink to that file under - /usr/lib/systemd/system-update.target.wants + /usr/lib/systemd/system-update.target.wants . diff --git a/man/systemd.service.xml b/man/systemd.service.xml index f57e37ca5b..f76005a296 100644 --- a/man/systemd.service.xml +++ b/man/systemd.service.xml @@ -1329,8 +1329,8 @@ WantedBy=multi-user.target Type= are the only service units that may have more than one ExecStart= specified. For units with multiple - commands (Type=oneshot), all commands will be run again. - For Type=oneshot, Restart= + commands (Type=oneshot), all commands will be run again. + For Type=oneshot, Restart= and Restart= are not allowed. diff --git a/man/systemd.swap.xml b/man/systemd.swap.xml index 23547bb273..190fc388c0 100644 --- a/man/systemd.swap.xml +++ b/man/systemd.swap.xml @@ -54,7 +54,7 @@ unit. Swap units must be named after the devices or files they control. Example: the swap device /dev/sda5 must be configured in a unit file dev-sda5.swap. For + index="false">/dev/sda5 must be configured in a unit file dev-sda5.swap. For details about the escaping logic used to convert a file system path to a unit name, see systemd.unit5. Note that swap units cannot be templated, nor is possible to add multiple names to a swap unit by creating additional symlinks to diff --git a/man/systemd.unit.xml b/man/systemd.unit.xml index d6ff6cf9cb..b7bae08c69 100644 --- a/man/systemd.unit.xml +++ b/man/systemd.unit.xml @@ -246,7 +246,7 @@ escaping is used, in order to map strings containing arbitrary byte values (except NUL) into valid unit names and their restricted character set. A common special case are unit names that reflect paths to objects in the file system hierarchy. Example: a device unit dev-sda.device refers to a device with the device - node /dev/sda in the file system. + node /dev/sda in the file system. The escaping algorithm operates as follows: given a string, any / character is replaced by -, and all other characters which are not ASCII alphanumerics or _ are @@ -435,7 +435,7 @@ Units of packages that have been installed in the home directory ($XDG_DATA_HOME is used if set, ~/.local/share otherwise) - $dir/systemd/user for each $dir in $XDG_DATA_DIRS + $dir/systemd/user for each $dir in $XDG_DATA_DIRS Additional locations for installed user units, one for each entry in $XDG_DATA_DIRS @@ -1026,8 +1026,8 @@ Conditions and Asserts - Unit files may also include a number of Condition…= and - Assert…= settings. Before the unit is started, systemd will verify + Unit files may also include a number of Condition…= and + Assert…= settings. Before the unit is started, systemd will verify that the specified conditions are true. If not, the starting of the unit will be (mostly silently) skipped. Failing conditions will not result in the unit being moved into the failed state. The conditions are checked at the time the queued start job is to be executed. The ordering @@ -1731,7 +1731,7 @@ Note that this setting is not influenced by the Us %L Log directory root - This is either /var/log (for the system manager) or the path $XDG_CONFIG_HOME resolves to with /log appended (for user managers). + This is either /var/log (for the system manager) or the path $XDG_CONFIG_HOME resolves to with /log appended (for user managers). %m diff --git a/man/tmpfiles.d.xml b/man/tmpfiles.d.xml index aae63b7591..8a3dde3644 100644 --- a/man/tmpfiles.d.xml +++ b/man/tmpfiles.d.xml @@ -654,7 +654,7 @@ w- /proc/sys/vm/swappiness - - - - 10 %L System or user log directory - In mode, this is the same as $XDG_CONFIG_HOME with /log appended, and /var/log otherwise. + In mode, this is the same as $XDG_CONFIG_HOME with /log appended, and /var/log otherwise. %m diff --git a/man/user@.service.xml b/man/user@.service.xml index e748c03b88..81a6fef4ba 100644 --- a/man/user@.service.xml +++ b/man/user@.service.xml @@ -68,16 +68,16 @@ different levels. As described in the previous section, user.slice contains processes of all users, so any resource limits on that slice apply to all users together. The usual way to configure them would be through drop-ins, e.g. /etc/systemd/system/user.slice.d/resources.conf. + index="false">/etc/systemd/system/user.slice.d/resources.conf. The processes of a single user are collected under user-UID.slice. Resource limits for that user can be configured through drop-ins for that unit, e.g. /etc/systemd/system/user-1000.slice.d/resources.conf. If the limits + index="false">/etc/systemd/system/user-1000.slice.d/resources.conf. If the limits should apply to all users instead, they may be configured through drop-ins for the truncated unit name, user-.slice. For example, configuration in /etc/systemd/system/user-.slice.d/resources.conf is included in all + index="false">/etc/systemd/system/user-.slice.d/resources.conf is included in all user-UID.slice units, see systemd.unit5 for a discussion of the drop-in mechanism. @@ -141,20 +141,20 @@ Control group /: │ └─6706 /usr/bin/sleep 30 … User with UID 1000 is logged in using gdm (session-4.scope) and + index="false">session-4.scope) and ssh1 - (session-19.scope), and also has a user manager instance - running (user@1000.service). User with UID 1001 is logged - in using ssh (session-20.scope) and + (session-19.scope), and also has a user manager instance + running (user@1000.service). User with UID 1001 is logged + in using ssh (session-20.scope) and also has a user manager instance running (user@1001.service). Those are all (leaf) system units, and form - part of the slice hierarchy, with user-1000.slice and - user-1001.slice below user.slice. User units are visible below the + index="false">user@1001.service). Those are all (leaf) system units, and form + part of the slice hierarchy, with user-1000.slice and + user-1001.slice below user.slice. User units are visible below the user@.service instances (pulseaudio.service, gnome-terminal-server.service, init.scope, sleep.service). + index="false">pulseaudio.service, gnome-terminal-server.service, init.scope, sleep.service). diff --git a/tools/make-directive-index.py b/tools/make-directive-index.py index 9d9448703f..2bc178de50 100755 --- a/tools/make-directive-index.py +++ b/tools/make-directive-index.py @@ -204,7 +204,7 @@ def _extract_directives(directive_groups, formatting, page): for name in t.iterfind(xpath): if absolute_only and not (name.text and name.text.startswith('/')): continue - if name.attrib.get('noindex'): + if name.attrib.get('index') == 'false': continue name.tail = '' if name.text: @@ -228,7 +228,7 @@ def _extract_directives(directive_groups, formatting, page): storfile = directive_groups['constants'] for name in t.iterfind('.//constant'): - if name.attrib.get('noindex'): + if name.attrib.get('index') == 'false': continue name.tail = '' if name.text.startswith('('): # a cast, strip it