From 2f8211c64aab075cb94c45596998e294c67f2ccc Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Zbigniew=20J=C4=99drzejewski-Szmek?= Date: Fri, 1 Jul 2022 18:03:09 +0200 Subject: [PATCH] tree-wide: use html links for kernel docs Instead of using "*.txt" as reference name, use the actual destination title. --- NEWS | 2 +- man/sd_bus_creds_get_pid.xml | 2 +- man/systemd-getty-generator.xml | 4 ++-- man/systemd-hibernate-resume@.service.xml | 4 ++-- man/systemd-nspawn.xml | 25 +++++++++-------------- man/systemd.exec.xml | 6 +++--- man/systemd.netdev.xml | 6 +++--- man/systemd.network.xml | 4 ++-- man/systemd.resource-control.xml | 2 +- man/systemd.service.xml | 2 +- man/systemd.socket.xml | 4 ++-- man/systemd.xml | 2 +- src/boot/efi/cpio.c | 2 +- src/home/homework.c | 6 +++--- units/dev-hugepages.mount | 2 +- units/sys-fs-fuse-connections.mount | 2 +- units/sys-kernel-config.mount | 2 +- units/sys-kernel-debug.mount | 2 +- units/sys-kernel-tracing.mount | 2 +- 19 files changed, 38 insertions(+), 43 deletions(-) diff --git a/NEWS b/NEWS index 9ff9292311..448260d07d 100644 --- a/NEWS +++ b/NEWS @@ -5332,7 +5332,7 @@ CHANGES WITH 240: a client with a Wi-Fi and Ethernet both connected to the internet). Consult the kernel documentation for details on this sysctl: - https://www.kernel.org/doc/Documentation/networking/ip-sysctl.txt + https://www.kernel.org/doc/html/latest/networking/ip-sysctl.html * The v239 change to turn on "net.ipv4.tcp_ecn" by default has been reverted. diff --git a/man/sd_bus_creds_get_pid.xml b/man/sd_bus_creds_get_pid.xml index 9ceeb4d564..c6468b71ef 100644 --- a/man/sd_bus_creds_get_pid.xml +++ b/man/sd_bus_creds_get_pid.xml @@ -342,7 +342,7 @@ sd_bus_creds_get_cgroup() will retrieve the control group path. See cgroups.txt. + url="https://www.kernel.org/doc/html/latest/admin-guide/cgroup-v1/index.html">Control Groups version 1. sd_bus_creds_get_unit() will retrieve diff --git a/man/systemd-getty-generator.xml b/man/systemd-getty-generator.xml index aac2e95f3a..a74d7075ef 100644 --- a/man/systemd-getty-generator.xml +++ b/man/systemd-getty-generator.xml @@ -40,8 +40,8 @@ place, regardless of which environment the system is started in. For example, it is sufficient to redirect the kernel console with a kernel command line argument such as console= to get both kernel messages and a getty prompt on a serial TTY. See kernel-parameters.txt - for more information on the console= kernel parameter. + url="https://www.kernel.org/doc/html/latest/admin-guide/kernel-parameters.html">The kernel's command-line + parameters for more information on the console= kernel parameter. systemd-getty-generator implements systemd.generator7. diff --git a/man/systemd-hibernate-resume@.service.xml b/man/systemd-hibernate-resume@.service.xml index c460393d9e..feba12e76d 100644 --- a/man/systemd-hibernate-resume@.service.xml +++ b/man/systemd-hibernate-resume@.service.xml @@ -34,8 +34,8 @@ device to resume from as the template argument. systemd-hibernate-resume only supports - the in-kernel hibernation implementation, known as - swsusp. + the in-kernel hibernation implementation, see + Swap suspend. Internally, it works by writing the major:minor of specified device node to /sys/power/resume. diff --git a/man/systemd-nspawn.xml b/man/systemd-nspawn.xml index f52968a4f0..3a390f2f25 100644 --- a/man/systemd-nspawn.xml +++ b/man/systemd-nspawn.xml @@ -1492,21 +1492,16 @@ After=sys-subsystem-net-devices-ens1.device temporary directory on a read-only /var/ directory. For details about overlay file systems, see overlayfs.txt. Note - that the semantics of overlay file systems are substantially - different from normal file systems, in particular regarding - reported device and inode information. Device and inode - information may change for a file while it is being written - to, and processes might see out-of-date versions of files at - times. Note that this switch automatically derives the - workdir= mount option for the overlay file - system from the top-level directory tree, making it a sibling - of it. It is hence essential that the top-level directory tree - is not a mount point itself (since the working directory must - be on the same file system as the top-most directory - tree). Also note that the lowerdir= mount - option receives the paths to stack in the opposite order of - this switch. + url="https://www.kernel.org/doc/html/latest/filesystems/overlayfs.html">Overlay Filesystem. + Note that the semantics of overlay file systems are substantially different from normal file systems, + in particular regarding reported device and inode information. Device and inode information may + change for a file while it is being written to, and processes might see out-of-date versions of files + at times. Note that this switch automatically derives the workdir= mount option + for the overlay file system from the top-level directory tree, making it a sibling of it. It is hence + essential that the top-level directory tree is not a mount point itself (since the working directory + must be on the same file system as the top-most directory tree). Also note that the + lowerdir= mount option receives the paths to stack in the opposite order of this + switch. Note that this option cannot be used to replace the root file system of the container with an overlay file system. However, the option described above provides similar functionality, diff --git a/man/systemd.exec.xml b/man/systemd.exec.xml index e92f615994..557f881d9d 100644 --- a/man/systemd.exec.xml +++ b/man/systemd.exec.xml @@ -1042,9 +1042,9 @@ CapabilityBoundingSet=~CAP_B CAP_C Sets the adjustment value for the Linux kernel's Out-Of-Memory (OOM) killer score for executed processes. Takes an integer between -1000 (to disable OOM killing of processes of this unit) and 1000 (to make killing of processes of this unit under memory pressure very likely). See proc.txt for details. If - not specified defaults to the OOM score adjustment level of the service manager itself, which is - normally at 0. + url="https://www.kernel.org/doc/html/latest/filesystems/proc.html">The /proc Filesystem for + details. If not specified defaults to the OOM score adjustment level of the service manager itself, + which is normally at 0. Use the OOMPolicy= setting of service units to configure how the service manager shall react to the kernel OOM killer or systemd-oomd terminating a process of the service. See diff --git a/man/systemd.netdev.xml b/man/systemd.netdev.xml index a6cffb023f..c6f73cfb59 100644 --- a/man/systemd.netdev.xml +++ b/man/systemd.netdev.xml @@ -90,7 +90,7 @@ bond - A bond device is an aggregation of all its slave devices. See Linux Ethernet Bonding Driver HOWTO for details. + A bond device is an aggregation of all its slave devices. See Linux Ethernet Bonding Driver HOWTO for details. bridge A bridge device is a software switch, and each of its slave devices and the bridge itself are ports of the switch. @@ -165,7 +165,7 @@ Media Access Control Security (MACsec) is an 802.1AE IEEE industry-standard security technology that provides secure communication for all traffic on Ethernet links. MACsec provides point-to-point security on Ethernet links between directly connected nodes and is capable of identifying and preventing most security threats. vrf - A Virtual Routing and Forwarding (VRF) interface to create separate routing and forwarding domains. + A Virtual Routing and Forwarding (VRF) interface to create separate routing and forwarding domains. vcan The virtual CAN driver (vcan). Similar to the network loopback devices, vcan offers a virtual local CAN interface. @@ -2021,7 +2021,7 @@ For more detail information see - + Linux Ethernet Bonding Driver HOWTO diff --git a/man/systemd.network.xml b/man/systemd.network.xml index c2ce1b1d69..9fb39b37e5 100644 --- a/man/systemd.network.xml +++ b/man/systemd.network.xml @@ -670,7 +670,7 @@ Table=1234 enable IP packet forwarding for the specified address family. This controls the net.ipv4.ip_forward and net.ipv6.conf.all.forwarding sysctl options of the network interface (see - ip-sysctl.txt + IP Sysctl for details about sysctl options). Defaults to no. Note: this setting controls a global kernel option, and does so one way only: if a @@ -726,7 +726,7 @@ Table=1234 section, see below. Also see - ip-sysctl.txt + IP Sysctl in the kernel documentation regarding accept_ra, but note that systemd's setting of 1 (i.e. true) corresponds to kernel's setting of 2. diff --git a/man/systemd.resource-control.xml b/man/systemd.resource-control.xml index 1397b886c5..0eab70b9cb 100644 --- a/man/systemd.resource-control.xml +++ b/man/systemd.resource-control.xml @@ -208,7 +208,7 @@ cpu.max attribute on the unified control group hierarchy and cpu.cfs_quota_us on legacy. For details about these control group attributes, see Control Groups v2 and sched-bwc.txt. + url="https://www.kernel.org/doc/html/latest/scheduler/sched-bwc.html">CFS Bandwidth Control. Setting CPUQuota= to an empty value unsets the quota. Example: CPUQuota=20% ensures that the executed processes will never get more than diff --git a/man/systemd.service.xml b/man/systemd.service.xml index fbb77d5e58..b1a0501827 100644 --- a/man/systemd.service.xml +++ b/man/systemd.service.xml @@ -1103,7 +1103,7 @@ USBFunctionDescriptors= Configure the location of a file containing USB + url="https://www.kernel.org/doc/html/latest/usb/functionfs.html">USB FunctionFS descriptors, for implementation of USB gadget functions. This is used only in conjunction with a socket unit with ListenUSBFunction= diff --git a/man/systemd.socket.xml b/man/systemd.socket.xml index 07bee46955..749ee4102d 100644 --- a/man/systemd.socket.xml +++ b/man/systemd.socket.xml @@ -299,7 +299,7 @@ ListenUSBFunction= Specifies a USB + url="https://www.kernel.org/doc/html/latest/usb/functionfs.html">USB FunctionFS endpoints location to listen on, for implementation of USB gadget functions. This expects an absolute file system path of a FunctionFS mount point as the argument. @@ -615,7 +615,7 @@ the security label of the FIFO, or the security label for the incoming or outgoing connections of the socket, respectively. See Smack.txt + url="https://www.kernel.org/doc/html/latest/admin-guide/LSM/Smack.html">Smack for details. diff --git a/man/systemd.xml b/man/systemd.xml index 64ba1654a0..f172dcabd1 100644 --- a/man/systemd.xml +++ b/man/systemd.xml @@ -210,7 +210,7 @@ Processes systemd spawns are placed in individual Linux control groups named after the unit which they belong to in the private systemd hierarchy. (see cgroups.txt + url="https://www.kernel.org/doc/html/latest/admin-guide/cgroup-v1/index.html">Control Groups version 1 for more information about control groups, or short "cgroups"). systemd uses this to effectively keep track of processes. Control group information is maintained in the kernel, and is accessible diff --git a/src/boot/efi/cpio.c b/src/boot/efi/cpio.c index 3e522a56f3..d680b7e151 100644 --- a/src/boot/efi/cpio.c +++ b/src/boot/efi/cpio.c @@ -71,7 +71,7 @@ static EFI_STATUS pack_cpio_one( /* Serializes one file in the cpio format understood by the kernel initrd logic. * - * See: https://www.kernel.org/doc/Documentation/early-userspace/buffer-format.txt */ + * See: https://www.kernel.org/doc/html/latest/driver-api/early-userspace/buffer-format.html */ if (contents_size > UINT32_MAX) /* cpio cannot deal with > 32bit file sizes */ return EFI_LOAD_ERROR; diff --git a/src/home/homework.c b/src/home/homework.c index 0014a7f598..5ba6703341 100644 --- a/src/home/homework.c +++ b/src/home/homework.c @@ -274,9 +274,9 @@ int user_record_authenticate( static void drop_caches_now(void) { int r; - /* Drop file system caches now. See https://www.kernel.org/doc/Documentation/sysctl/vm.txt for - * details. We write "2" into /proc/sys/vm/drop_caches to ensure dentries/inodes are flushed, but not - * more. */ + /* Drop file system caches now. See https://www.kernel.org/doc/html/latest/admin-guide/sysctl/vm.html + * for details. We write "2" into /proc/sys/vm/drop_caches to ensure dentries/inodes are flushed, but + * not more. */ r = write_string_file("/proc/sys/vm/drop_caches", "2\n", WRITE_STRING_FILE_DISABLE_BUFFER); if (r < 0) diff --git a/units/dev-hugepages.mount b/units/dev-hugepages.mount index 517437784c..2cd4a43c4f 100644 --- a/units/dev-hugepages.mount +++ b/units/dev-hugepages.mount @@ -9,7 +9,7 @@ [Unit] Description=Huge Pages File System -Documentation=https://www.kernel.org/doc/Documentation/vm/hugetlbpage.txt +Documentation=https://www.kernel.org/doc/html/latest/admin-guide/mm/hugetlbpage.html Documentation=https://www.freedesktop.org/wiki/Software/systemd/APIFileSystems DefaultDependencies=no Before=sysinit.target diff --git a/units/sys-fs-fuse-connections.mount b/units/sys-fs-fuse-connections.mount index ca48fd5f4f..056b047194 100644 --- a/units/sys-fs-fuse-connections.mount +++ b/units/sys-fs-fuse-connections.mount @@ -9,7 +9,7 @@ [Unit] Description=FUSE Control File System -Documentation=https://www.kernel.org/doc/Documentation/filesystems/fuse.txt +Documentation=https://www.kernel.org/doc/html/latest/filesystems/fuse.html Documentation=https://www.freedesktop.org/wiki/Software/systemd/APIFileSystems DefaultDependencies=no ConditionPathExists=/sys/fs/fuse/connections diff --git a/units/sys-kernel-config.mount b/units/sys-kernel-config.mount index b99b4f4b7e..d7ce88a51e 100644 --- a/units/sys-kernel-config.mount +++ b/units/sys-kernel-config.mount @@ -9,7 +9,7 @@ [Unit] Description=Kernel Configuration File System -Documentation=https://www.kernel.org/doc/Documentation/filesystems/configfs/configfs.txt +Documentation=https://www.kernel.org/doc/html/latest/filesystems/configfs.html Documentation=https://www.freedesktop.org/wiki/Software/systemd/APIFileSystems DefaultDependencies=no ConditionPathExists=/sys/kernel/config diff --git a/units/sys-kernel-debug.mount b/units/sys-kernel-debug.mount index d03837bafb..364ee8a30c 100644 --- a/units/sys-kernel-debug.mount +++ b/units/sys-kernel-debug.mount @@ -9,7 +9,7 @@ [Unit] Description=Kernel Debug File System -Documentation=https://www.kernel.org/doc/Documentation/filesystems/debugfs.txt +Documentation=https://www.kernel.org/doc/html/latest/filesystems/debugfs.html Documentation=https://www.freedesktop.org/wiki/Software/systemd/APIFileSystems DefaultDependencies=no ConditionPathExists=/sys/kernel/debug diff --git a/units/sys-kernel-tracing.mount b/units/sys-kernel-tracing.mount index 8800c96bcd..17ba8457f9 100644 --- a/units/sys-kernel-tracing.mount +++ b/units/sys-kernel-tracing.mount @@ -9,7 +9,7 @@ [Unit] Description=Kernel Trace File System -Documentation=https://www.kernel.org/doc/Documentation/trace/ftrace.txt +Documentation=https://www.kernel.org/doc/html/latest/trace/ftrace.html Documentation=https://www.freedesktop.org/wiki/Software/systemd/APIFileSystems DefaultDependencies=no ConditionVirtualization=!lxc