linux-kernel - [PATCH 19/23] tty: move tty_ldisc docs to new Documentation/tty/

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite for Android: free password hash cracker in your pocket

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-Id: <20211126081611.11001-20-jslaby@suse.cz>
Date:   Fri, 26 Nov 2021 09:16:07 +0100
From:   Jiri Slaby <jslaby@...e.cz>
To:     gregkh@...uxfoundation.org
Cc:     linux-serial@...r.kernel.org, linux-kernel@...r.kernel.org,
        Jiri Slaby <jslaby@...e.cz>
Subject: [PATCH 19/23] tty: move tty_ldisc docs to new Documentation/tty/

Create a new directory in Documentation/ called tty. We will create more
documents in it in the next patches, so let's have this one in the very
same place.

Change title accordingly and all the headers. This is the way what other
documents look like in this directory in the next patches. So make this
unified.

And add a TOC.

Signed-off-by: Jiri Slaby <jslaby@...e.cz>
---
 Documentation/driver-api/serial/index.rst     |  1 -
 .../serial/tty.rst => tty/tty_ldisc.rst}      | 23 ++++++++-----------
 2 files changed, 10 insertions(+), 14 deletions(-)
 rename Documentation/{driver-api/serial/tty.rst => tty/tty_ldisc.rst} (91%)

diff --git a/Documentation/driver-api/serial/index.rst b/Documentation/driver-api/serial/index.rst
index 8f7d7af3b90b..7eb21a695fc3 100644
--- a/Documentation/driver-api/serial/index.rst
+++ b/Documentation/driver-api/serial/index.rst
@@ -9,7 +9,6 @@ Support for Serial devices
 
 
     driver
-    tty
 
 Serial drivers
 ==============
diff --git a/Documentation/driver-api/serial/tty.rst b/Documentation/tty/tty_ldisc.rst
similarity index 91%
rename from Documentation/driver-api/serial/tty.rst
rename to Documentation/tty/tty_ldisc.rst
index 65f971e3aada..8e48ab72f965 100644
--- a/Documentation/driver-api/serial/tty.rst
+++ b/Documentation/tty/tty_ldisc.rst
@@ -1,13 +1,10 @@
-=================
-The Lockronomicon
-=================
+.. SPDX-License-Identifier: GPL-2.0
 
-Your guide to the ancient and twisted locking policies of the tty layer and
-the warped logic behind them. Beware all ye who read on.
+===================
+TTY Line Discipline
+===================
 
-
-Line Discipline
----------------
+.. contents:: :local:
 
 Line disciplines are registered with tty_register_ldisc() passing the
 discipline number and the ldisc structure. At the point of registration the
@@ -33,25 +30,25 @@ counts the number of threads of execution within an ldisc method (plus those
 about to enter and exit although this detail matters not).
 
 Line Discipline Methods
------------------------
+=======================
 
 .. kernel-doc:: include/linux/tty_ldisc.h
    :identifiers: tty_ldisc_ops
 
 Driver Access
-^^^^^^^^^^^^^
+=============
 
 Line discipline methods can call the methods of the underlying hardware driver.
 These are documented as a part of struct tty_operations.
 
-Flags
-^^^^^
+TTY Flags
+=========
 
 Line discipline methods have access to :c:member:`tty_struct.flags` field. See
 :doc:`tty_struct`.
 
 Locking
-^^^^^^^
+=======
 
 Callers to the line discipline functions from the tty layer are required to
 take line discipline locks. The same is true of calls from the driver side
-- 
2.34.0