linux-kernel - Re: [PATCH v3] docs: Fix kernel-doc error in CAN driver

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Message-ID: <1faa5e2e-6b1b-4fea-9132-8a840357927f@infradead.org>
Date: Tue, 22 Jul 2025 12:22:36 -0700
From: Randy Dunlap <rdunlap@...radead.org>
To: Luis Felipe Hernandez <luis.hernandez093@...il.com>,
 Pavel Pisa <pisa@....felk.cvut.cz>, Marc Kleine-Budde <mkl@...gutronix.de>
Cc: Ondrej Ille <ondrej.ille@...il.com>,
 Vincent Mailhol <mailhol.vincent@...adoo.fr>, linux-can@...r.kernel.org,
 linux-kernel@...r.kernel.org
Subject: Re: [PATCH v3] docs: Fix kernel-doc error in CAN driver



On 7/21/25 8:53 PM, Luis Felipe Hernandez wrote:
> Fix kernel-doc formatting issue causing unexpected indentation error
> in ctucanfd driver documentation build. Convert main return values
> to bullet list format while preserving numbered sub-list in order to
> correct indentation error and visual structure in rendered html.
> 
> Signed-off-by: Luis Felipe Hernandez <luis.hernandez093@...il.com>
> 
> ---
> Changes since v2:
> - Focus only on CAN driver (GPU and I3C already fixed by Bagas Sanjaya)
> - Remove blank line that caused unwanted 'Description' output
> - Keep numbered sub-list format as suggested by Randy Dunlap
> - Move changelog after cutter as suggested by Vincent Mailhol
> 
> Link(v2): https://lore.kernel.org/all/20250720152401.70720-1-luis.hernandez093@gmail.com/
> Link(v1): https://lore.kernel.org/all/20250703023511.82768-1-luis.hernandez093@gmail.com/
> ---
>  drivers/net/can/ctucanfd/ctucanfd_base.c | 11 ++++++-----
>  1 file changed, 6 insertions(+), 5 deletions(-)
> 
> diff --git a/drivers/net/can/ctucanfd/ctucanfd_base.c b/drivers/net/can/ctucanfd/ctucanfd_base.c
> index bf6398772960..8bd3f0fc385c 100644
> --- a/drivers/net/can/ctucanfd/ctucanfd_base.c
> +++ b/drivers/net/can/ctucanfd/ctucanfd_base.c
> @@ -506,11 +506,12 @@ static bool ctucan_is_txt_buf_writable(struct ctucan_priv *priv, u8 buf)
>   * @buf:	TXT Buffer index to which frame is inserted (0-based)
>   * @isfdf:	True - CAN FD Frame, False - CAN 2.0 Frame
>   *
> - * Return: True - Frame inserted successfully
> - *	   False - Frame was not inserted due to one of:
> - *			1. TXT Buffer is not writable (it is in wrong state)
> - *			2. Invalid TXT buffer index
> - *			3. Invalid frame length
> + * Return:
> + * * True - Frame inserted successfully
> + * * False - Frame was not inserted due to one of:
> + *	1. TXT Buffer is not writable (it is in wrong state)
> + *	2. Invalid TXT buffer index
> + *	3. Invalid frame length
>   */
>  static bool ctucan_insert_frame(struct ctucan_priv *priv, const struct canfd_frame *cf, u8 buf,
>  				bool isfdf)

Looks good. Thanks for doing this.

Reviewed-by: Randy Dunlap <rdunlap@...radead.org>
Tested-by: Randy Dunlap <rdunlap@...radead.org>

-- 
~Randy