From b96cd8b05ead8939b972192c4f4ac2fc2dffceb7 Mon Sep 17 00:00:00 2001 From: Jiri Slaby Date: Mon, 11 Apr 2022 13:01:38 +0200 Subject: [PATCH] Documentation: move tty to driver-api Based on discussion starting as 87mthw2o93.fsf@meer.lwn.net, let's move the tty documentation to driver-api. It's more appropriate there. Cc: Jonathan Corbet Signed-off-by: Jiri Slaby Link: https://lore.kernel.org/r/20220411110143.10019-2-jslaby@suse.cz Signed-off-by: Greg Kroah-Hartman --- Documentation/driver-api/index.rst | 1 + Documentation/driver-api/serial/driver.rst | 2 +- Documentation/{ => driver-api}/tty/index.rst | 9 ++++----- Documentation/{ => driver-api}/tty/n_tty.rst | 0 Documentation/{ => driver-api}/tty/tty_buffer.rst | 0 Documentation/{ => driver-api}/tty/tty_driver.rst | 0 Documentation/{ => driver-api}/tty/tty_internals.rst | 0 Documentation/{ => driver-api}/tty/tty_ldisc.rst | 0 Documentation/{ => driver-api}/tty/tty_port.rst | 0 Documentation/{ => driver-api}/tty/tty_struct.rst | 0 Documentation/index.rst | 1 - 11 files changed, 6 insertions(+), 7 deletions(-) rename Documentation/{ => driver-api}/tty/index.rst (86%) rename Documentation/{ => driver-api}/tty/n_tty.rst (100%) rename Documentation/{ => driver-api}/tty/tty_buffer.rst (100%) rename Documentation/{ => driver-api}/tty/tty_driver.rst (100%) rename Documentation/{ => driver-api}/tty/tty_internals.rst (100%) rename Documentation/{ => driver-api}/tty/tty_ldisc.rst (100%) rename Documentation/{ => driver-api}/tty/tty_port.rst (100%) rename Documentation/{ => driver-api}/tty/tty_struct.rst (100%) diff --git a/Documentation/driver-api/index.rst b/Documentation/driver-api/index.rst index a7b0223e2886a..bbbbcf20b7ce4 100644 --- a/Documentation/driver-api/index.rst +++ b/Documentation/driver-api/index.rst @@ -101,6 +101,7 @@ available subsections can be seen below. surface_aggregator/index switchtec sync_file + tty vfio-mediated-device vfio vfio-pci-device-specific-driver-acceptance diff --git a/Documentation/driver-api/serial/driver.rst b/Documentation/driver-api/serial/driver.rst index 06ec04ba086fd..7ef83fd3917b2 100644 --- a/Documentation/driver-api/serial/driver.rst +++ b/Documentation/driver-api/serial/driver.rst @@ -311,7 +311,7 @@ hardware. This call must not sleep set_ldisc(port,termios) - Notifier for discipline change. See Documentation/tty/tty_ldisc.rst. + Notifier for discipline change. See ../tty/tty_ldisc.rst. Locking: caller holds tty_port->mutex diff --git a/Documentation/tty/index.rst b/Documentation/driver-api/tty/index.rst similarity index 86% rename from Documentation/tty/index.rst rename to Documentation/driver-api/tty/index.rst index 21ea0cb21e558..2240e52203d6a 100644 --- a/Documentation/tty/index.rst +++ b/Documentation/driver-api/tty/index.rst @@ -43,11 +43,10 @@ Writing TTY Driver ================== Before one starts writing a TTY driver, they must consider -:doc:`Serial <../driver-api/serial/driver>` and :doc:`USB Serial -<../usb/usb-serial>` layers -first. Drivers for serial devices can often use one of these specific layers to -implement a serial driver. Only special devices should be handled directly by -the TTY Layer. If you are about to write such a driver, read on. +:doc:`Serial <../serial/driver>` and :doc:`USB Serial <../../usb/usb-serial>` +layers first. Drivers for serial devices can often use one of these specific +layers to implement a serial driver. Only special devices should be handled +directly by the TTY Layer. If you are about to write such a driver, read on. A *typical* sequence a TTY driver performs is as follows: diff --git a/Documentation/tty/n_tty.rst b/Documentation/driver-api/tty/n_tty.rst similarity index 100% rename from Documentation/tty/n_tty.rst rename to Documentation/driver-api/tty/n_tty.rst diff --git a/Documentation/tty/tty_buffer.rst b/Documentation/driver-api/tty/tty_buffer.rst similarity index 100% rename from Documentation/tty/tty_buffer.rst rename to Documentation/driver-api/tty/tty_buffer.rst diff --git a/Documentation/tty/tty_driver.rst b/Documentation/driver-api/tty/tty_driver.rst similarity index 100% rename from Documentation/tty/tty_driver.rst rename to Documentation/driver-api/tty/tty_driver.rst diff --git a/Documentation/tty/tty_internals.rst b/Documentation/driver-api/tty/tty_internals.rst similarity index 100% rename from Documentation/tty/tty_internals.rst rename to Documentation/driver-api/tty/tty_internals.rst diff --git a/Documentation/tty/tty_ldisc.rst b/Documentation/driver-api/tty/tty_ldisc.rst similarity index 100% rename from Documentation/tty/tty_ldisc.rst rename to Documentation/driver-api/tty/tty_ldisc.rst diff --git a/Documentation/tty/tty_port.rst b/Documentation/driver-api/tty/tty_port.rst similarity index 100% rename from Documentation/tty/tty_port.rst rename to Documentation/driver-api/tty/tty_port.rst diff --git a/Documentation/tty/tty_struct.rst b/Documentation/driver-api/tty/tty_struct.rst similarity index 100% rename from Documentation/tty/tty_struct.rst rename to Documentation/driver-api/tty/tty_struct.rst diff --git a/Documentation/index.rst b/Documentation/index.rst index 1988c19d9daf4..5a5acac985f3e 100644 --- a/Documentation/index.rst +++ b/Documentation/index.rst @@ -137,7 +137,6 @@ needed). misc-devices/index scheduler/index mhi/index - tty/index peci/index Architecture-agnostic documentation -- 2.30.2