diff options
| author | Jiri Slaby (SUSE) <jirislaby@kernel.org> | 2025-03-17 08:00:29 +0100 |
|---|---|---|
| committer | Greg Kroah-Hartman <gregkh@linuxfoundation.org> | 2025-03-20 08:00:51 -0700 |
| commit | 63f3cd5d80d720fc6c9fd321138bbbf322ade392 (patch) | |
| tree | fb80b853fe6ce49073faa2c8e82c4a5e5ef388d1 /Documentation/driver-api | |
| parent | tty: tty_driver: convert "TTY Driver Flags" to an enum (diff) | |
| download | linux-63f3cd5d80d720fc6c9fd321138bbbf322ade392.tar.gz linux-63f3cd5d80d720fc6c9fd321138bbbf322ade392.zip | |
tty: tty_driver: document both {,__}tty_alloc_driver() properly
__tty_alloc_driver()'s kernel-doc needed some care: describe the return
value using the standard "Returns:", and use the new enum tty_driver_flag
for @flags.
Then, the tty_alloc_driver() macro was undocumented, but referenced many
times in the docs. Copy the docs from the above (except the @owner
parameter, obviously).
Signed-off-by: Jiri Slaby (SUSE) <jirislaby@kernel.org>
Link: https://lore.kernel.org/r/20250317070046.24386-15-jirislaby@kernel.org
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Diffstat (limited to 'Documentation/driver-api')
| -rw-r--r-- | Documentation/driver-api/tty/tty_driver.rst | 2 |
1 files changed, 2 insertions, 0 deletions
diff --git a/Documentation/driver-api/tty/tty_driver.rst b/Documentation/driver-api/tty/tty_driver.rst index f6cbffdb6e01..7138222a70f2 100644 --- a/Documentation/driver-api/tty/tty_driver.rst +++ b/Documentation/driver-api/tty/tty_driver.rst @@ -25,6 +25,8 @@ freed. For reference, both allocation and deallocation functions are explained here in detail: +.. kernel-doc:: include/linux/tty_driver.h + :identifiers: tty_alloc_driver .. kernel-doc:: drivers/tty/tty_io.c :identifiers: __tty_alloc_driver tty_driver_kref_put |