iv/linux
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

tty: fix up and plug in tty_ioctl kernel-doc

Browse Source 
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>
This commit is contained in:
Jiri Slaby (SUSE)
2023-09-19 10:51:49 +02:00
committed by Greg Kroah-Hartman
parent 5b4f9cf3cc
commit 3b1a696bb9
3 changed files with 115 additions and 111 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
Documentation/driver-api/tty/index.rst
View File

@ -36,6 +36,7 @@ In-detail description of the named TTY structures is in separate documents:
tty_struct
tty_ldisc
tty_buffer
tty_ioctl
tty_internals
Writing TTY Driver

7
Documentation/driver-api/tty/tty_ioctl.rst Normal file
View File

@ -0,0 +1,7 @@
.. SPDX-License-Identifier: GPL-2.0
=================
TTY IOCTL Helpers
=================
.. kernel-doc:: drivers/tty/tty_ioctl.c