And remove some outdated ones.
Reported-by: Helge Kreutzmann <debian@helgefjell.de>
Signed-off-by: Alejandro Colomar <alx@kernel.org>
The kernel source files
.I Documentation/security/keys/core.rst
and
-.I Documentation/keys/request\-key.rst
-(or, before Linux 4.13, in the files
-.\" commit b68101a1e8f0263dbc7b8375d2a7c57c6216fb76
-.I Documentation/security/keys.txt
-and
-.\" commit 3db38ed76890565772fcca3279cc8d454ea6176b
-.IR Documentation/security/keys\-request\-key.txt ).
+.IR Documentation/keys/request\-key.rst .
one of the Spectre attacks against the BPF interpreter.)
.P
The JIT compiler for eBPF is currently
-.\" Last reviewed in Linux 4.18-rc by grepping for BPF_ALU64 in arch/
-.\" and by checking the documentation for bpf_jit_enable in
-.\" Documentation/sysctl/net.txt
available for the following architectures:
.IP \[bu] 3
x86-64
.BR tc\-bpf (8)
.P
Both classic and extended BPF are explained in the kernel source file
-.IR Documentation/networking/filter.txt .
+.IR Documentation/networking/filter.rst .
.BR lockf (3),
.BR lslocks (8)
.P
-.I Documentation/filesystems/locks.txt
+.I Documentation/filesystems/locks.rst
in the Linux kernel source tree
-.RI ( Documentation/locks.txt
-in older kernels)
.P
The following kernel source files:
.IP \[bu] 3
-.I Documentation/pi\-futex.txt
+.I Documentation/locking/pi\-futex.rst
.IP \[bu]
-.I Documentation/futex\-requeue\-pi.txt
+.I Documentation/locking/futex\-requeue\-pi.rst
.IP \[bu]
-.I Documentation/locking/rt\-mutex.txt
+.I Documentation/locking/rt\-mutex.rst
.IP \[bu]
-.I Documentation/locking/rt\-mutex\-design.txt
+.I Documentation/locking/rt\-mutex\-design.rst
.IP \[bu]
-.I Documentation/robust\-futex\-ABI.txt
+.I Documentation/robust\-futex\-ABI.rst
.P
Franke, H., Russell, R., and Kirwood, M., 2002.
.br
.BR futex (2),
.BR pthread_mutexattr_setrobust (3)
.P
-.I Documentation/robust\-futexes.txt
+.I Documentation/robust\-futexes.rst
and
-.I Documentation/robust\-futex\-ABI.txt
+.I Documentation/robust\-futex\-ABI.rst
in the Linux kernel source tree
.\" http://lwn.net/Articles/172149/
.BR capabilities (7),
.BR sched (7)
.P
-.I Documentation/scheduler/sched\-nice\-design.txt
+.I Documentation/scheduler/sched\-nice\-design.rst
in the Linux kernel source tree (since Linux 2.6.23)
constantly accessing the disk.
.P
Refer to the kernel source file
-.I Documentation/block/ioprio.txt
+.I Documentation/block/ioprio.rst
for more information on the CFQ I/O Scheduler and an example program.
.SS Required permissions to set I/O priorities
Permission to change a process's priority is granted or denied based
.BR capabilities (7),
.BR cgroups (7)
.P
-.I Documentation/block/ioprio.txt
+.I Documentation/block/ioprio.rst
in the Linux kernel source tree
does not refer to an open file, or the kernel can't load this file.
Currently, the file must be a bzImage and contain an x86 kernel that
is loadable above 4\ GiB in memory (see the kernel source file
-.IR Documentation/x86/boot.txt ).
+.IR Documentation/arch/x86/boot.rst ).
.TP
.B ENOMEM
Could not allocate memory.
.BR kexec (8)
.P
The kernel source files
-.I Documentation/kdump/kdump.txt
+.I Documentation/kdump/kdump.rst
and
.I Documentation/admin\-guide/kernel\-parameters.txt
.BR request\-key (8)
.P
The kernel source files under
-.I Documentation/security/keys/
-(or, before Linux 4.13, in the file
-.IR Documentation/security/keys.txt ).
+.IR Documentation/security/keys/ .
operations on the target.
See the kernel source file
.I Documentation/admin\-guide/LSM/Yama.rst
-.\" commit 90bb766440f2147486a2acc3e793d7b8348b0c22
-(or
-.I Documentation/security/Yama.txt
-before Linux 4.13)
for further details.
.IP
The use of
The kernel source files
.I Documentation/security/keys/core.rst
and
-.I Documentation/keys/request\-key.rst
-(or, before Linux 4.13, in the files
-.\" commit b68101a1e8f0263dbc7b8375d2a7c57c6216fb76
-.I Documentation/security/keys.txt
-and
-.\" commit 3db38ed76890565772fcca3279cc8d454ea6176b
-.IR Documentation/security/keys\-request\-key.txt ).
+.IR Documentation/keys/request\-key.rst .
.B SCHED_DEADLINE
thread to reclaim bandwidth unused by other real-time threads.
.\" Bandwidth reclaim is done via the GRUB algorithm; see
-.\" Documentation/scheduler/sched-deadline.txt
+.\" Documentation/scheduler/sched-deadline.rst
.TP
.BR SCHED_FLAG_DL_OVERRUN " (since Linux 4.16)"
.\" commit 34be39305a77b8b1ec9f279163c7cdb6cc719b91
.BR seccomp_rule_add (3).
.P
The kernel source files
-.I Documentation/networking/filter.txt
+.I Documentation/networking/filter.rst
and
-.I Documentation/userspace\-api/seccomp_filter.rst
-.\" commit c061f33f35be0ccc80f4b8e0aea5dfd2ed7e01a3
-(or
-.I Documentation/prctl/seccomp_filter.txt
-before Linux 4.13).
+.IR Documentation/userspace\-api/seccomp_filter.rst .
.P
McCanne, S.\& and Jacobson, V.\& (1992)
.IR "The BSD Packet Filter: A New Architecture for User-level Packet Capture" ,
.P
.I Documentation/userspace\-api/unshare.rst
in the Linux kernel source tree
-.\" commit f504d47be5e8fa7ecf2bf660b18b42e6960c0eb2
-(or
-.I Documentation/unshare.txt
-before Linux 4.12)
For further information, see
.BR request_key (2)
and the kernel source file
-.IR Documentation/security/keys\-request\-key.txt .
+.IR Documentation/security/keys/request\-key.rst .
.SH RETURN VALUE
On success,
either 0, if the ID given was 0,
.\" or the error ENOTDIR results
is provided in
.IR key .
-.\" According to Documentation/security/keys.txt:
+.\" According to Documentation/security/keys/core.rst:
.\" This function can also be used to clear special kernel keyrings if they
.\" are appropriately marked if the user has CAP_SYS_ADMIN capability. The
.\" DNS resolver cache keyring is an example of this.
.BR prctl (2)
.P
For further information on Intel MPX, see the kernel source file
-.IR Documentation/\:x86/\:intel_mpx.txt .
+.IR Documentation/\:x86/\:intel_mpx.rst .
.BR prctl (2)
.P
For more information, see the kernel source file
-.I Documentation/arm64/pointer\-authentication.rst
-.\"commit b693d0b372afb39432e1c49ad7b3454855bc6bed
-(or
-.I Documentation/arm64/pointer\-authentication.txt
-before Linux 5.3).
+.IR Documentation/arch/arm64/pointer\-authentication.rst .
.BR seccomp (2)
.P
For more information, see the kernel source file
-.I Documentation/\:userspace\-api/\:no_new_privs.rst
-.\" commit 40fde647ccb0ae8c11d256d271e24d385eed595b
-(or
-.I Documentation/\:prctl/\:no_new_privs.txt
-before Linux 4.13).
+.IR Documentation/\:userspace\-api/\:no_new_privs.rst .
.BR prctl (2),
.P
For further information, see the kernel source file
-.I Documentation/\:admin\-guide/\:LSM/\:Yama.rst
-.\" commit 90bb766440f2147486a2acc3e793d7b8348b0c22
-(or
-.I Documentation/\:security/\:Yama.txt
-before Linux 4.13).
+.IR Documentation/\:admin\-guide/\:LSM/\:Yama.rst .
call failing with the error
.BR ENXIO .
For further details, see the kernel source file
-.IR Documentation/\:admin\-guide/\:kernel\-parameters.txt .
+.IR Documentation/\:admin\-guide/\:kernel\-parameters.rst .
.SH RETURN VALUE
On success,
0 is returned.
.BR PR_SVE_SET_VL (2const)
.P
For more information, see the kernel source file
-.I Documentation/arm64/sve.rst
-.\"commit b693d0b372afb39432e1c49ad7b3454855bc6bed
-(or
-.I Documentation/arm64/sve.txt
-before Linux 5.3).
+.IR Documentation/arch/arm64/sve.rst .
.BR PR_SVE_GET_VL (2const)
.P
For more information, see the kernel source file
-.I Documentation/arm64/sve.rst
-.\"commit b693d0b372afb39432e1c49ad7b3454855bc6bed
-(or
-.I Documentation/arm64/sve.txt
-before Linux 5.3).
+.IR Documentation/arch/arm64/sve.rst .
.UR http:\://cciss.sf.net
.UE ,
and
-.I Documentation/scsi/hpsa.txt
+.I Documentation/scsi/hpsa.rst
and
.I Documentation/ABI/testing/sysfs\-bus\-pci\-devices\-cciss
in the Linux kernel source tree
.B nfs_root_addrs
boot options to give the NFS settings.
For more information on NFS-mounted root see the kernel documentation file
-.I Documentation/filesystems/nfs/nfsroot.txt
-.\" commit dc7a08166f3a5f23e79e839a8a88849bd3397c32
-(or
-.I Documentation/filesystems/nfsroot.txt
-before Linux 2.6.33).
+.IR Documentation/filesystems/nfs/nfsroot.rst .
For more information on setting the root filesystem see also the
.B LILO
and
to change the root filesystem is obsolete.
See the Linux kernel source file
.I Documentation/admin\-guide/initrd.rst
-.\" commit 9d85025b0418163fae079c9ba8f8445212de8568
-(or
-.I Documentation/initrd.txt
-before Linux 4.10)
as well as
.BR pivot_root (2)
and
.BR rdev (8)
.P
.I Documentation/admin\-guide/initrd.rst
-.\" commit 9d85025b0418163fae079c9ba8f8445212de8568
-(or
-.I Documentation/initrd.txt
-before Linux 4.10)
in the Linux kernel source tree, the LILO documentation,
the LOADLIN documentation, the SYSLINUX documentation
.BR time (7),
.BR hwclock (8)
.P
-.I Documentation/rtc.txt
+.I Documentation/rtc.rst
in the Linux kernel source tree
The file
.I drivers/scsi/README.st
or
-.I Documentation/scsi/st.txt
+.I Documentation/scsi/st.rst
(kernel >= 2.6) in the Linux kernel source tree contains
the most recent information about the driver and its configuration
possibilities
.BR fsck.erofs (1),
.BR dump.erofs (1)
.P
-.I Documentation/filesystems/erofs.txt
+.I Documentation/filesystems/erofs.rst
in the Linux source.
.\" FIXME Document /proc/sched_debug (since Linux 2.6.23)
.\" See also /proc/[pid]/sched
.\" FIXME 2.6.13 seems to have /proc/vmcore implemented; document this
-.\" See Documentation/kdump/kdump.txt
+.\" See Documentation/kdump/kdump.rst
.\" commit 666bfddbe8b8fd4fd44617d6c55193d5ac7edb29
.\" Needs CONFIG_VMCORE
.\"
This file contains disk I/O statistics for each disk device.
See the Linux kernel source file
.I Documentation/admin\-guide/iostats.rst
-(or
-.I Documentation/iostats.txt
-before Linux 5.3)
for further information.
.SH SEE ALSO
.BR proc (5)
.\"
.\" SPDX-License-Identifier: GPL-3.0-or-later
.\"
-.\" FIXME cross check against Documentation/filesystems/proc.txt
+.\" FIXME cross check against Documentation/filesystems/proc.rst
.\" to see what information could be imported from that file
.\" into this file.
.\"
.I /proc/mtrr
Memory Type Range Registers.
See the Linux kernel source file
-.I Documentation/x86/mtrr.rst
-(or
-.I Documentation/x86/mtrr.txt
-.\" commit 7225e75144b9718cbbe1820d9c011c809d5773fd
-before Linux 5.2, or
-.I Documentation/mtrr.txt
-before Linux 2.6.28)
+.I Documentation/arch/x86/mtrr.rst
for details.
.SH SEE ALSO
.BR proc (5)
.RB ( add_key (2))
will be labeled with this context.
For further information, see the kernel source file
-.I Documentation/security/keys/core.rst
-(or file
-.\" commit b68101a1e8f0263dbc7b8375d2a7c57c6216fb76
-.I Documentation/security/keys.txt
-between Linux 3.0 and Linux 4.13, or
-.\" commit d410fa4ef99112386de5f218dd7df7b4fca910b4
-.I Documentation/keys.txt
-before Linux 3.0).
+.IR Documentation/security/keys/core.rst .
.TP
.IR /proc/ pid /attr/prev " (since Linux 2.6.0)"
This file contains the security context of the process before the last
.SH DESCRIPTION
.TP
.IR /proc/ pid /mountinfo " (since Linux 2.6.26)"
-.\" This info adapted from Documentation/filesystems/proc.txt
.\" commit 2d4d4864ac08caff5c204a752bd004eed4f08760
This file contains information about mounts
in the process's mount namespace (see
.IP
For more information on mount propagation see
.I Documentation/filesystems/sharedsubtree.rst
-(or
-.I Documentation/filesystems/sharedsubtree.txt
-before Linux 5.8)
in the Linux kernel source tree.
.SH SEE ALSO
.BR proc (5)
.SH DESCRIPTION
.TP
.IR /proc/ pid /oom_score_adj " (since Linux 2.6.36)"
-.\" Text taken from Linux 3.7 Documentation/filesystems/proc.txt
This file can be used to adjust the badness heuristic used to select which
process gets killed in out-of-memory conditions.
.IP
.TP
.IR /proc/sys/kernel/modules_disabled " (since Linux 2.6.31)"
.\" 3d43321b7015387cfebbe26436d0e9d299162ea1
-.\" From Documentation/sysctl/kernel.txt
A toggle value indicating if modules are allowed to be loaded
in an otherwise modular kernel.
This toggle defaults to off (0), but can be set true (1).
as a string in the standard UUID format.
.TP
.IR /proc/sys/kernel/randomize_va_space " (since Linux 2.6.12)"
-.\" Some further details can be found in Documentation/sysctl/kernel.txt
+.\" Some further details can be found in Documentation/sysctl/kernel.rst
Select the address space layout randomization (ASLR) policy for the system
(on architectures that support ASLR).
Three values are supported for this file:
.TP
.I /proc/sys/kernel/real\-root\-dev
This file is documented in the Linux kernel source file
-.I Documentation/admin\-guide/initrd.rst
-.\" commit 9d85025b0418163fae079c9ba8f8445212de8568
-(or
-.I Documentation/initrd.txt
-before Linux 4.10).
+.IR Documentation/admin\-guide/initrd.rst .
.TP
.IR /proc/sys/kernel/reboot\-cmd " (Sparc only)"
This file seems to be a way to give an argument to the SPARC
.TP
.IR /proc/sys/kernel/shm_rmid_forced " (since Linux 3.1)"
.\" commit b34a6b1da371ed8af1221459a18c67970f7e3d53
-.\" See also Documentation/sysctl/kernel.txt
+.\" See also Documentation/sysctl/kernel.rst
If this file is set to 1, all System V shared memory segments will
be marked for destruction as soon as the number of attached processes
falls to zero;
.B CONFIG_MAGIC_SYSRQ
kernel configuration option is enabled.
For further details see the Linux kernel source file
-.I Documentation/admin\-guide/sysrq.rst
-.\" commit 9d85025b0418163fae079c9ba8f8445212de8568
-(or
-.I Documentation/sysrq.txt
-before Linux 4.10).
+.IR Documentation/admin\-guide/sysrq.rst .
.TP
.I /proc/sys/kernel/version
This file contains a string such as:
date following it indicates the time the kernel was built.
.TP
.IR /proc/sys/kernel/threads\-max " (since Linux 2.3.11)"
-.\" The following is based on Documentation/sysctl/kernel.txt
This file specifies the system-wide limit on the number of
threads (tasks) that can be created on the system.
.IP
Path MTU Discovery globally, because not doing it incurs a high cost
to the network.
.\"
-.\" The following is from Linux 2.6.12: Documentation/networking/ip-sysctl.txt
.TP
.IR /proc/sys/net/ipv4/ip_nonlocal_bind " (Boolean; default: disabled; since Linux 2.4)"
.\" Precisely: patch-2.4.0-test10
to nonlocal IP addresses,
which can be quite useful, but may break some applications.
.\"
-.\" The following is from Linux 2.6.12: Documentation/networking/ip-sysctl.txt
.TP
.IR /proc/sys/net/ipv4/ip6frag_time " (integer; default: 30)"
Time in seconds to keep an IPv6 fragment in memory.
.\"
-.\" The following is from Linux 2.6.12: Documentation/networking/ip-sysctl.txt
.TP
.IR /proc/sys/net/ipv4/ip6frag_secret_interval " (integer; default: 600)"
Regeneration interval (in seconds) of the hash secret (or lifetime
.BR shmget (2).
.TP
.IR /proc/sys/vm/legacy_va_layout " (since Linux 2.6.9)"
-.\" The following is from Documentation/filesystems/proc.txt
If nonzero, this disables the new 32-bit memory-mapping layout;
the kernel will use the legacy (2.4) layout for all processes.
.TP
.IR /proc/sys/vm/memory_failure_early_kill " (since Linux 2.6.32)"
-.\" The following is based on the text in Documentation/sysctl/vm.txt
Control how to kill processes when an uncorrected memory error
(typically a 2-bit error in a memory module)
that cannot be handled by the kernel
.BR CONFIG_MEMORY_FAILURE .
.TP
.IR /proc/sys/vm/memory_failure_recovery " (since Linux 2.6.32)"
-.\" The following is based on the text in Documentation/sysctl/vm.txt
Enable memory failure recovery (when supported by the platform).
.RS
.TP
.BR CONFIG_MEMORY_FAILURE .
.TP
.IR /proc/sys/vm/oom_dump_tasks " (since Linux 2.6.25)"
-.\" The following is from Documentation/sysctl/vm.txt
Enables a system-wide task dump (excluding kernel threads) to be
produced when the kernel performs an OOM-killing.
The dump includes the following information
The default value is 0.
.TP
.IR /proc/sys/vm/oom_kill_allocating_task " (since Linux 2.6.24)"
-.\" The following is from Documentation/sysctl/vm.txt
This enables or disables killing the OOM-triggering task in
out-of-memory situations.
.IP
.IR /proc/sys/vm/overcommit_memory .
.TP
.IR /proc/sys/vm/panic_on_oom " (since Linux 2.6.18)"
-.\" The following is adapted from Documentation/sysctl/vm.txt
This enables or disables a kernel panic in
an out-of-memory situation.
.IP
Select either according to your policy of failover.
.TP
.I /proc/sys/vm/swappiness
-.\" The following is from Documentation/sysctl/vm.txt
The value in this file controls how aggressively the kernel will swap
memory pages.
Higher values increase aggressiveness, lower values
This file is normally writable only by
.IR root .
For further details see the Linux kernel source file
-.I Documentation/admin\-guide/sysrq.rst
-.\" commit 9d85025b0418163fae079c9ba8f8445212de8568
-(or
-.I Documentation/sysrq.txt
-before Linux 4.10).
+.IR Documentation/admin\-guide/sysrq.rst .
.SH SEE ALSO
.BR proc (5)
.BR slabtop (1)
.P
The kernel source file
-.I Documentation/vm/slub.txt
+.I Documentation/mm/slab.rst
and
-.IR tools/vm/slabinfo.c .
+.IR tools/mm/slabinfo.c .
(For information on
.IR ftrace ,
see the kernel source file
-.IR Documentation/trace/ftrace.txt .)
+.IR Documentation/trace/ftrace.rst .)
.TP
.I /sys/kernel/mm
This subdirectory contains various files and subdirectories that provide
.\" https://www.kernel.org/pub/linux/kernel/people/mochel/doc/papers/ols-2005/mochel.pdf
.P
The kernel source file
-.I Documentation/filesystems/sysfs.txt
+.I Documentation/filesystems/sysfs.rst
and various other files in
.I Documentation/ABI
and
-.I Documentation/*/sysfs.txt
+.I Documentation/*/sysfs.rst
.BR mount (8)
.P
The kernel source files
-.I Documentation/filesystems/tmpfs.txt
+.I Documentation/filesystems/tmpfs.rst
and
.IR Documentation/admin\-guide/mm/transhuge.rst .
.BR rds (7),
.BR rds\-rdma (7),
and
-.I Documentation/networking/rds.txt
+.I Documentation/networking/rds.rst
in the Linux kernel source tree.
.TP
.B AF_IRDA
Generic PPP transport layer, for setting up L2 tunnels
(L2TP and PPPoE).
See
-.I Documentation/networking/l2tp.txt
+.I Documentation/networking/l2tp.rst
in the Linux kernel source tree for details.
.TP
.B AF_WANPIPE
Rx, Andrew File System remote procedure call protocol
(since Linux 2.6.22).
See
-.I Documentation/networking/rxrpc.txt
+.I Documentation/networking/rxrpc.rst
in the Linux kernel source tree for details.
.TP
.B AF_ISDN
.\" commit: 4b07b3f69a8471cdc142c51461a331226fef248a
Nokia cellular modem IPC/RPC interface (since Linux 2.6.31).
See
-.I Documentation/networking/phonet.txt
+.I Documentation/networking/phonet.rst
in the Linux kernel source tree for details.
.TP
.B AF_IEEE802154
IEEE 802.15.4 WPAN (wireless personal area network) raw packet protocol
(since Linux 2.6.31).
See
-.I Documentation/networking/ieee802154.txt
+.I Documentation/networking/ieee802154.rst
in the Linux kernel source tree for details.
.TP
.B AF_CAIF
Ericsson's Communication CPU to Application CPU interface (CAIF) protocol
(since Linux 2.6.36).
See
-.I Documentation/networking/caif/Linux\-CAIF.txt
+.I Documentation/networking/caif/linux_caif.rst
in the Linux kernel source tree for details.
.TP
.B AF_ALG
.\" commit: 03c8efc1ffeb6b82a22c1af8dd908af349563314
KCM (kernel connection multiplexer) interface (since Linux 4.6).
See
-.I Documentation/networking/kcm.txt
+.I Documentation/networking/kcm.rst
in the Linux kernel source tree for details.
.TP
.B AF_QIPCRTR
These days ram disks use the buffer cache, and grow dynamically.
For a lot of information on the current ramdisk
setup, see the kernel source file
-.I Documentation/blockdev/ramdisk.txt
-.RI ( Documentation/ramdisk.txt
-in older kernels).
+.IR Documentation/blockdev/ramdisk.rst .
.IP
There are four parameters, two boolean and two integral.
.TP
.IP
For a detailed description of the initrd feature,
see the kernel source file
-.I Documentation/admin\-guide/initrd.rst
-.\" commit 9d85025b0418163fae079c9ba8f8445212de8568
-(or
-.I Documentation/initrd.txt
-before Linux 4.10).
+.IR Documentation/admin\-guide/initrd.rst .
.IP
The 'noinitrd' option tells the kernel that although it was compiled for
operation with initrd, it should not go through the above steps, but
.in
.IP
Full details can be found in the file
-.I Documentation/scsi/st.txt
-(or
-.I drivers/scsi/README.st
-for older kernels) in the Linux kernel source.
+.IR Documentation/scsi/st.rst .
.SS Hard disks
.TP
.B "IDE Disk/CD-ROM Driver Parameters"
the section in that document on their particular card.
.SS The floppy disk driver
There are many floppy driver options, and they are all listed in
-.I Documentation/blockdev/floppy.txt
-(or
-.I Documentation/floppy.txt
-in older kernels, or
-.I drivers/block/README.fd
-for ancient kernels) in the Linux kernel source.
+.IR Documentation/blockdev/floppy.rst .
See that file for the details.
.SS The sound driver
The sound driver can also accept boot arguments to override the compiled-in
source file
.I Documentation/admin\-guide/cgroup\-v2.rst
(or
-.I Documentation/cgroup\-v2.txt
+.I Documentation/cgroup\-v2.rst
in Linux 4.17 and earlier).
.P
Because of the problems with the initial cgroups implementation
when a system is busy.
This does not limit a cgroup's CPU usage if the CPUs are not busy.
For further information, see
-.I Documentation/scheduler/sched\-design\-CFS.rst
-(or
-.I Documentation/scheduler/sched\-design\-CFS.txt
-in Linux 5.2 and earlier).
+.IR Documentation/scheduler/sched\-design\-CFS.rst .
.IP
In Linux 3.2,
this controller was extended to provide CPU "bandwidth" control.
an upper limit on the CPU time allocated to the processes in a cgroup.
This upper limit applies even if there is no other competition for the CPU.
Further information can be found in the kernel source file
-.I Documentation/scheduler/sched\-bwc.rst
-(or
-.I Documentation/scheduler/sched\-bwc.txt
-in Linux 5.2 and earlier).
+.IR Documentation/scheduler/sched\-bwc.rst .
.TP
.IR cpuacct " (since Linux 2.6.24; " \f[B]CONFIG_CGROUP_CPUACCT\f[] )
This provides accounting for CPU usage by groups of processes.
.IP
Further information can be found in the kernel source file
-.I Documentation/admin\-guide/cgroup\-v1/cpuacct.rst
-(or
-.I Documentation/cgroup\-v1/cpuacct.txt
-in Linux 5.2 and earlier).
+.IR Documentation/admin\-guide/cgroup\-v1/cpuacct.rst .
.TP
.IR cpuset " (since Linux 2.6.24; " \f[B]CONFIG_CPUSETS\f[] )
This cgroup can be used to bind the processes in a cgroup to
a specified set of CPUs and NUMA nodes.
.IP
Further information can be found in the kernel source file
-.I Documentation/admin\-guide/cgroup\-v1/cpusets.rst
-(or
-.I Documentation/cgroup\-v1/cpusets.txt
-in Linux 5.2 and earlier).
+.IR Documentation/admin\-guide/cgroup\-v1/cpusets.rst .
.
.TP
.IR memory " (since Linux 2.6.25; " \f[B]CONFIG_MEMCG\f[] )
memory, and swap used by cgroups.
.IP
Further information can be found in the kernel source file
-.I Documentation/admin\-guide/cgroup\-v1/memory.rst
-(or
-.I Documentation/cgroup\-v1/memory.txt
-in Linux 5.2 and earlier).
+.IR Documentation/admin\-guide/cgroup\-v1/memory.rst .
.TP
.IR devices " (since Linux 2.6.26; " \f[B]CONFIG_CGROUP_DEVICE\f[] )
This supports controlling which processes may create (mknod) devices as
violate existing rules for the target or ancestor cgroups.
.IP
Further information can be found in the kernel source file
-.I Documentation/admin\-guide/cgroup\-v1/devices.rst
-(or
-.I Documentation/cgroup\-v1/devices.txt
-in Linux 5.2 and earlier).
+.IR Documentation/admin\-guide/cgroup\-v1/devices.rst .
.TP
.IR freezer " (since Linux 2.6.28; " \f[B]CONFIG_CGROUP_FREEZER\f[] )
The
to be frozen.
.IP
Further information can be found in the kernel source file
-.I Documentation/admin\-guide/cgroup\-v1/freezer\-subsystem.rst
-(or
-.I Documentation/cgroup\-v1/freezer\-subsystem.txt
-in Linux 5.2 and earlier).
+.IR Documentation/admin\-guide/cgroup\-v1/freezer\-subsystem.rst .
.TP
.IR net_cls " (since Linux 2.6.29; " \f[B]CONFIG_CGROUP_NET_CLASSID\f[] )
This places a classid, specified for the cgroup, on network packets
leaving the cgroup, not to traffic arriving at the cgroup.
.IP
Further information can be found in the kernel source file
-.I Documentation/admin\-guide/cgroup\-v1/net_cls.rst
-(or
-.I Documentation/cgroup\-v1/net_cls.txt
-in Linux 5.2 and earlier).
+.IR Documentation/admin\-guide/cgroup\-v1/net_cls.rst .
.TP
.IR blkio " (since Linux 2.6.33; " \f[B]CONFIG_BLK_CGROUP\f[] )
The
upper I/O rate limits on a device.
.IP
Further information can be found in the kernel source file
-.I Documentation/admin\-guide/cgroup\-v1/blkio\-controller.rst
-(or
-.I Documentation/cgroup\-v1/blkio\-controller.txt
-in Linux 5.2 and earlier).
+.IR Documentation/admin\-guide/cgroup\-v1/blkio\-controller.rst .
.TP
.IR perf_event " (since Linux 2.6.39; " \f[B]CONFIG_CGROUP_PERF\f[] )
This controller allows
This allows priorities to be specified, per network interface, for cgroups.
.IP
Further information can be found in the kernel source file
-.I Documentation/admin\-guide/cgroup\-v1/net_prio.rst
-(or
-.I Documentation/cgroup\-v1/net_prio.txt
-in Linux 5.2 and earlier).
+.IR Documentation/admin\-guide/cgroup\-v1/net_prio.rst .
.TP
.IR hugetlb " (since Linux 3.5; " \f[B]CONFIG_CGROUP_HUGETLB\f[] )
This supports limiting the use of huge pages by cgroups.
.IP
Further information can be found in the kernel source file
-.I Documentation/admin\-guide/cgroup\-v1/hugetlb.rst
-(or
-.I Documentation/cgroup\-v1/hugetlb.txt
-in Linux 5.2 and earlier).
+.IR Documentation/admin\-guide/cgroup\-v1/hugetlb.rst .
.TP
.IR pids " (since Linux 4.3; " \f[B]CONFIG_CGROUP_PIDS\f[] )
This controller permits limiting the number of process that may be created
in a cgroup (and its descendants).
.IP
Further information can be found in the kernel source file
-.I Documentation/admin\-guide/cgroup\-v1/pids.rst
-(or
-.I Documentation/cgroup\-v1/pids.txt
-in Linux 5.2 and earlier).
+.IR Documentation/admin\-guide/cgroup\-v1/pids.rst .
.TP
.IR rdma " (since Linux 4.11; " \f[B]CONFIG_CGROUP_RDMA\f[] )
The RDMA controller permits limiting the use of
RDMA/IB-specific resources per cgroup.
.IP
Further information can be found in the kernel source file
-.I Documentation/admin\-guide/cgroup\-v1/rdma.rst
-(or
-.I Documentation/cgroup\-v1/rdma.txt
-in Linux 5.2 and earlier).
+.IR Documentation/admin\-guide/cgroup\-v1/rdma.rst .
.\"
.SS Creating cgroups and moving processes
A cgroup filesystem initially contains a single root cgroup, '/',
.P
For more changes, see the
.I Documentation/admin\-guide/cgroup\-v2.rst
-file in the kernel source
-(or
-.I Documentation/cgroup\-v2.txt
-in Linux 4.17 and earlier).
+file in the kernel source.
.
.P
Some of the new behaviors listed above saw subsequent modification with
.\"
.SS Cgroups v2 controllers
The following controllers, documented in the kernel source file
-.I Documentation/admin\-guide/cgroup\-v2.rst
-(or
-.I Documentation/cgroup\-v2.txt
-in Linux 4.17 and earlier),
+.IR Documentation/admin\-guide/cgroup\-v2.rst ,
are supported in cgroups version 2:
.TP
.IR cpu " (since Linux 4.15)"
.P
.I Documentation/admin\-guide/cgroup\-v1/cpusets.rst
in the Linux kernel source tree
-.\" commit 45ce80fb6b6f9594d1396d44dd7e7c02d596fef8
-(or
-.I Documentation/cgroup\-v1/cpusets.txt
-before Linux 4.18, and
-.I Documentation/cpusets.txt
-before Linux 2.6.29)
packets.
.TP
.IR icmp_errors_use_inbound_ifaddr " (Boolean; default: disabled; since Linux 2.6.12)"
-.\" The following taken from Linux 2.6.28-rc4 Documentation/networking/ip-sysctl.txt
If disabled, ICMP error messages are sent with the primary address of
the exiting interface.
.IP
.TP
.IR icmp_ignore_bogus_error_responses " (Boolean; default: disabled; since Linux 2.2)"
.\" precisely: since Linux 2.1.32
-.\" The following taken from Linux 2.6.28-rc4 Documentation/networking/ip-sysctl.txt
Some routers violate RFC1122 by sending bogus responses to broadcast frames.
Such violations are normally logged via a kernel warning.
If this parameter is enabled, the kernel will not give such warnings,
These packets are sent when a packet arrives with an invalid IP header.
.TP
.IR icmp_ratelimit " (integer; default: 1000; since Linux 2.4.10)"
-.\" The following taken from Linux 2.6.28-rc4 Documentation/networking/ip-sysctl.txt
Limit the maximum rates for sending ICMP packets whose type matches
.I icmp_ratemask
(see below) to specific targets.
otherwise the minimum space between responses in milliseconds.
.TP
.IR icmp_ratemask " (integer; default: see below; since Linux 2.4.10)"
-.\" The following taken from Linux 2.6.28-rc4 Documentation/networking/ip-sysctl.txt
Mask made of ICMP types for which rates are being limited.
.IP
Significant bits: IHGFEDCBA9876543210
.BR stat (2),
.BR fanotify (7)
.P
-.I Documentation/filesystems/inotify.txt
+.I Documentation/filesystems/inotify.rst
in the Linux kernel source tree
.BR ip (8)
.P
The kernel source file
-.IR Documentation/networking/ip\-sysctl.txt .
+.IR Documentation/networking/ip\-sysctl.rst .
.P
RFC\ 791 for the original IP specification.
RFC\ 1122 for the IPv4 host requirements.
.BR pam_keyinit (8),
.BR request\-key (8)
.TP
-.I linux.git/Documentation/crypto/asymmetric\-keys.txt
+.I linux.git/Documentation/crypto/asymmetric\-keys.rst
.TQ
.I linux.git/\:Documentation/\:security/\:keys/
.\" why is it necessary / how does it differ?
.\"
.\" SO_TIMESTAMPING (2.6.30)
-.\" Documentation/networking/timestamping.txt
+.\" Documentation/networking/timestamping.rst
.\" commit cb9eff097831007afb30d64373f29d99825d0068
.\" Author: Patrick Ohly <patrick.ohly@intel.com>
.\"
never has more than one filter defined.
.IP
Both classic and extended BPF are explained in the kernel source file
-.I Documentation/networking/filter.txt
+.I Documentation/networking/filter.rst
.TP
.B SO_ATTACH_REUSEPORT_CBPF
.TQ
.IR tcp_abc " (Integer; default: 0; Linux 2.6.15 to Linux 3.8)"
.\" Since Linux 2.6.15; removed in Linux 3.9
.\" commit ca2eb5679f8ddffff60156af42595df44a315ef0
-.\" The following is from Linux 2.6.28-rc4: Documentation/networking/ip-sysctl.txt
Control the Appropriate Byte Count (ABC), defined in RFC 3465.
ABC is a way of increasing the congestion window
.RI ( cwnd )
used for the application buffer is one fourth that of the total.
.TP
.IR tcp_allowed_congestion_control " (String; default: see text; since Linux 2.4.20)"
-.\" The following is from Linux 2.6.28-rc4: Documentation/networking/ip-sysctl.txt
Show/set the congestion control algorithm choices available to unprivileged
processes (see the description of the
.B TCP_CONGESTION
.TP
.IR tcp_autocorking " (Boolean; default: enabled; since Linux 3.14)"
.\" commit f54b311142a92ea2e42598e347b84e1655caf8e3
-.\" Text heavily based on Documentation/networking/ip-sysctl.txt
+.\" Text heavily based on Documentation/networking/ip-sysctl.rst
If this option is enabled, the kernel tries to coalesce small writes
(from consecutive
.BR write (2)
when they know how/when to uncork their sockets.
.TP
.IR tcp_available_congestion_control " (String; read-only; since Linux 2.4.20)"
-.\" The following is from Linux 2.6.28-rc4: Documentation/networking/ip-sysctl.txt
Show a list of the congestion-control algorithms
that are registered.
The items in the list are separated by white space and
are reserved for the application buffer.
A value of 0 implies that no amount is reserved.
.\"
-.\" The following is from Linux 2.6.28-rc4: Documentation/networking/ip-sysctl.txt
.TP
.IR tcp_base_mss " (Integer; default: 512; since Linux 2.6.17)"
The initial value of
If MTU probing is enabled,
this is the initial MSS used by the connection.
.\"
-.\" The following is from Linux 2.6.12: Documentation/networking/ip-sysctl.txt
.TP
.IR tcp_bic " (Boolean; default: disabled; Linux 2.4.27/2.6.6 to Linux 2.6.13)"
Enable BIC TCP congestion control algorithm.
Under small congestion windows, binary search
increase provides TCP friendliness.
.\"
-.\" The following is from Linux 2.6.12: Documentation/networking/ip-sysctl.txt
.TP
.IR tcp_bic_low_window " (integer; default: 14; Linux 2.4.27/2.6.6 to Linux 2.6.13)"
Set the threshold window (in packets) where BIC TCP starts to
adjust the congestion window.
Below this threshold BIC TCP behaves the same as the default TCP Reno.
.\"
-.\" The following is from Linux 2.6.12: Documentation/networking/ip-sysctl.txt
.TP
.IR tcp_bic_fast_convergence " (Boolean; default: enabled; Linux 2.4.27/2.6.6 to Linux 2.6.13)"
Force BIC TCP to more quickly respond to changes in congestion window.
Allows two flows sharing the same connection to converge more rapidly.
.TP
.IR tcp_congestion_control " (String; default: see text; since Linux 2.4.13)"
-.\" The following is from Linux 2.6.28-rc4: Documentation/networking/ip-sysctl.txt
Set the default congestion-control algorithm to be used for new connections.
The algorithm "reno" is always available,
but additional choices may be available depending on kernel configuration.
but required to prevent denial-of-service attacks.
In Linux 2.2, the default value was 180.
.\"
-.\" The following is from Linux 2.6.12: Documentation/networking/ip-sysctl.txt
.TP
.IR tcp_frto " (integer; default: see below; since Linux 2.4.21/2.6)"
.\" Since Linux 2.4.21/2.5.43
Note that underlying connection tracking mechanisms and
application timeouts may be much shorter.
.\"
-.\" The following is from Linux 2.6.12: Documentation/networking/ip-sysctl.txt
.TP
.IR tcp_low_latency " (Boolean; default: disabled; since Linux 2.4.21/2.6; obsolete since Linux 4.14)"
.\" Since Linux 2.4.21/2.5.60
exceeded, the socket is closed and a warning is printed.
.TP
.IR tcp_moderate_rcvbuf " (Boolean; default: enabled; since Linux 2.4.17/2.6.7)"
-.\" The following is from Linux 2.6.28-rc4: Documentation/networking/ip-sysctl.txt
If enabled, TCP performs receive buffer auto-tuning,
attempting to automatically size the buffer (no greater than
.IR tcp_rmem[2] )
.RE
.TP
.IR tcp_mtu_probing " (integer; default: 0; since Linux 2.6.17)"
-.\" The following is from Linux 2.6.28-rc4: Documentation/networking/ip-sysctl.txt
This parameter controls TCP Packetization-Layer Path MTU Discovery.
The following values may be assigned to the file:
.RS
.RE
.TP
.IR tcp_no_metrics_save " (Boolean; default: disabled; since Linux 2.6.6)"
-.\" The following is from Linux 2.6.28-rc4: Documentation/networking/ip-sysctl.txt
By default, TCP saves various connection metrics in the route cache
when the connection closes, so that connections established in the
near future can use these to set initial conditions.
Enable RFC\ 2018 TCP Selective Acknowledgements.
.TP
.IR tcp_slow_start_after_idle " (Boolean; default: enabled; since Linux 2.6.18)"
-.\" The following is from Linux 2.6.28-rc4: Documentation/networking/ip-sysctl.txt
If enabled, provide RFC 2861 behavior and time out the congestion
window after an idle period.
An idle period is defined as the current RTO (retransmission timeout).
offsets).
See RFC 1323 (PAWS) and RFC 6191.
.\"
-.\" The following is from Linux 2.6.12: Documentation/networking/ip-sysctl.txt
.TP
.IR tcp_tw_reuse " (Boolean; default: disabled; since Linux 2.4.19/2.6)"
.\" Since Linux 2.4.19/2.5.43
safe from protocol viewpoint.
It should not be changed without advice/request of technical experts.
.\"
-.\" The following is from Linux 2.6.12: Documentation/networking/ip-sysctl.txt
.TP
.IR tcp_vegas_cong_avoid " (Boolean; default: disabled; Linux 2.2 to Linux 2.6.13)"
.\" Since Linux 2.1.8; removed in Linux 2.6.13
TCP Vegas should provide less packet loss, but it is
not as aggressive as TCP Reno.
.\"
-.\" The following is from Linux 2.6.12: Documentation/networking/ip-sysctl.txt
.TP
.IR tcp_westwood " (Boolean; default: disabled; Linux 2.4.26/2.6.3 to Linux 2.6.13)"
Enable TCP Westwood+ congestion control algorithm.
.\" .SH AUTHORS
.\" This man page was originally written by Andi Kleen.
.\" It was updated for 2.4 by Nivedita Singhvi with input from
-.\" Alexey Kuznetsov's Documentation/networking/ip-sysctl.txt
+.\" Alexey Kuznetsov's Documentation/networking/ip-sysctl.rst
.\" document.
.SH SEE ALSO
.BR accept (2),
.BR socket (7)
.P
The kernel source file
-.IR Documentation/networking/ip\-sysctl.txt .
+.IR Documentation/networking/ip\-sysctl.rst .
.P
RFC\ 793 for the TCP specification.
.br
.BR udplite (7)
.P
The kernel source file
-.IR Documentation/networking/ip\-sysctl.txt .
+.IR Documentation/networking/ip\-sysctl.rst .
.P
RFC\ 768 for the User Datagram Protocol.
.br
.P
RFC\ 3828 for the Lightweight User Datagram Protocol (UDP-Lite).
.P
-.I Documentation/networking/udplite.txt
+.I Documentation/networking/udplite.rst
in the Linux kernel source tree
assigned to the Linux zone is maintained by LANANA and the registry
itself is
.I Documentation/admin\-guide/unicode.rst
-in the Linux kernel sources
-.\" commit 9d85025b0418163fae079c9ba8f8445212de8568
-(or
-.I Documentation/unicode.txt
-before Linux 4.10).
+in the Linux kernel sources.
.P
Two other planes are reserved for private usage, plane 15
(Supplementary Private Use Area-A, range 0xf0000 to 0xffffd)
projects / thirdparty / man-pages.git / commitdiff
