Skip to contentSkip to conversation

i3c: Fix i3c_device_do_priv_xfers() return value list

PATCH In review Bagas Sanjaya 2 participants 3 messages Jun 26, 2025 I3C

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 i3c: Fix i3c_device_do_priv_xfers() return value list

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()")
---
 drivers/i3c/device.c | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)
drivers/i3c/device.c +5 -5
index e80e4875691467..205fa5066387c8 100644
@@ -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,
Signature · 1 line
An old man doll... just what I always wanted! - Clara
reviewer
#1 lore raw
Quoted 8 lines · Bagas Sanjaya

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

Quoted 29 lines
---
 drivers/i3c/device.c | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)
drivers/i3c/device.c +5 -6
index e80e4875691467..205fa5066387c8 100644
@@ -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

#2 lore raw
Quoted 4 lines · Frank Li
Quoted 3 lines · Bagas Sanjaya

Sphinx reports indentation warning on i3c_device_do_priv_xfers() return value list:

Quoted 8 lines
Quoted 5 lines

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.

Quoted 3 lines

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

Ack for the subject suggestion.

Thanks.

Signature · 1 line
An old man doll... just what I always wanted! - Clara