* Re: [PATCH v2] i3c: Fix i3c_device_do_priv_xfers() kernel-doc indentation
2025-07-02 4:04 [PATCH v2] i3c: Fix i3c_device_do_priv_xfers() kernel-doc indentation Bagas Sanjaya
@ 2025-07-14 22:47 ` Bagas Sanjaya
2025-07-15 13:57 ` Frank Li
` (2 subsequent siblings)
3 siblings, 0 replies; 5+ messages in thread
From: Bagas Sanjaya @ 2025-07-14 22:47 UTC (permalink / raw)
To: Linux Kernel Mailing List, Linux i3c
Cc: Alexandre Belloni, Frank Li, Miquel Raynal
[-- Attachment #1: Type: text/plain, Size: 353 bytes --]
On Wed, Jul 02, 2025 at 11:04:24AM +0700, 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.
review ping
[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 228 bytes --]
^ permalink raw reply [flat|nested] 5+ messages in thread* Re: [PATCH v2] i3c: Fix i3c_device_do_priv_xfers() kernel-doc indentation
2025-07-02 4:04 [PATCH v2] i3c: Fix i3c_device_do_priv_xfers() kernel-doc indentation Bagas Sanjaya
2025-07-14 22:47 ` Bagas Sanjaya
@ 2025-07-15 13:57 ` Frank Li
2025-07-20 0:28 ` Randy Dunlap
2025-07-30 23:40 ` Alexandre Belloni
3 siblings, 0 replies; 5+ messages in thread
From: Frank Li @ 2025-07-15 13:57 UTC (permalink / raw)
To: Bagas Sanjaya
Cc: Linux Kernel Mailing List, Linux i3c, Alexandre Belloni,
Miquel Raynal
On Wed, Jul 02, 2025 at 11:04:24AM +0700, 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@gmail.com>
> ---
Reviewed-by: Frank Li <Frank.Li@nxp.com>
> 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.
> */
> int i3c_device_do_priv_xfers(struct i3c_device *dev,
> struct i3c_priv_xfer *xfers,
> --
> An old man doll... just what I always wanted! - Clara
>
^ permalink raw reply [flat|nested] 5+ messages in thread
* Re: [PATCH v2] i3c: Fix i3c_device_do_priv_xfers() kernel-doc indentation
2025-07-02 4:04 [PATCH v2] i3c: Fix i3c_device_do_priv_xfers() kernel-doc indentation Bagas Sanjaya
2025-07-14 22:47 ` Bagas Sanjaya
2025-07-15 13:57 ` Frank Li
@ 2025-07-20 0:28 ` Randy Dunlap
2025-07-30 23:40 ` Alexandre Belloni
3 siblings, 0 replies; 5+ messages in thread
From: Randy Dunlap @ 2025-07-20 0:28 UTC (permalink / raw)
To: Bagas Sanjaya, Linux Kernel Mailing List, Linux i3c
Cc: Alexandre Belloni, Frank Li, Miquel Raynal
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@gmail.com>
Reviewed-by: Randy Dunlap <rdunlap@infradead.org>
Tested-by: Randy Dunlap <rdunlap@infradead.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
^ permalink raw reply [flat|nested] 5+ messages in thread
* Re: [PATCH v2] i3c: Fix i3c_device_do_priv_xfers() kernel-doc indentation
2025-07-02 4:04 [PATCH v2] i3c: Fix i3c_device_do_priv_xfers() kernel-doc indentation Bagas Sanjaya
` (2 preceding siblings ...)
2025-07-20 0:28 ` Randy Dunlap
@ 2025-07-30 23:40 ` Alexandre Belloni
3 siblings, 0 replies; 5+ messages in thread
From: Alexandre Belloni @ 2025-07-30 23:40 UTC (permalink / raw)
To: Linux Kernel Mailing List, Linux i3c, Bagas Sanjaya
Cc: Frank Li, Miquel Raynal
On Wed, 02 Jul 2025 11:04:24 +0700, 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.
>
> [...]
Applied, thanks!
[1/1] i3c: Fix i3c_device_do_priv_xfers() kernel-doc indentation
https://git.kernel.org/abelloni/c/ba12d5f11d52
Best regards,
--
Alexandre Belloni, co-owner and COO, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com
^ permalink raw reply [flat|nested] 5+ messages in thread