Skip to contentSkip to conversation

i3c: Fix i3c_device_do_priv_xfers() kernel-doc indentation

PATCH Applied Bagas Sanjaya 4 participants 5 messages Jul 2, 2025 – Jul 30, 2025 I3C

lore
Share & tools
lore
#0 lore raw

PATCH v2 1/1 i3c: Fix i3c_device_do_priv_xfers() kernel-doc indentation

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.

---
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/[email protected]/

 drivers/i3c/device.c | 11 ++++++-----
 1 file changed, 6 insertions(+), 5 deletions(-)
drivers/i3c/device.c +6 -5
index e80e4875691467..2396545763ff85 100644
@@ -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,
Signature · 1 line
An old man doll... just what I always wanted! - Clara
#1 lore raw
Quoted 6 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.

review ping

reviewer Reviewed-by on v2 1/1
#2 lore raw
In reply to Bagas Sanjaya
Quoted 9 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.

---

Quoted 36 lines

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/[email protected]/

 drivers/i3c/device.c | 11 ++++++-----
 1 file changed, 6 insertions(+), 5 deletions(-)
drivers/i3c/device.c +6 -6
index e80e4875691467..2396545763ff85 100644
@@ -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

Reviewed-by Tested-by on v2 1/1
#3 lore raw
In reply to Bagas Sanjaya
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.

Thanks.

Quoted 21 lines

---
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/[email protected]/

 drivers/i3c/device.c | 11 ++++++-----
 1 file changed, 6 insertions(+), 5 deletions(-)
drivers/i3c/device.c +0 -1
index e80e4875691467..2396545763ff85 100644
@@ -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.

drivers/i3c/device.c line 34

Quoted 10 lines
drivers/i3c/device.c +6 -4
- *	   -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. :)

Quoted 3 lines
drivers/i3c/device.c +0 -0
  */
 int i3c_device_do_priv_xfers(struct i3c_device *dev,
 			     struct i3c_priv_xfer *xfers,
Signature · 1 line
~Randy
maintainer Applied
#4 lore raw
In reply to Bagas Sanjaya
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.

[...]

Applied, thanks!

[1/1] i3c: Fix i3c_device_do_priv_xfers() kernel-doc indentation

      https://git.kernel.org/abelloni/c/ba12d5f11d52

Best regards,

Signature · 3 lines
Alexandre Belloni, co-owner and COO, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com