diff options
| author | Jiri Slaby <jslaby@suse.cz> | 2021-11-26 09:16:11 +0100 |
|---|---|---|
| committer | Greg Kroah-Hartman <gregkh@linuxfoundation.org> | 2021-11-26 16:27:43 +0100 |
| commit | 3f19fed8d0daed6e0e04b130d203d4333b757901 (patch) | |
| tree | 80f1b8c225f6e37f9c73051660c799f27a104bf6 /Documentation/tty/tty_internals.rst | |
| parent | 31bc35d3346f24315c48ef8c92282c6c4f1bdd12 (diff) | |
| download | linux-3f19fed8d0daed6e0e04b130d203d4333b757901.tar.bz2 | |
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>
Diffstat (limited to 'Documentation/tty/tty_internals.rst')
| -rw-r--r-- | Documentation/tty/tty_internals.rst | 31 |
1 files changed, 31 insertions, 0 deletions
diff --git a/Documentation/tty/tty_internals.rst b/Documentation/tty/tty_internals.rst new file mode 100644 index 000000000000..d0d415820300 --- /dev/null +++ b/Documentation/tty/tty_internals.rst @@ -0,0 +1,31 @@ +.. 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: |