Commit 6241b495 authored by Jiri Slaby (SUSE)'s avatar Jiri Slaby (SUSE) Committed by Greg Kroah-Hartman
Browse files

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: default avatar"Jiri Slaby (SUSE)" <jirislaby@kernel.org>
Fixes: 2b5eac0f ("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: default avatarIlpo 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: default avatarGreg Kroah-Hartman <gregkh@linuxfoundation.org>
parent 543a5af3

Documentation/driver-api/tty/tty_port.rst

+3 −2
Original line number Diff line number Diff line
@@ -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

-------------

drivers/tty/tty_port.c

+0 −5
Original line number Diff line number Diff line
@@ -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);

include/linux/tty_port.h

+9 −0
Original line number Diff line number Diff line
@@ -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);