Commit 71067fb7 authored by Jiri Slaby (SUSE)'s avatar Jiri Slaby (SUSE) Committed by Greg Kroah-Hartman

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: default avatar"Jiri Slaby (SUSE)" <jirislaby@kernel.org>
Link: https://lore.kernel.org/r/20230919085156.1578-10-jirislaby@kernel.orgSigned-off-by: default avatarGreg Kroah-Hartman <gregkh@linuxfoundation.org>
parent 3b1a696b
...@@ -5,3 +5,6 @@ TTY IOCTL Helpers ...@@ -5,3 +5,6 @@ TTY IOCTL Helpers
================= =================
.. kernel-doc:: drivers/tty/tty_ioctl.c .. kernel-doc:: drivers/tty/tty_ioctl.c
.. kernel-doc:: include/linux/tty.h
:identifiers: tty_get_baud_rate
...@@ -393,11 +393,9 @@ extern const struct class tty_class; ...@@ -393,11 +393,9 @@ extern const struct class tty_class;
* tty_kref_get - get a tty reference * tty_kref_get - get a tty reference
* @tty: tty device * @tty: tty device
* *
* Return a new reference to a tty object. The caller must hold * Returns: a new reference to a tty object. The caller must hold sufficient
* sufficient locks/counts to ensure that their existing reference cannot * locks/counts to ensure that their existing reference cannot go away
* go away
*/ */
static inline struct tty_struct *tty_kref_get(struct tty_struct *tty) static inline struct tty_struct *tty_kref_get(struct tty_struct *tty)
{ {
if (tty) if (tty)
...@@ -438,9 +436,8 @@ void tty_encode_baud_rate(struct tty_struct *tty, speed_t ibaud, ...@@ -438,9 +436,8 @@ void tty_encode_baud_rate(struct tty_struct *tty, speed_t ibaud,
* tty_get_baud_rate - get tty bit rates * tty_get_baud_rate - get tty bit rates
* @tty: tty to query * @tty: tty to query
* *
* Returns the baud rate as an integer for this terminal. The * Returns: the baud rate as an integer for this terminal. The termios lock
* termios lock must be held by the caller and the terminal bit * must be held by the caller and the terminal bit flags may be updated.
* flags may be updated.
* *
* Locking: none * Locking: none
*/ */
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment