linux-stable/Documentation/driver-api/tty/tty_ioctl.rst

.. SPDX-License-Identifier: GPL-2.0

=================
TTY IOCTL Helpers
=================

.. kernel-doc:: drivers/tty/tty_ioctl.c

.. kernel-doc:: include/linux/tty.h
   :identifiers: tty_get_baud_rate
tty: fix up and plug in tty_ioctl kernel-doc The ioctl helpers are well documented, except they are not plugged in the Documentation. So fix up the minor issues in the kernel-doc and plug it in. The minor issues include: * bad \t on every line (sphinx misinterprets the description otherwise) * missing colon after Return * superfluous \n after the comment * make some struct members and constants a hyperlink * and so on Perhaps better to use --word-diff if one wants to see the "real" changes. Signed-off-by: "Jiri Slaby (SUSE)" <jirislaby@kernel.org> Link: https://lore.kernel.org/r/20230919085156.1578-9-jirislaby@kernel.org Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org> 2023-09-19 08:51:49 +00:00			`.. SPDX-License-Identifier: GPL-2.0`

			`=================`
			`TTY IOCTL Helpers`
			`=================`

			`.. kernel-doc:: drivers/tty/tty_ioctl.c`
tty: fix kernel-doc for functions in tty.h tty_kref_get() is already included in Documentation, but is not properly formatted. Fix this. tty_get_baud_rate() is neither properly formatted, nor is included. Fix both. Signed-off-by: "Jiri Slaby (SUSE)" <jirislaby@kernel.org> Link: https://lore.kernel.org/r/20230919085156.1578-10-jirislaby@kernel.org Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org> 2023-09-19 08:51:50 +00:00
			`.. kernel-doc:: include/linux/tty.h`
			`:identifiers: tty_get_baud_rate`