Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

docs: filesystems: convert devpts.txt to ReST

- Add a SPDX header;
- Add a document title;
- Some whitespace fixes and new line breaks;
- Mark literal blocks as such;
- Add it to filesystems/index.rst.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Link: https://lore.kernel.org/r/4ac8f3a7edd4d817acf0d173ead7ef74fe010c6c.1588021877.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>

authored by

Mauro Carvalho Chehab and committed by
Jonathan Corbet
01478b83 f476c6ed

+38 -27
+1 -1
Documentation/admin-guide/sysctl/kernel.rst
··· 895 895 pty 896 896 === 897 897 898 - See Documentation/filesystems/devpts.txt. 898 + See Documentation/filesystems/devpts.rst. 899 899 900 900 901 901 randomize_va_space
+36
Documentation/filesystems/devpts.rst
··· 1 + .. SPDX-License-Identifier: GPL-2.0 2 + 3 + ===================== 4 + The Devpts Filesystem 5 + ===================== 6 + 7 + Each mount of the devpts filesystem is now distinct such that ptys 8 + and their indicies allocated in one mount are independent from ptys 9 + and their indicies in all other mounts. 10 + 11 + All mounts of the devpts filesystem now create a ``/dev/pts/ptmx`` node 12 + with permissions ``0000``. 13 + 14 + To retain backwards compatibility the a ptmx device node (aka any node 15 + created with ``mknod name c 5 2``) when opened will look for an instance 16 + of devpts under the name ``pts`` in the same directory as the ptmx device 17 + node. 18 + 19 + As an option instead of placing a ``/dev/ptmx`` device node at ``/dev/ptmx`` 20 + it is possible to place a symlink to ``/dev/pts/ptmx`` at ``/dev/ptmx`` or 21 + to bind mount ``/dev/ptx/ptmx`` to ``/dev/ptmx``. If you opt for using 22 + the devpts filesystem in this manner devpts should be mounted with 23 + the ``ptmxmode=0666``, or ``chmod 0666 /dev/pts/ptmx`` should be called. 24 + 25 + Total count of pty pairs in all instances is limited by sysctls:: 26 + 27 + kernel.pty.max = 4096 - global limit 28 + kernel.pty.reserve = 1024 - reserved for filesystems mounted from the initial mount namespace 29 + kernel.pty.nr - current count of ptys 30 + 31 + Per-instance limit could be set by adding mount option ``max=<count>``. 32 + 33 + This feature was added in kernel 3.4 together with 34 + ``sysctl kernel.pty.reserve``. 35 + 36 + In kernels older than 3.4 sysctl ``kernel.pty.max`` works as per-instance limit.
-26
Documentation/filesystems/devpts.txt
··· 1 - Each mount of the devpts filesystem is now distinct such that ptys 2 - and their indicies allocated in one mount are independent from ptys 3 - and their indicies in all other mounts. 4 - 5 - All mounts of the devpts filesystem now create a /dev/pts/ptmx node 6 - with permissions 0000. 7 - 8 - To retain backwards compatibility the a ptmx device node (aka any node 9 - created with "mknod name c 5 2") when opened will look for an instance 10 - of devpts under the name "pts" in the same directory as the ptmx device 11 - node. 12 - 13 - As an option instead of placing a /dev/ptmx device node at /dev/ptmx 14 - it is possible to place a symlink to /dev/pts/ptmx at /dev/ptmx or 15 - to bind mount /dev/ptx/ptmx to /dev/ptmx. If you opt for using 16 - the devpts filesystem in this manner devpts should be mounted with 17 - the ptmxmode=0666, or chmod 0666 /dev/pts/ptmx should be called. 18 - 19 - Total count of pty pairs in all instances is limited by sysctls: 20 - kernel.pty.max = 4096 - global limit 21 - kernel.pty.reserve = 1024 - reserved for filesystems mounted from the initial mount namespace 22 - kernel.pty.nr - current count of ptys 23 - 24 - Per-instance limit could be set by adding mount option "max=<count>". 25 - This feature was added in kernel 3.4 together with sysctl kernel.pty.reserve. 26 - In kernels older than 3.4 sysctl kernel.pty.max works as per-instance limit.
+1
Documentation/filesystems/index.rst
··· 24 24 splice 25 25 locking 26 26 directory-locking 27 + devpts 27 28 28 29 automount-support 29 30