linux-kernel - Re: [PATCH v2 1/1] docs: Fix kernel-doc indentation errors

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] [thread-next>] [day] [month] [year] [list]

Message-ID: <1b00e570-f51e-4768-a882-d03252d84534@infradead.org>
Date: Sun, 20 Jul 2025 12:03:19 -0700
From: Randy Dunlap <rdunlap@...radead.org>
To: Luis Felipe Hernandez <luis.hernandez093@...il.com>,
 Alexandre Belloni <alexandre.belloni@...tlin.com>,
 Marc Kleine-Budde <mkl@...gutronix.de>,
 Maarten Lankhorst <maarten.lankhorst@...ux.intel.com>,
 Bagas Sanjaya <bagasdotme@...il.com>
Cc: Pavel Pisa <pisa@....felk.cvut.cz>, Ondrej Ille <ondrej.ille@...il.com>,
 Vincent Mailhol <mailhol.vincent@...adoo.fr>, Frank Li <Frank.Li@....com>,
 Maxime Ripard <mripard@...nel.org>, Thomas Zimmermann <tzimmermann@...e.de>,
 David Airlie <airlied@...il.com>, Simona Vetter <simona@...ll.ch>,
 dri-devel@...ts.freedesktop.org, linux-i3c@...ts.infradead.org,
 linux-can@...r.kernel.org, linux-kernel@...r.kernel.org
Subject: Re: [PATCH v2 1/1] docs: Fix kernel-doc indentation errors

+ Bagas

On 7/20/25 8:24 AM, Luis Felipe Hernandez wrote:
> Fix kernel-doc issues that reported Unexpected indentation errors
> durring documentation build (make htmldocs) in CAN, I3C and GPU drivers.
> 
> Convert formatting to proper ReST list syntax to resolve warning.
> 
> Changes since v1:
> - Convert return value descriptions to proper ReST format
> - Fix code block introduction with :: syntax  
> - Add GPU driver fixes
> - Remove SCSI driver (already fixed)
> 
> Link: https://lore.kernel.org/all/20250703023511.82768-1-luis.hernandez093@gmail.com/
> 
> Signed-off-by: Luis Felipe Hernandez <luis.hernandez093@...il.com>
> ---
>  drivers/gpu/drm/drm_gpuvm.c              | 16 ++++++++--------

drm_gpuvm.c fixed by Bagas:

  https://lore.kernel.org/linux-doc/20250709024501.9105-1-bagasdotme@gmail.com/

Otherwise LGTM.

>  drivers/i3c/device.c                     | 13 ++++++++-----

i3c is also fixed by Bagas:
  https://lore.kernel.org/linux-i3c/20250702040424.18577-1-bagasdotme@gmail.com/

Otherwise LGTM.

>  drivers/net/can/ctucanfd/ctucanfd_base.c | 12 +++++++-----
>  3 files changed, 23 insertions(+), 18 deletions(-)
> 

> diff --git a/drivers/net/can/ctucanfd/ctucanfd_base.c b/drivers/net/can/ctucanfd/ctucanfd_base.c
> index bf6398772960..f910422188c3 100644
> --- a/drivers/net/can/ctucanfd/ctucanfd_base.c
> +++ b/drivers/net/can/ctucanfd/ctucanfd_base.c
> @@ -506,11 +506,13 @@ 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:
> + *
> + *   * TXT Buffer is not writable (it is in wrong state)
> + *   * Invalid TXT buffer index
> + *   * Invalid frame length
>   */
>  static bool ctucan_insert_frame(struct ctucan_priv *priv, const struct canfd_frame *cf, u8 buf,
>  				bool isfdf)

The numbered list is not a problem AFAIK. Did you see an issue with it?
And having the blank line just before the "False" list causing undesirable
html output:

Return

 * True - Frame inserted successfully

 * False - Frame was not inserted due to one of:

Description

 * TXT Buffer is not writable (it is in wrong state)

 * Invalid TXT buffer index

 * Invalid frame length

The "Description" line should not be there.

IMO all we want to do is convert the True and False lines into
a bulleted list and then the html output will look like this:

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


-- 
~Randy