superrob1500
/
mirror-linux
mirror of https://github.com/torvalds/linux
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

tty: fix tty_port_tty_*hangup() kernel-doc 

The commit below added a new helper, but omitted to move (and add) the
corressponding kernel-doc. Do it now.

Signed-off-by: "Jiri Slaby (SUSE)" <jirislaby@kernel.org>
Fixes: 2b5eac0f8c ("tty: introduce and use tty_port_tty_vhangup() helper")
Link: https://lore.kernel.org/all/b23d566c-09dc-7374-cc87-0ad4660e8b2e@linux.intel.com/
Reported-by: Ilpo Järvinen <ilpo.jarvinen@linux.intel.com>
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: linux-doc@vger.kernel.org
Link: https://lore.kernel.org/r/20250624080641.509959-6-jirislaby@kernel.org
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
pull/1279/head
Jiri Slaby (SUSE) 2025-06-24 10:06:41 +02:00 committed by Greg Kroah-Hartman
parent 543a5af343
commit 6241b49540
3 changed files with 12 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
Documentation/driver-api/tty/tty_port.rst
View File

@ -42,9 +42,10 @@ TTY Refcounting
TTY Helpers
-----------
.. kernel-doc:: include/linux/tty_port.h
:identifiers: tty_port_tty_hangup tty_port_tty_vhangup
.. kernel-doc:: drivers/tty/tty_port.c
:identifiers: tty_port_tty_hangup tty_port_tty_wakeup
:identifiers: tty_port_tty_wakeup
Modem Signals
-------------

5
drivers/tty/tty_port.c
View File

@ -391,11 +391,6 @@ void tty_port_hangup(struct tty_port *port)
}
EXPORT_SYMBOL(tty_port_hangup);
/**
* tty_port_tty_hangup - helper to hang up a tty
* @port: tty port
* @check_clocal: hang only ttys with %CLOCAL unset?
*/
void __tty_port_tty_hangup(struct tty_port *port, bool check_clocal, bool async)
{
struct tty_struct *tty = tty_port_tty_get(port);

9
include/linux/tty_port.h
View File

@ -251,11 +251,20 @@ static inline int tty_port_users(struct tty_port *port)
return port->count + port->blocked_open;
}
/**
* tty_port_tty_hangup - helper to hang up a tty asynchronously
* @port: tty port
* @check_clocal: hang only ttys with %CLOCAL unset?
*/
static inline void tty_port_tty_hangup(struct tty_port *port, bool check_clocal)
{
__tty_port_tty_hangup(port, check_clocal, true);
}
/**
* tty_port_tty_vhangup - helper to hang up a tty synchronously
* @port: tty port
*/
static inline void tty_port_tty_vhangup(struct tty_port *port)
{
__tty_port_tty_hangup(port, false, false);