i3c: Fix i3c_device_do_priv_xfers() return value list

[PATCH] i3c: Fix i3c_device_do_priv_xfers() return value list

Posted by Bagas Sanjaya 5 months, 3 weeks ago

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.

Fixes: 0d2596508201 ("i3c: Add comment for -EAGAIN in i3c_device_do_priv_xfers()")
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
 drivers/i3c/device.c | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

diff --git a/drivers/i3c/device.c b/drivers/i3c/device.c
index e80e4875691467..205fa5066387c8 100644
--- a/drivers/i3c/device.c
+++ b/drivers/i3c/device.c
@@ -26,11 +26,11 @@
  *
  * 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

Re: [PATCH] i3c: Fix i3c_device_do_priv_xfers() return value list

Posted by Frank Li 5 months, 3 weeks ago

On Thu, Jun 26, 2025 at 11:22:01AM +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.
>
> Fixes: 0d2596508201 ("i3c: Add comment for -EAGAIN in i3c_device_do_priv_xfers()")

Needn't fixes tag here because it doesn't impact user.

subject:
i3c: fix kernel-doc indentation of i3c_device_do_priv_xfers()

Frank

> Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
> ---
>  drivers/i3c/device.c | 10 +++++-----
>  1 file changed, 5 insertions(+), 5 deletions(-)
>
> diff --git a/drivers/i3c/device.c b/drivers/i3c/device.c
> index e80e4875691467..205fa5066387c8 100644
> --- a/drivers/i3c/device.c
> +++ b/drivers/i3c/device.c
> @@ -26,11 +26,11 @@
>   *
>   * 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
>

Re: [PATCH] i3c: Fix i3c_device_do_priv_xfers() return value list

Posted by Bagas Sanjaya 5 months, 2 weeks ago

On 6/26/25 23:56, Frank Li wrote:
> On Thu, Jun 26, 2025 at 11:22:01AM +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.
>>
>> Fixes: 0d2596508201 ("i3c: Add comment for -EAGAIN in i3c_device_do_priv_xfers()")
> 
> Needn't fixes tag here because it doesn't impact user.
> 

I found the warning on docs-next tree, though.

> subject:
> i3c: fix kernel-doc indentation of i3c_device_do_priv_xfers()
> 

Ack for the subject suggestion.

Thanks.

-- 
An old man doll... just what I always wanted! - Clara