]> www.infradead.org Git - users/jedix/linux-maple.git/commit
tty: tty_driver: document both {,__}tty_alloc_driver() properly
authorJiri Slaby (SUSE) <jirislaby@kernel.org>
Mon, 17 Mar 2025 07:00:29 +0000 (08:00 +0100)
committerGreg Kroah-Hartman <gregkh@linuxfoundation.org>
Thu, 20 Mar 2025 15:00:51 +0000 (08:00 -0700)
commit63f3cd5d80d720fc6c9fd321138bbbf322ade392
treefb80b853fe6ce49073faa2c8e82c4a5e5ef388d1
parent109e06ae1dcf41d470705c54a67b123792424279
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>
Documentation/driver-api/tty/tty_driver.rst
drivers/tty/tty_io.c
include/linux/tty_driver.h