Documentation: add console.rst
Now, that the console kernel-doc is in better shape, include it in the tty/ docs. It's not supernice, but it is what it is. At least for the beginning. Signed-off-by: "Jiri Slaby (SUSE)" <jirislaby@kernel.org> Cc: Jonathan Corbet <corbet@lwn.net> Cc: linux-doc@vger.kernel.org Tested-by: Helge Deller <deller@gmx.de> # parisc STI console Link: https://lore.kernel.org/r/20240122110401.7289-48-jirislaby@kernel.org Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
This commit is contained in:
parent
60234365ae
commit
cf066f9334
45
Documentation/driver-api/tty/console.rst
Normal file
45
Documentation/driver-api/tty/console.rst
Normal file
@ -0,0 +1,45 @@
|
||||
.. SPDX-License-Identifier: GPL-2.0
|
||||
|
||||
=======
|
||||
Console
|
||||
=======
|
||||
|
||||
.. contents:: :local:
|
||||
|
||||
Struct Console
|
||||
==============
|
||||
|
||||
.. kernel-doc:: include/linux/console.h
|
||||
:identifiers: console cons_flags
|
||||
|
||||
Internals
|
||||
---------
|
||||
|
||||
.. kernel-doc:: include/linux/console.h
|
||||
:identifiers: nbcon_state nbcon_prio nbcon_context nbcon_write_context
|
||||
|
||||
Struct Consw
|
||||
============
|
||||
|
||||
.. kernel-doc:: include/linux/console.h
|
||||
:identifiers: consw
|
||||
|
||||
Console functions
|
||||
=================
|
||||
|
||||
.. kernel-doc:: include/linux/console.h
|
||||
:identifiers: console_srcu_read_flags console_srcu_write_flags
|
||||
console_is_registered for_each_console_srcu for_each_console
|
||||
|
||||
.. kernel-doc:: drivers/tty/vt/selection.c
|
||||
:export:
|
||||
.. kernel-doc:: drivers/tty/vt/vt.c
|
||||
:export:
|
||||
|
||||
Internals
|
||||
---------
|
||||
|
||||
.. kernel-doc:: drivers/tty/vt/selection.c
|
||||
:internal:
|
||||
.. kernel-doc:: drivers/tty/vt/vt.c
|
||||
:internal:
|
@ -38,6 +38,7 @@ In-detail description of the named TTY structures is in separate documents:
|
||||
tty_buffer
|
||||
tty_ioctl
|
||||
tty_internals
|
||||
console
|
||||
|
||||
Writing TTY Driver
|
||||
==================
|
||||
|
Loading…
Reference in New Issue
Block a user