Skip to content

Commit 6241b49

Browse files
Jiri Slaby (SUSE)gregkh
authored andcommitted
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)" <[email protected]> Fixes: 2b5eac0 ("tty: introduce and use tty_port_tty_vhangup() helper") Link: https://lore.kernel.org/all/[email protected]/ Reported-by: Ilpo Järvinen <[email protected]> Cc: Jonathan Corbet <[email protected]> Cc: [email protected] Link: https://lore.kernel.org/r/[email protected] Signed-off-by: Greg Kroah-Hartman <[email protected]>
1 parent 543a5af commit 6241b49

File tree

3 files changed

+12
-7
lines changed

3 files changed

+12
-7
lines changed

Documentation/driver-api/tty/tty_port.rst

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,9 +42,10 @@ TTY Refcounting
4242
TTY Helpers
4343
-----------
4444

45+
.. kernel-doc:: include/linux/tty_port.h
46+
:identifiers: tty_port_tty_hangup tty_port_tty_vhangup
4547
.. kernel-doc:: drivers/tty/tty_port.c
46-
:identifiers: tty_port_tty_hangup tty_port_tty_wakeup
47-
48+
:identifiers: tty_port_tty_wakeup
4849

4950
Modem Signals
5051
-------------

drivers/tty/tty_port.c

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -391,11 +391,6 @@ void tty_port_hangup(struct tty_port *port)
391391
}
392392
EXPORT_SYMBOL(tty_port_hangup);
393393

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-
*/
399394
void __tty_port_tty_hangup(struct tty_port *port, bool check_clocal, bool async)
400395
{
401396
struct tty_struct *tty = tty_port_tty_get(port);

include/linux/tty_port.h

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -251,11 +251,20 @@ static inline int tty_port_users(struct tty_port *port)
251251
return port->count + port->blocked_open;
252252
}
253253

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+
*/
254259
static inline void tty_port_tty_hangup(struct tty_port *port, bool check_clocal)
255260
{
256261
__tty_port_tty_hangup(port, check_clocal, true);
257262
}
258263

264+
/**
265+
* tty_port_tty_vhangup - helper to hang up a tty synchronously
266+
* @port: tty port
267+
*/
259268
static inline void tty_port_tty_vhangup(struct tty_port *port)
260269
{
261270
__tty_port_tty_hangup(port, false, false);

0 commit comments

Comments
 (0)