Skip to content

Commit

Permalink
docs: filesystems: convert devpts.txt to ReST
Browse files Browse the repository at this point in the history
- 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>
  • Loading branch information
Mauro Carvalho Chehab authored and Jonathan Corbet committed May 5, 2020
1 parent f476c6e commit 01478b8
Show file tree
Hide file tree
Showing 4 changed files with 38 additions and 27 deletions.
2 changes: 1 addition & 1 deletion Documentation/admin-guide/sysctl/kernel.rst
Original file line number Diff line number Diff line change
Expand Up @@ -895,7 +895,7 @@ this sysctl interface anymore.
pty
===

See Documentation/filesystems/devpts.txt.
See Documentation/filesystems/devpts.rst.


randomize_va_space
Expand Down
36 changes: 36 additions & 0 deletions Documentation/filesystems/devpts.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
.. SPDX-License-Identifier: GPL-2.0
=====================
The Devpts Filesystem
=====================

Each mount of the devpts filesystem is now distinct such that ptys
and their indicies allocated in one mount are independent from ptys
and their indicies in all other mounts.

All mounts of the devpts filesystem now create a ``/dev/pts/ptmx`` node
with permissions ``0000``.

To retain backwards compatibility the a ptmx device node (aka any node
created with ``mknod name c 5 2``) when opened will look for an instance
of devpts under the name ``pts`` in the same directory as the ptmx device
node.

As an option instead of placing a ``/dev/ptmx`` device node at ``/dev/ptmx``
it is possible to place a symlink to ``/dev/pts/ptmx`` at ``/dev/ptmx`` or
to bind mount ``/dev/ptx/ptmx`` to ``/dev/ptmx``. If you opt for using
the devpts filesystem in this manner devpts should be mounted with
the ``ptmxmode=0666``, or ``chmod 0666 /dev/pts/ptmx`` should be called.

Total count of pty pairs in all instances is limited by sysctls::

kernel.pty.max = 4096 - global limit
kernel.pty.reserve = 1024 - reserved for filesystems mounted from the initial mount namespace
kernel.pty.nr - current count of ptys

Per-instance limit could be set by adding mount option ``max=<count>``.

This feature was added in kernel 3.4 together with
``sysctl kernel.pty.reserve``.

In kernels older than 3.4 sysctl ``kernel.pty.max`` works as per-instance limit.
26 changes: 0 additions & 26 deletions Documentation/filesystems/devpts.txt

This file was deleted.

1 change: 1 addition & 0 deletions Documentation/filesystems/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ algorithms work.
splice
locking
directory-locking
devpts

automount-support

Expand Down

0 comments on commit 01478b8

Please sign in to comment.