[PATCH v2 5/5] tty: fix tty_port_tty_*hangup() kernel-doc

[PATCH v2 5/5] tty: fix tty_port_tty_*hangup() kernel-doc

[Jiri Slaby (SUSE)]

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

Re: [PATCH v2 5/5] tty: fix tty_port_tty_*hangup() kernel-doc

[Ilpo Järvinen]

[-- Attachment #1: Type: text/plain, Size: 2951 bytes --]

On Tue, 24 Jun 2025, Jiri Slaby (SUSE) wrote:

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

corresponding

With that fixed, Reviewed-by: Ilpo Järvinen <ilpo.jarvinen@linux.intel.com>

-- 
 i.


> 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);
>