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

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 <corbet@lwn.net>
Signed-off-by: Jiri Slaby <jslaby@suse.cz>
Link: https://lore.kernel.org/r/20220411110143.10019-2-jslaby@suse.cz
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>

authored by

Jiri Slaby and committed by
Greg Kroah-Hartman
b96cd8b0 ce522ba9

+6 -7
+1
Documentation/driver-api/index.rst
··· 101 101 surface_aggregator/index 102 102 switchtec 103 103 sync_file 104 + tty 104 105 vfio-mediated-device 105 106 vfio 106 107 vfio-pci-device-specific-driver-acceptance
+1 -1
Documentation/driver-api/serial/driver.rst
··· 311 311 This call must not sleep 312 312 313 313 set_ldisc(port,termios) 314 - Notifier for discipline change. See Documentation/tty/tty_ldisc.rst. 314 + Notifier for discipline change. See ../tty/tty_ldisc.rst. 315 315 316 316 Locking: caller holds tty_port->mutex 317 317
-1
Documentation/index.rst
··· 137 137 misc-devices/index 138 138 scheduler/index 139 139 mhi/index 140 - tty/index 141 140 peci/index 142 141 143 142 Architecture-agnostic documentation
+4 -5
Documentation/tty/index.rst Documentation/driver-api/tty/index.rst
··· 43 43 ================== 44 44 45 45 Before one starts writing a TTY driver, they must consider 46 - :doc:`Serial <../driver-api/serial/driver>` and :doc:`USB Serial 47 - <../usb/usb-serial>` layers 48 - first. Drivers for serial devices can often use one of these specific layers to 49 - implement a serial driver. Only special devices should be handled directly by 50 - the TTY Layer. If you are about to write such a driver, read on. 46 + :doc:`Serial <../serial/driver>` and :doc:`USB Serial <../../usb/usb-serial>` 47 + layers first. Drivers for serial devices can often use one of these specific 48 + layers to implement a serial driver. Only special devices should be handled 49 + directly by the TTY Layer. If you are about to write such a driver, read on. 51 50 52 51 A *typical* sequence a TTY driver performs is as follows: 53 52
Documentation/tty/n_tty.rst Documentation/driver-api/tty/n_tty.rst
Documentation/tty/tty_buffer.rst Documentation/driver-api/tty/tty_buffer.rst
Documentation/tty/tty_driver.rst Documentation/driver-api/tty/tty_driver.rst
Documentation/tty/tty_internals.rst Documentation/driver-api/tty/tty_internals.rst
Documentation/tty/tty_ldisc.rst Documentation/driver-api/tty/tty_ldisc.rst
Documentation/tty/tty_port.rst Documentation/driver-api/tty/tty_port.rst
Documentation/tty/tty_struct.rst Documentation/driver-api/tty/tty_struct.rst