]> git.ipfire.org Git - thirdparty/systemd.git/commitdiff
tree-wide: use html links for kernel docs
authorZbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl>
Fri, 1 Jul 2022 16:03:09 +0000 (18:03 +0200)
committerZbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl>
Sat, 2 Jul 2022 10:13:00 +0000 (12:13 +0200)
Instead of using "*.txt" as reference name, use the actual destination title.

19 files changed:
NEWS
man/sd_bus_creds_get_pid.xml
man/systemd-getty-generator.xml
man/systemd-hibernate-resume@.service.xml
man/systemd-nspawn.xml
man/systemd.exec.xml
man/systemd.netdev.xml
man/systemd.network.xml
man/systemd.resource-control.xml
man/systemd.service.xml
man/systemd.socket.xml
man/systemd.xml
src/boot/efi/cpio.c
src/home/homework.c
units/dev-hugepages.mount
units/sys-fs-fuse-connections.mount
units/sys-kernel-config.mount
units/sys-kernel-debug.mount
units/sys-kernel-tracing.mount

diff --git a/NEWS b/NEWS
index 9ff9292311b37abf96e8465234698aafffe8448d..448260d07dec869bc52f9b5b2e62c28207c3699e 100644 (file)
--- 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.
index 9ceeb4d564bee6b2507b63f7a008ff1b72baaa45..c6468b71efc2ef748ed4f85d4ad09f5dc8c45b81 100644 (file)
 
     <para><function>sd_bus_creds_get_cgroup()</function> will retrieve
     the control group path. See <ulink
-    url="https://www.kernel.org/doc/Documentation/cgroup-v1/cgroups.txt">cgroups.txt</ulink>.
+    url="https://www.kernel.org/doc/html/latest/admin-guide/cgroup-v1/index.html">Control Groups version 1</ulink>.
     </para>
 
     <para><function>sd_bus_creds_get_unit()</function> will retrieve
index aac2e95f3a40d2ae422b4cb5a1166d8d45f5162b..a74d7075ef106a96560749dcff0787da9952d59f 100644 (file)
@@ -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 <varname>console=</varname> to
     get both kernel messages and a getty prompt on a serial TTY. See <ulink
-    url="https://www.kernel.org/doc/Documentation/admin-guide/kernel-parameters.txt"><filename>kernel-parameters.txt</filename></ulink>
-    for more information on the <varname>console=</varname> kernel parameter.</para>
+    url="https://www.kernel.org/doc/html/latest/admin-guide/kernel-parameters.html">The kernel's command-line
+    parameters</ulink> for more information on the <varname>console=</varname> kernel parameter.</para>
 
     <para><filename>systemd-getty-generator</filename> implements
     <citerefentry><refentrytitle>systemd.generator</refentrytitle><manvolnum>7</manvolnum></citerefentry>.</para>
index c460393d9eaf107db55bdc4158e897065b7d3a53..feba12e76d2035666d21d6d2d7a40a7b1b8f95a9 100644 (file)
@@ -34,8 +34,8 @@
     device to resume from as the template argument.</para>
 
     <para><filename>systemd-hibernate-resume</filename> only supports
-    the in-kernel hibernation implementation, known as
-    <ulink url="https://www.kernel.org/doc/Documentation/power/swsusp.txt">swsusp</ulink>.
+    the in-kernel hibernation implementation, see
+    <ulink url="https://www.kernel.org/doc/html/latest/power/swsusp.html">Swap suspend</ulink>.
     Internally, it works by writing the major:minor of specified
     device node to <filename>/sys/power/resume</filename>.</para>
 
index f52968a4f0cde0a1e98a90d264ba31c5d5db5d6c..3a390f2f2595e1b3e77636f382b6f8cc3dea23a9 100644 (file)
@@ -1492,21 +1492,16 @@ After=sys-subsystem-net-devices-ens1.device</programlisting>
         temporary directory on a read-only <filename>/var/</filename> directory.</para>
 
         <para>For details about overlay file systems, see <ulink
-        url="https://www.kernel.org/doc/Documentation/filesystems/overlayfs.txt">overlayfs.txt</ulink>. 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
-        <literal>workdir=</literal> 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 <literal>lowerdir=</literal> mount
-        option receives the paths to stack in the opposite order of
-        this switch.</para>
+        url="https://www.kernel.org/doc/html/latest/filesystems/overlayfs.html">Overlay Filesystem</ulink>.
+        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 <literal>workdir=</literal> 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
+        <literal>lowerdir=</literal> mount option receives the paths to stack in the opposite order of this
+        switch.</para>
 
         <para>Note that this option cannot be used to replace the root file system of the container with an overlay
         file system. However, the <option>--volatile=</option> option described above provides similar functionality,
index e92f615994f3b7a99859b227a9a899c0625d8fdc..557f881d9d2c6c54b4f17ad55caa45de2a66e85c 100644 (file)
@@ -1042,9 +1042,9 @@ CapabilityBoundingSet=~CAP_B CAP_C</programlisting>
         <listitem><para>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 <ulink
-        url="https://www.kernel.org/doc/Documentation/filesystems/proc.txt">proc.txt</ulink> for details. If
-        not specified defaults to the OOM score adjustment level of the service manager itself, which is
-        normally at 0.</para>
+        url="https://www.kernel.org/doc/html/latest/filesystems/proc.html">The /proc Filesystem</ulink> for
+        details. If not specified defaults to the OOM score adjustment level of the service manager itself,
+        which is normally at 0.</para>
 
         <para>Use the <varname>OOMPolicy=</varname> setting of service units to configure how the service
         manager shall react to the kernel OOM killer or <command>systemd-oomd</command> terminating a process of the service. See
index a6cffb023f244a946ab3febdc715265a30164c17..c6f73cfb595b19910adc3f94ce550d003b7382f7 100644 (file)
@@ -90,7 +90,7 @@
         </row></thead>
         <tbody>
           <row><entry><varname>bond</varname></entry>
-          <entry>A bond device is an aggregation of all its slave devices. See <ulink url="https://www.kernel.org/doc/Documentation/networking/bonding.txt">Linux Ethernet Bonding Driver HOWTO</ulink> for details.</entry></row>
+          <entry>A bond device is an aggregation of all its slave devices. See <ulink url="https://www.kernel.org/doc/html/latest/networking/bonding.html">Linux Ethernet Bonding Driver HOWTO</ulink> for details.</entry></row>
 
           <row><entry><varname>bridge</varname></entry>
           <entry>A bridge device is a software switch, and each of its slave devices and the bridge itself are ports of the switch.</entry></row>
           <entry>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.</entry></row>
 
           <row><entry><varname>vrf</varname></entry>
-          <entry>A Virtual Routing and Forwarding (<ulink url="https://www.kernel.org/doc/Documentation/networking/vrf.txt">VRF</ulink>) interface to create separate routing and forwarding domains.</entry></row>
+          <entry>A Virtual Routing and Forwarding (<ulink url="https://www.kernel.org/doc/html/latest/networking/vrf.html">VRF</ulink>) interface to create separate routing and forwarding domains.</entry></row>
 
           <row><entry><varname>vcan</varname></entry>
           <entry>The virtual CAN driver (vcan). Similar to the network loopback devices, vcan offers a virtual local CAN interface.</entry></row>
     </variablelist>
 
     <para>For more detail information see
-    <ulink url="https://www.kernel.org/doc/Documentation/networking/bonding.txt">
+    <ulink url="https://www.kernel.org/doc/html/latest/networking/bonding.html">
     Linux Ethernet Bonding Driver HOWTO</ulink></para>
   </refsect1>
 
index c2ce1b1d6949075ee16cde387aea5b96b5a7784d..9fb39b37e53727060015f501bb01c48adbfaf2be 100644 (file)
@@ -670,7 +670,7 @@ Table=1234</programlisting></para>
           enable IP packet forwarding for the specified address family. This controls the
           <filename>net.ipv4.ip_forward</filename> and <filename>net.ipv6.conf.all.forwarding</filename>
           sysctl options of the network interface (see
-          <ulink url="https://www.kernel.org/doc/Documentation/networking/ip-sysctl.txt">ip-sysctl.txt</ulink>
+          <ulink url="https://www.kernel.org/doc/html/latest/networking/ip-sysctl.html">IP Sysctl</ulink>
           for details about sysctl options). Defaults to <literal>no</literal>.</para>
 
           <para>Note: this setting controls a global kernel option, and does so one way only: if a
@@ -726,7 +726,7 @@ Table=1234</programlisting></para>
           section, see below.</para>
 
           <para>Also see
-          <ulink url="https://www.kernel.org/doc/Documentation/networking/ip-sysctl.txt">ip-sysctl.txt</ulink>
+          <ulink url="https://www.kernel.org/doc/html/latest/networking/ip-sysctl.html">IP Sysctl</ulink>
           in the kernel documentation regarding <literal>accept_ra</literal>, but note that systemd's
           setting of <constant>1</constant> (i.e. true) corresponds to kernel's setting of
           <constant>2</constant>.</para>
index 1397b886c5c20bc7126afc51515c2559f93a034c..0eab70b9cbe5130bf581bc7dd3c02a69c9affdd2 100644 (file)
           <literal>cpu.max</literal> attribute on the unified control group hierarchy and
           <literal>cpu.cfs_quota_us</literal> on legacy. For details about these control group attributes, see <ulink
           url="https://www.kernel.org/doc/html/latest/admin-guide/cgroup-v2.html">Control Groups v2</ulink> and <ulink
-          url="https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt">sched-bwc.txt</ulink>.
+          url="https://www.kernel.org/doc/html/latest/scheduler/sched-bwc.html">CFS Bandwidth Control</ulink>.
           Setting <varname>CPUQuota=</varname> to an empty value unsets the quota.</para>
 
           <para>Example: <varname>CPUQuota=20%</varname> ensures that the executed processes will never get more than
index fbb77d5e58373322b28c93037f8a2ce83acda13e..b1a05018276407ae04eb0f7e8af97d064c8c42f3 100644 (file)
         <term><varname>USBFunctionDescriptors=</varname></term>
         <listitem><para>Configure the location of a file containing
         <ulink
-        url="https://www.kernel.org/doc/Documentation/usb/functionfs.txt">USB
+        url="https://www.kernel.org/doc/html/latest/usb/functionfs.html">USB
         FunctionFS</ulink> descriptors, for implementation of USB
         gadget functions. This is used only in conjunction with a
         socket unit with <varname>ListenUSBFunction=</varname>
index 07bee46955e6de48d75d4a5b4cc17a335075f3c5..749ee4102d74e2dbc313fdc41833717e4c5ee6d8 100644 (file)
       <varlistentry>
         <term><varname>ListenUSBFunction=</varname></term>
         <listitem><para>Specifies a <ulink
-        url="https://www.kernel.org/doc/Documentation/usb/functionfs.txt">USB
+        url="https://www.kernel.org/doc/html/latest/usb/functionfs.html">USB
         FunctionFS</ulink> 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.
         the security label of the FIFO, or the security label for the
         incoming or outgoing connections of the socket, respectively.
         See <ulink
-        url="https://www.kernel.org/doc/Documentation/security/Smack.txt">Smack.txt</ulink>
+        url="https://www.kernel.org/doc/html/latest/admin-guide/LSM/Smack.html">Smack</ulink>
         for details.</para></listitem>
       </varlistentry>
 
index 64ba1654a075122e48ed31ad3f4522eca80126b2..f172dcabd1c6736d4e1e665f92b2f2daffa33c29 100644 (file)
     <para>Processes systemd spawns are placed in individual Linux
     control groups named after the unit which they belong to in the
     private systemd hierarchy. (see <ulink
-    url="https://www.kernel.org/doc/Documentation/cgroup-v1/cgroups.txt">cgroups.txt</ulink>
+    url="https://www.kernel.org/doc/html/latest/admin-guide/cgroup-v1/index.html">Control Groups version 1</ulink>
     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
index 3e522a56f3ae5ded5a4972e1eee0e06e336177bc..d680b7e151529583c301fa1058d992318d77782e 100644 (file)
@@ -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;
index 0014a7f5986333538509fea9152908a86074f559..5ba67033412ce4d740b348b166e502d602aa192f 100644 (file)
@@ -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)
index 517437784ceb80821c129fbc2eb24f4ddc2584ad..2cd4a43c4fba5e92663704e3090d6dcdcd311428 100644 (file)
@@ -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
index ca48fd5f4faac9001ce14ce302c46a36eed09099..056b0471941f4593043bbc0368757b66acc77b78 100644 (file)
@@ -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
index b99b4f4b7e5a624758726152ff9352ab99acb605..d7ce88a51eed99feaac8bf27e8c8d67f51b5f8fb 100644 (file)
@@ -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
index d03837bafbfbfda18006ced0b283acb2f024e80e..364ee8a30cd0f6ddfb5c83872f98613d33c0740c 100644 (file)
@@ -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
index 8800c96bcdbac6735fdfb98e7bac539c689dac1c..17ba8457f9e89bd6503386f35b2318ec07ade2cd 100644 (file)
@@ -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