From: Thinh Nguyen <Thinh.Nguyen@synopsys.com>
To: Shuping Bu <bushuping007@163.com>
Cc: Thinh Nguyen <Thinh.Nguyen@synopsys.com>,
"GregKH@linuxfoundation.org" <GregKH@linuxfoundation.org>,
"linux-usb@vger.kernel.org" <linux-usb@vger.kernel.org>
Subject: Re: [PATCH] usb: dwc3: core: Fix incorrect kernel-doc comment for dwc3_alloc_event_buffers
Date: Thu, 21 May 2026 23:22:01 +0000 [thread overview]
Message-ID: <ag-RxMdNGtPLD8i_@vbox> (raw)
In-Reply-To: <20260520055023.2415635-1-bushuping007@163.com>
On Wed, May 20, 2026, Shuping Bu wrote:
> The kernel-doc comment for dwc3_alloc_event_buffers states that the
> function "Allocates @num event buffers", but the function does not have
> a @num parameter and only allocates a single event buffer.
>
> Remove the misleading "@num" reference from the brief description to
> accurately reflect the function's behavior.
>
> Signed-off-by: Shuping Bu <bushuping007@163.com>
> ---
> drivers/usb/dwc3/core.c | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/drivers/usb/dwc3/core.c b/drivers/usb/dwc3/core.c
> index 65213896de99..a2587f9f0bb8 100644
> --- a/drivers/usb/dwc3/core.c
> +++ b/drivers/usb/dwc3/core.c
> @@ -525,7 +525,7 @@ static void dwc3_free_event_buffers(struct dwc3 *dwc)
> }
>
> /**
> - * dwc3_alloc_event_buffers - Allocates @num event buffers of size @length
> + * dwc3_alloc_event_buffers - Allocate one event buffer of size @length
> * @dwc: pointer to our controller context structure
> * @length: size of event buffer
> *
> --
> 2.25.1
>
Please also include the Fixes tag. It can probably go back as far as
here:
Fixes: 9f622b2a407d ("usb: dwc3: calculate number of event buffers dynamically")
This patch doesn't need to go to stable. After adding the tag above and
resubmit, you can include my Acked-by tag:
Acked-by: Thinh Nguyen <Thinh.Nguyen@synopsys.com>
Thanks,
Thinh
prev parent reply other threads:[~2026-05-21 23:22 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-05-20 5:50 [PATCH] usb: dwc3: core: Fix incorrect kernel-doc comment for dwc3_alloc_event_buffers Shuping Bu
2026-05-21 23:22 ` Thinh Nguyen [this message]
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=ag-RxMdNGtPLD8i_@vbox \
--to=thinh.nguyen@synopsys.com \
--cc=GregKH@linuxfoundation.org \
--cc=bushuping007@163.com \
--cc=linux-usb@vger.kernel.org \
/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