]> git.ipfire.org Git - thirdparty/kernel/linux.git/commitdiff
i3c: Fix i3c_device_do_priv_xfers() kernel-doc indentation
authorBagas Sanjaya <bagasdotme@gmail.com>
Wed, 2 Jul 2025 04:04:24 +0000 (11:04 +0700)
committerAlexandre Belloni <alexandre.belloni@bootlin.com>
Wed, 30 Jul 2025 23:23:12 +0000 (01:23 +0200)
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>
Reviewed-by: Frank Li <Frank.Li@nxp.com>
Link: https://lore.kernel.org/r/20250702040424.18577-1-bagasdotme@gmail.com
Signed-off-by: Alexandre Belloni <alexandre.belloni@bootlin.com>
drivers/i3c/device.c

index e80e4875691467cf2c898744b25c57b71ee82f91..2396545763ff853097d9f0173787e087f7a6e688 100644 (file)
  *
  * 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,