From: Zbigniew Jędrzejewski-Szmek Date: Fri, 3 May 2013 04:55:20 +0000 (-0400) Subject: man: add various filenames to the index X-Git-Tag: v203~30 X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=elogind.git;a=commitdiff_plain;h=845c53246f73a505f12bb7f685a530045fa60a40 man: add various filenames to the index Everything which is an absolute filename marked with lands in the index, unless noindex= attribute is present. Should make it easier for people to find stuff when they are looking at a file on disk. Various formatting errors in manpages are fixed, kernel-install(1) is restored to formatting sanity. --- diff --git a/make-directive-index.py b/make-directive-index.py index 99e7bfaf2..396947b30 100755 --- a/make-directive-index.py +++ b/make-directive-index.py @@ -193,16 +193,25 @@ def _extract_directives(directive_groups, formatting, page): formatting[text] = name storfile = directive_groups['filenames'] - for xpath in ('.//refsynopsisdiv//filename', - './/refsynopsisdiv//command'): + for xpath, absolute_only in (('.//refsynopsisdiv//filename', False), + ('.//refsynopsisdiv//command', False), + ('.//filename', True)): for name in t.iterfind(xpath): + if absolute_only and not (name.text and name.text.startswith('/')): + continue + if name.attrib.get('noindex'): + continue name.tail = '' if name.text: + if name.text.endswith('*'): + name.text = name.text[:-1] if not name.text.startswith('.'): text = name.text.partition(' ')[0] if text != name.text: name.clear() name.text = text + if text.endswith('/'): + text = text[:-1] storfile[text].append((pagename, section)) if text not in formatting: # use element as formatted display diff --git a/man/journalctl.xml b/man/journalctl.xml index 91cc32260..cc7d1a053 100644 --- a/man/journalctl.xml +++ b/man/journalctl.xml @@ -652,7 +652,7 @@ journalctl /usr/bin/dbus-daemon - Show all logs of the kernel device node /dev/sda: + Show all logs of the kernel device node /dev/sda: journalctl /dev/sda diff --git a/man/kernel-install.xml b/man/kernel-install.xml index df3549dcb..9c2ecc48b 100644 --- a/man/kernel-install.xml +++ b/man/kernel-install.xml @@ -49,7 +49,10 @@ along with systemd; If not, see . - kernel-install COMMAND KERNEL VERSION KERNEL IMAGE + kernel-install + COMMAND + KERNEL-VERSION + KERNEL-IMAGE @@ -60,9 +63,10 @@ along with systemd; If not, see . initramfs images to and from /boot. - kernel-install will execute the files located in the directory /usr/lib/kernel/install.d/ + kernel-install will execute the files + located in the directory /usr/lib/kernel/install.d/ and the local administration directory /etc/kernel/install.d/. - All files are collectively sorted and executed in lexical order, regardless of the directories in + All files are collectively sorted and executed in lexical order, regardless of the directory in which they live. However, files with identical file names replace each other. Files in /etc/kernel/install.d/ take precedence over files with the same name in /usr/lib/kernel/install.d/. This can be used to override a system-supplied @@ -78,29 +82,44 @@ along with systemd; If not, see . The following commands are understood: - add <KERNEL VERSION> <KERNEL IMAGE> + add KERNEL-VERSION KERNEL-IMAGE - calls every executable /usr/lib/kernel/install.d/*.install - and /etc/kernel/install.d/*.install with the arguments - "add <KERNEL VERSION> /boot/<MACHINE-ID>/<KERNEL VERSION>/" - - kernel-install copies <KERNEL IMAGE> to - /boot/<MACHINE-ID>/<KERNEL VERSION>/linux. - - kernel-install also creates a boot loader entry according to the boot loader specification - in /boot/loader/entries/<MACHINE-ID>-<KERNEL VERSION>.conf. - If the file initrd is found next to the linux file, - the initrd will be added to the configuration. + calls every executable + /usr/lib/kernel/install.d/*.install and + /etc/kernel/install.d/*.install with + the arguments + +add KERNEL-VERSION /boot/MACHINE-ID/KERNEL-VERSION/ + + + + kernel-install copies + KERNEL-IMAGE to + /boot/MACHINE-ID/KERNEL-VERSION/linux. + + + kernel-install also creates a boot + loader entry according to the boot loader specification in + /boot/loader/entries/MACHINE-ID-KERNEL-VERSION.conf. + If the file initrd is found next to the + linux file, the initrd will be added to + the configuration. - remove <KERNEL VERSION> <KERNEL IMAGE> - calls every executable /usr/lib/kernel/install.d/*.install - and /etc/kernel/install.d/*.install with the arguments: - "remove <KERNEL VERSION> /boot/<MACHINE-ID>/<KERNEL VERSION>/" - - kernel-install removes the entire directory /boot/<MACHINE-ID>/<KERNEL VERSION>/ - and the file /boot/loader/entries/<MACHINE-ID>-<KERNEL VERSION>.conf + remove KERNEL-VERSION KERNEL-IMAGE + + calls every executable /usr/lib/kernel/install.d/*.install + and /etc/kernel/install.d/*.install with the arguments + +remove KERNEL-VERSION /boot/MACHINE-ID/KERNEL-VERSION/ + + + + kernel-install removes the entire directory + /boot/MACHINE-ID/KERNEL-VERSION/ + and the file + /boot/loader/entries/MACHINE-ID-KERNEL-VERSION.conf @@ -140,7 +159,7 @@ along with systemd; If not, see . /etc/machine-id - The content of the file specifies the machine identification <MACHINE-ID>. + The content of the file specifies the machine identification MACHINE-ID. @@ -148,7 +167,7 @@ along with systemd; If not, see . /etc/os-release - The content of the file specifies the operating system id <OS-ID>. + The content of the file specifies the operating system id OS-ID. diff --git a/man/locale.conf.xml b/man/locale.conf.xml index 06c0af0bf..42634feba 100644 --- a/man/locale.conf.xml +++ b/man/locale.conf.xml @@ -129,7 +129,7 @@ German locale with English messages - /etc/locale.conf: + /etc/locale.conf: LANG=de_DE.UTF-8 LC_MESSAGES=C diff --git a/man/systemd-cat.xml b/man/systemd-cat.xml index cac275b45..876ebfa3c 100644 --- a/man/systemd-cat.xml +++ b/man/systemd-cat.xml @@ -168,7 +168,7 @@ Invoke a program - This calls /bin/ls + This calls /bin/ls with STDOUT/STDERR connected to the journal: diff --git a/man/systemd-nspawn.xml b/man/systemd-nspawn.xml index a80cec4e6..e7c859d11 100644 --- a/man/systemd-nspawn.xml +++ b/man/systemd-nspawn.xml @@ -360,7 +360,7 @@ # systemd-nspawn -bD /srv/mycontainer This installs a minimal Fedora distribution into - the directory /srv/mycontainer/ and + the directory /srv/mycontainer/ and then boots an OS in a namespace container in it. diff --git a/man/systemd-remount-fs.service.xml b/man/systemd-remount-fs.service.xml index 9fe953e8c..cf04713a0 100644 --- a/man/systemd-remount-fs.service.xml +++ b/man/systemd-remount-fs.service.xml @@ -70,7 +70,7 @@ /usr and the virtual kernel API file systems such as /proc, /sys or - /dev/. This service executes no + /dev. This service executes no operation if /etc/fstab does not exist or lists no entries for the mentioned file systems. diff --git a/man/systemd.automount.xml b/man/systemd.automount.xml index f0a4293de..e01cac7bc 100644 --- a/man/systemd.automount.xml +++ b/man/systemd.automount.xml @@ -70,7 +70,7 @@ Automount units must be named after the automount directories they control. Example: the - automount point /home/lennart + automount point /home/lennart must be configured in a unit file home-lennart.automount. For details about the escaping logic used to convert a diff --git a/man/systemd.device.xml b/man/systemd.device.xml index 3f6d012c1..7dffa236c 100644 --- a/man/systemd.device.xml +++ b/man/systemd.device.xml @@ -80,7 +80,7 @@ Device units are named after the /sys and /dev paths they control. Example: - the device /dev/sda5 is exposed + the 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.exec.xml b/man/systemd.exec.xml index c25d96e9f..b3e0287d7 100644 --- a/man/systemd.exec.xml +++ b/man/systemd.exec.xml @@ -799,10 +799,10 @@ space-separated list of cgroup identifiers. A cgroup identifier is formatted like - cpu:/foo/bar, + cpu:/foo/bar, where "cpu" indicates the kernel control group controller used, and - /foo/bar is the + /foo/bar is the control group path. The controller name and ":" may be omitted in which case the named systemd control group diff --git a/man/systemd.mount.xml b/man/systemd.mount.xml index 23e1e6c28..21177a262 100644 --- a/man/systemd.mount.xml +++ b/man/systemd.mount.xml @@ -86,7 +86,7 @@ Mount units must be named after the mount point directories they control. Example: the mount point - /home/lennart must be configured + /home/lennart must be configured in a unit file home-lennart.mount. For details about the escaping logic used to convert a file system diff --git a/man/systemd.swap.xml b/man/systemd.swap.xml index 78b04f58d..8268e6164 100644 --- a/man/systemd.swap.xml +++ b/man/systemd.swap.xml @@ -79,7 +79,7 @@ Swap units must be named after the devices or files they control. Example: the swap device - /dev/sda5 must be configured in a + /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 diff --git a/man/systemd.unit.xml b/man/systemd.unit.xml index f924ef69d..2f2d1a1d4 100644 --- a/man/systemd.unit.xml +++ b/man/systemd.unit.xml @@ -197,7 +197,7 @@ Some unit names reflect paths existing in the file system name space. Example: a device unit dev-sda.device refers to a device - with the device node /dev/sda in + with the device node /dev/sda in the file system namespace. If this applies a special way to escape the path name is used, so that the result is usable as part of a file name. Basically, diff --git a/man/vconsole.conf.xml b/man/vconsole.conf.xml index f60b571b7..09a477670 100644 --- a/man/vconsole.conf.xml +++ b/man/vconsole.conf.xml @@ -124,7 +124,7 @@ German keyboard and console - /etc/vconsole.conf: + /etc/vconsole.conf: KEYMAP=de-latin1 FONT=latarcyrheb-sun16