From: Frank Li <Frank.li@nxp.com>
To: Bagas Sanjaya <bagasdotme@gmail.com>
Cc: Linux Kernel Mailing List <linux-kernel@vger.kernel.org>,
Linux i3c <linux-i3c@lists.infradead.org>,
Alexandre Belloni <alexandre.belloni@bootlin.com>,
Miquel Raynal <miquel.raynal@bootlin.com>
Subject: Re: [PATCH v2] i3c: Fix i3c_device_do_priv_xfers() kernel-doc indentation
Date: Tue, 15 Jul 2025 09:57:36 -0400 [thread overview]
Message-ID: <aHZeUNfoU89Il985@lizhi-Precision-Tower-5810> (raw)
In-Reply-To: <20250702040424.18577-1-bagasdotme@gmail.com>
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@gmail.com>
> ---
Reviewed-by: Frank Li <Frank.Li@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
>
--
linux-i3c mailing list
linux-i3c@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/linux-i3c
next prev parent reply other threads:[~2025-07-15 15:27 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-07-02 4:04 [PATCH v2] i3c: Fix i3c_device_do_priv_xfers() kernel-doc indentation Bagas Sanjaya
2025-07-14 22:47 ` Bagas Sanjaya
2025-07-15 13:57 ` Frank Li [this message]
2025-07-20 0:28 ` Randy Dunlap
2025-07-30 23:40 ` Alexandre Belloni
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=aHZeUNfoU89Il985@lizhi-Precision-Tower-5810 \
--to=frank.li@nxp.com \
--cc=alexandre.belloni@bootlin.com \
--cc=bagasdotme@gmail.com \
--cc=linux-i3c@lists.infradead.org \
--cc=linux-kernel@vger.kernel.org \
--cc=miquel.raynal@bootlin.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox