Minki/linux
1
0
Fork 1
mirror of https://github.com/torvalds/linux.git synced 2024-11-12 23:23:03 +00:00
Code Issues Packages Projects Releases Wiki Activity

tty: fix kernel-doc for functions in tty.h

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

3
Documentation/driver-api/tty/tty_ioctl.rst
View File

@ -5,3 +5,6 @@ TTY IOCTL Helpers
=================
.. kernel-doc:: drivers/tty/tty_ioctl.c
.. kernel-doc:: include/linux/tty.h
:identifiers: tty_get_baud_rate

21
include/linux/tty.h
View File

@ -390,14 +390,12 @@ int vcs_init(void);
extern const struct class tty_class;
/**
* tty_kref_get - get a tty reference
* @tty: tty device
* tty_kref_get - get a tty reference
* @tty: tty device
*
* Return a new reference to a tty object. The caller must hold
* sufficient locks/counts to ensure that their existing reference cannot
* go away
* Returns: a new reference to a tty object. The caller must hold sufficient
* locks/counts to ensure that their existing reference cannot go away
*/
static inline struct tty_struct *tty_kref_get(struct tty_struct *tty)
{
if (tty)
@ -435,14 +433,13 @@ void tty_encode_baud_rate(struct tty_struct *tty, speed_t ibaud,
speed_t obaud);
/**
* tty_get_baud_rate - get tty bit rates
* @tty: tty to query
* tty_get_baud_rate - get tty bit rates
* @tty: tty to query
*
* Returns the baud rate as an integer for this terminal. The
* termios lock must be held by the caller and the terminal bit
* flags may be updated.
* Returns: the baud rate as an integer for this terminal. The termios lock
* must be held by the caller and the terminal bit flags may be updated.
*
* Locking: none
* Locking: none
*/
static inline speed_t tty_get_baud_rate(struct tty_struct *tty)
{