linux/Documentation/tty/tty_internals.rst
Jiri Slaby 3f19fed8d0 Documentation: add TTY chapter
We now have all the kernel-doc comments in the code ready. So add a
couple of documents dragging those into generated docs from
Documentation/. There is only some sugar text around included
kernel-docs here.

It's a complete chapter, to be extended later as desired. This is a
solid cornerstone for the time being, I believe.

Signed-off-by: Jiri Slaby <jslaby@suse.cz>
Link: https://lore.kernel.org/r/20211126081611.11001-24-jslaby@suse.cz
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
2021-11-26 16:27:43 +01:00

32 lines
556 B
ReStructuredText

.. SPDX-License-Identifier: GPL-2.0
=============
TTY Internals
=============
.. contents:: :local:
Kopen
=====
These functions serve for opening a TTY from the kernelspace:
.. kernel-doc:: drivers/tty/tty_io.c
:identifiers: tty_kopen_exclusive tty_kopen_shared tty_kclose
----
Exported Internal Functions
===========================
.. kernel-doc:: drivers/tty/tty_io.c
:identifiers: tty_release_struct tty_dev_name_to_number tty_get_icount
----
Internal Functions
==================
.. kernel-doc:: drivers/tty/tty_io.c
:internal: