linux-kernel - Re: [PATCH v2] i3c: Fix i3c_device_do_priv

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: <b429bfdd-a66d-46db-b13d-73e81d36ac8d@infradead.org>
Date: Sat, 19 Jul 2025 17:28:11 -0700
From: Randy Dunlap <rdunlap@...radead.org>
To: Bagas Sanjaya <bagasdotme@...il.com>,
 Linux Kernel Mailing List <linux-kernel@...r.kernel.org>,
 Linux i3c <linux-i3c@...ts.infradead.org>
Cc: Alexandre Belloni <alexandre.belloni@...tlin.com>,
 Frank Li <Frank.Li@....com>, Miquel Raynal <miquel.raynal@...tlin.com>
Subject: Re: [PATCH v2] i3c: Fix i3c_device_do_priv_xfers() kernel-doc
 indentation



On 7/1/25 9:04 PM, Bagas Sanjaya wrote:
> Sphinx reports indentation warning on i3c_device_do_priv_xfers() return
> value list:
> 
> Documentation/driver-api/i3c/device-driver-api:9: ./drivers/i3c/device.c:31: ERROR: Unexpected indentation. [docutils]
> 
> Format the list as bullet list to fix the warning.
> 
> Signed-off-by: Bagas Sanjaya <bagasdotme@...il.com>

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

Thanks.

> ---
> Changes since v1 [1]:
> 
>   * Follow kernel-doc style on return list
>   * Patch subject massage (Frank)
>   * Drop Fixes: tag (Frank)
> 
> [1]: https://lore.kernel.org/r/20250626042201.44594-1-bagasdotme@gmail.com/
> 
>  drivers/i3c/device.c | 11 ++++++-----
>  1 file changed, 6 insertions(+), 5 deletions(-)
> 
> diff --git a/drivers/i3c/device.c b/drivers/i3c/device.c
> index e80e4875691467..2396545763ff85 100644
> --- a/drivers/i3c/device.c
> +++ b/drivers/i3c/device.c
> @@ -26,11 +26,12 @@
>   *
>   * This function can sleep and thus cannot be called in atomic context.
>   *
> - * Return: 0 in case of success, a negative error core otherwise.
> - *	   -EAGAIN: controller lost address arbitration. Target
> - *		    (IBI, HJ or controller role request) win the bus. Client
> - *		    driver needs to resend the 'xfers' some time later.
> - *		    See I3C spec ver 1.1.1 09-Jun-2021. Section: 5.1.2.2.3.
> + * Return:
> + * * 0 in case of success, a negative error core otherwise.
> + * * -EAGAIN: controller lost address arbitration. Target (IBI, HJ or
> + *   controller role request) win the bus. Client driver needs to resend the
> + *   'xfers' some time later. See I3C spec ver 1.1.1 09-Jun-2021. Section:
> + *   5.1.2.2.3.

I would use %0 and %-EAGAIN here but that's just for pretty printing. :)

>   */
>  int i3c_device_do_priv_xfers(struct i3c_device *dev,
>  			     struct i3c_priv_xfer *xfers,

-- 
~Randy