From: "Jiri Slaby (SUSE)" <jirislaby@kernel.org>
To: gregkh@linuxfoundation.org
Cc: linux-serial@vger.kernel.org, linux-kernel@vger.kernel.org,
"Jiri Slaby (SUSE)" <jirislaby@kernel.org>,
"Ilpo Järvinen" <ilpo.jarvinen@linux.intel.com>,
"Jonathan Corbet" <corbet@lwn.net>,
linux-doc@vger.kernel.org
Subject: [PATCH v2 5/5] tty: fix tty_port_tty_*hangup() kernel-doc
Date: Tue, 24 Jun 2025 10:06:41 +0200 [thread overview]
Message-ID: <20250624080641.509959-6-jirislaby@kernel.org> (raw)
In-Reply-To: <20250624080641.509959-1-jirislaby@kernel.org>
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
---
Documentation/driver-api/tty/tty_port.rst | 5 +++--
drivers/tty/tty_port.c | 5 -----
include/linux/tty_port.h | 9 +++++++++
3 files changed, 12 insertions(+), 7 deletions(-)
diff --git a/Documentation/driver-api/tty/tty_port.rst b/Documentation/driver-api/tty/tty_port.rst
index 5cb90e954fcf..504a353f2682 100644
--- a/Documentation/driver-api/tty/tty_port.rst
+++ b/Documentation/driver-api/tty/tty_port.rst
@@ -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
-------------
diff --git a/drivers/tty/tty_port.c b/drivers/tty/tty_port.c
index 903eebdbe12d..5b4d5fb99a59 100644
--- a/drivers/tty/tty_port.c
+++ b/drivers/tty/tty_port.c
@@ -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);
diff --git a/include/linux/tty_port.h b/include/linux/tty_port.h
index 021f9a8415c0..332ddb93603e 100644
--- a/include/linux/tty_port.h
+++ b/include/linux/tty_port.h
@@ -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);
--
2.50.0
next prev parent reply other threads:[~2025-06-24 8:06 UTC|newest]
Thread overview: 16+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-06-24 8:06 [PATCH v2 0/5] tty: fixes on top of summer cleanup Jiri Slaby (SUSE)
2025-06-24 8:06 ` [PATCH v2 1/5] serial: 8250: extract serial8250_init_mctrl() Jiri Slaby (SUSE)
2025-06-24 11:02 ` Ilpo Järvinen
2025-06-24 11:15 ` Ilpo Järvinen
2025-06-25 5:59 ` Jiri Slaby
2025-06-24 14:10 ` Andy Shevchenko
2025-06-24 8:06 ` [PATCH v2 2/5] serial: 8250: extract serial8250_iir_txen_test() Jiri Slaby (SUSE)
2025-06-24 11:05 ` Ilpo Järvinen
2025-06-24 14:11 ` Andy Shevchenko
2025-06-24 8:06 ` [PATCH v2 3/5] serial: 8250: rename lsr_TEMT, iir_NOINT to lowercase Jiri Slaby (SUSE)
2025-06-24 11:15 ` Ilpo Järvinen
2025-06-24 14:12 ` Andy Shevchenko
2025-06-24 8:06 ` [PATCH v2 4/5] serial: 8250: document doubled "type == PORT_8250_CIR" check Jiri Slaby (SUSE)
2025-06-24 11:16 ` Ilpo Järvinen
2025-06-24 8:06 ` Jiri Slaby (SUSE) [this message]
2025-06-24 11:00 ` [PATCH v2 5/5] tty: fix tty_port_tty_*hangup() kernel-doc Ilpo Järvinen
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20250624080641.509959-6-jirislaby@kernel.org \
--to=jirislaby@kernel.org \
--cc=corbet@lwn.net \
--cc=gregkh@linuxfoundation.org \
--cc=ilpo.jarvinen@linux.intel.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-serial@vger.kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox