Documentation: rs485: Pull uart_get_rs485_mode() from serial_core.c

[PATCH] Documentation: rs485: Pull uart_get_rs485_mode() from serial_core.c

Posted by Karl Mehltretter 2 weeks, 6 days ago

serial-rs485.rst asks include/uapi/linux/serial.h for both struct
serial_rs485 and uart_get_rs485_mode(). The function and its kernel-doc
comment live in drivers/tty/serial/serial_core.c, so the directive has
never rendered it and the section shows only the structure.

Add a second directive for serial_core.c.

Fixes: 0f4648a1a6d3 ("Documentation: rs485: Mention uart_get_rs485_mode()")
Assisted-by: LLM
Signed-off-by: Karl Mehltretter <kmehltretter@gmail.com>
---
 Documentation/driver-api/serial/serial-rs485.rst | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

diff --git a/Documentation/driver-api/serial/serial-rs485.rst b/Documentation/driver-api/serial/serial-rs485.rst
index f53043d21071..98d8d83718c6 100644
--- a/Documentation/driver-api/serial/serial-rs485.rst
+++ b/Documentation/driver-api/serial/serial-rs485.rst
@@ -50,7 +50,10 @@ RS485 Serial Communications
    matching to the current configuration.
 
 .. kernel-doc:: include/uapi/linux/serial.h
-   :identifiers: serial_rs485 uart_get_rs485_mode
+   :identifiers: serial_rs485
+
+.. kernel-doc:: drivers/tty/serial/serial_core.c
+   :identifiers: uart_get_rs485_mode
 
 4. Usage from user-level
 ========================
-- 
2.53.0

Re: [PATCH] Documentation: rs485: Pull uart_get_rs485_mode() from serial_core.c

Posted by Jonathan Corbet 2 weeks, 4 days ago

Karl Mehltretter <kmehltretter@gmail.com> writes:

> serial-rs485.rst asks include/uapi/linux/serial.h for both struct
> serial_rs485 and uart_get_rs485_mode(). The function and its kernel-doc
> comment live in drivers/tty/serial/serial_core.c, so the directive has
> never rendered it and the section shows only the structure.
>
> Add a second directive for serial_core.c.
>
> Fixes: 0f4648a1a6d3 ("Documentation: rs485: Mention uart_get_rs485_mode()")
> Assisted-by: LLM
> Signed-off-by: Karl Mehltretter <kmehltretter@gmail.com>
> ---
>  Documentation/driver-api/serial/serial-rs485.rst | 5 ++++-
>  1 file changed, 4 insertions(+), 1 deletion(-)
>
> diff --git a/Documentation/driver-api/serial/serial-rs485.rst b/Documentation/driver-api/serial/serial-rs485.rst
> index f53043d21071..98d8d83718c6 100644
> --- a/Documentation/driver-api/serial/serial-rs485.rst
> +++ b/Documentation/driver-api/serial/serial-rs485.rst
> @@ -50,7 +50,10 @@ RS485 Serial Communications
>     matching to the current configuration.
>  
>  .. kernel-doc:: include/uapi/linux/serial.h
> -   :identifiers: serial_rs485 uart_get_rs485_mode
> +   :identifiers: serial_rs485
> +
> +.. kernel-doc:: drivers/tty/serial/serial_core.c
> +   :identifiers: uart_get_rs485_mode

Applied, thanks.

jon

Re: [PATCH] Documentation: rs485: Pull uart_get_rs485_mode() from serial_core.c

Posted by Randy Dunlap 2 weeks, 6 days ago


On 9/5/26 1:36 AM, Karl Mehltretter wrote:
> serial-rs485.rst asks include/uapi/linux/serial.h for both struct
> serial_rs485 and uart_get_rs485_mode(). The function and its kernel-doc
> comment live in drivers/tty/serial/serial_core.c, so the directive has
> never rendered it and the section shows only the structure.
> 
> Add a second directive for serial_core.c.
> 
> Fixes: 0f4648a1a6d3 ("Documentation: rs485: Mention uart_get_rs485_mode()")
> Assisted-by: LLM
> Signed-off-by: Karl Mehltretter <kmehltretter@gmail.com>

Acked-by: Randy Dunlap <rdunlap@infradead.org>
thanks.

> ---
>  Documentation/driver-api/serial/serial-rs485.rst | 5 ++++-
>  1 file changed, 4 insertions(+), 1 deletion(-)
> 
> diff --git a/Documentation/driver-api/serial/serial-rs485.rst b/Documentation/driver-api/serial/serial-rs485.rst
> index f53043d21071..98d8d83718c6 100644
> --- a/Documentation/driver-api/serial/serial-rs485.rst
> +++ b/Documentation/driver-api/serial/serial-rs485.rst
> @@ -50,7 +50,10 @@ RS485 Serial Communications
>     matching to the current configuration.
>  
>  .. kernel-doc:: include/uapi/linux/serial.h
> -   :identifiers: serial_rs485 uart_get_rs485_mode
> +   :identifiers: serial_rs485
> +
> +.. kernel-doc:: drivers/tty/serial/serial_core.c
> +   :identifiers: uart_get_rs485_mode
>  
>  4. Usage from user-level
>  ========================

-- 
~Randy