Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

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: 2b5eac0f8c6e ("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>

authored by

Jiri Slaby (SUSE) and committed by
Greg Kroah-Hartman
6241b495 543a5af3

+12 -7
+3 -2
Documentation/driver-api/tty/tty_port.rst
··· 42 42 TTY Helpers 43 43 ----------- 44 44 45 + .. kernel-doc:: include/linux/tty_port.h 46 + :identifiers: tty_port_tty_hangup tty_port_tty_vhangup 45 47 .. kernel-doc:: drivers/tty/tty_port.c 46 - :identifiers: tty_port_tty_hangup tty_port_tty_wakeup 47 - 48 + :identifiers: tty_port_tty_wakeup 48 49 49 50 Modem Signals 50 51 -------------
-5
drivers/tty/tty_port.c
··· 391 391 } 392 392 EXPORT_SYMBOL(tty_port_hangup); 393 393 394 - /** 395 - * tty_port_tty_hangup - helper to hang up a tty 396 - * @port: tty port 397 - * @check_clocal: hang only ttys with %CLOCAL unset? 398 - */ 399 394 void __tty_port_tty_hangup(struct tty_port *port, bool check_clocal, bool async) 400 395 { 401 396 struct tty_struct *tty = tty_port_tty_get(port);
+9
include/linux/tty_port.h
··· 251 251 return port->count + port->blocked_open; 252 252 } 253 253 254 + /** 255 + * tty_port_tty_hangup - helper to hang up a tty asynchronously 256 + * @port: tty port 257 + * @check_clocal: hang only ttys with %CLOCAL unset? 258 + */ 254 259 static inline void tty_port_tty_hangup(struct tty_port *port, bool check_clocal) 255 260 { 256 261 __tty_port_tty_hangup(port, check_clocal, true); 257 262 } 258 263 264 + /** 265 + * tty_port_tty_vhangup - helper to hang up a tty synchronously 266 + * @port: tty port 267 + */ 259 268 static inline void tty_port_tty_vhangup(struct tty_port *port) 260 269 { 261 270 __tty_port_tty_hangup(port, false, false);