Commit b96cd8b0 authored by Jiri Slaby's avatar Jiri Slaby Committed by Greg Kroah-Hartman
Browse files

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: default avatarJiri Slaby <jslaby@suse.cz>
Link: https://lore.kernel.org/r/20220411110143.10019-2-jslaby@suse.cz


Signed-off-by: default avatarGreg Kroah-Hartman <gregkh@linuxfoundation.org>
parent ce522ba9

Documentation/driver-api/index.rst

+1 −0
Original line number Diff line number Diff line
@@ -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

Documentation/driver-api/serial/driver.rst

+1 −1
Original line number Diff line number Diff line
@@ -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

Documentation/tty/index.rst→Documentation/driver-api/tty/index.rst

+4 −5
Original line number Diff line number Diff line
@@ -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: