[PATCH v2] i3c: Fix i3c_device_do_priv_xfers() kernel-doc indentation
Frank Li
Frank.li at nxp.com
Tue Jul 15 06:57:36 PDT 2025
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 at gmail.com>
> ---
Reviewed-by: Frank Li <Frank.Li at 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
>
More information about the linux-i3c
mailing list