github-mirror/linux
1
0
Fork 0
mirror of https://github.com/torvalds/linux.git synced 2026-06-02 11:33:28 +02:00
Code Issues Actions Packages Projects Releases Wiki Activity Graph

tty: move locking docs out of Returns for functions in tty.h

Browse Source 
Both tty_kref_get() and tty_get_baud_rate() note about locking in their
Return kernel-doc clause. Extract this info into a separate "Locking"
paragraph -- the same as we do for other tty functions.

Signed-off-by: "Jiri Slaby (SUSE)" <jirislaby@kernel.org>
Suggested-by: Ilpo Järvinen <ilpo.jarvinen@linux.intel.com>
Reviewed-by: Ilpo Järvinen <ilpo.jarvinen@linux.intel.com>
Link: https://lore.kernel.org/r/20231121092258.9334-5-jirislaby@kernel.org
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
This commit is contained in:
Jiri Slaby (SUSE) 2023-11-21 10:22:45 +01:00 committed by Greg Kroah-Hartman
parent d22d53ad8a
commit 239123e7e8
1 changed files with 7 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
include/linux/tty.h
View File

@ -393,8 +393,10 @@ extern const struct class tty_class;
* tty_kref_get - get a tty reference
* @tty: tty device
*
* Returns: 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
*
* Locking: 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)
{
@ -436,10 +438,10 @@ void tty_encode_baud_rate(struct tty_struct *tty, speed_t ibaud,
* 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
*
* Locking: none
* Locking: The termios lock must be held by the caller and the terminal bit
* flags may be updated.
*/
static inline speed_t tty_get_baud_rate(struct tty_struct *tty)
{