Re: [PATCH v2] usb: dwc3: Fix documentation warning for sg member

From: Greg KH
Date: Thu Jan 23 2025 - 10:38:51 EST


On Thu, Jan 23, 2025 at 08:43:35PM +0530, Usman Akinyemi wrote:
> The 'sg' member in struct dwc3_request was undocumented, causing a
> documentation warning when building the kernel docs.
>
> This patch adds a description for the 'sg' field, resolving the warning.
>
> Fixes: 61440628a4ff ("usb: dwc3: gadget: Cleanup SG handling")
> Reported-by: Stephen Rothwell <sfr@xxxxxxxxxxxxxxxx>
> Signed-off-by: Usman Akinyemi <usmanakinyemi202@xxxxxxxxx>
> ---
> drivers/usb/dwc3/core.h | 1 +
> 1 file changed, 1 insertion(+)
>
> diff --git a/drivers/usb/dwc3/core.h b/drivers/usb/dwc3/core.h
> index ee73789326bc..0c417a12e6f4 100644
> --- a/drivers/usb/dwc3/core.h
> +++ b/drivers/usb/dwc3/core.h
> @@ -941,6 +941,7 @@ struct dwc3_hwparams {
> * @request: struct usb_request to be transferred
> * @list: a list_head used for request queueing
> * @dep: struct dwc3_ep owning this request
> + * @sg: pointer to a scatterlist for DMA operations
> * @start_sg: pointer to the sg which should be queued next
> * @num_pending_sgs: counter to pending sgs
> * @remaining: amount of data remaining
> --
> 2.48.0

Wait, what kernel is this based on? This structure does not have the
@sg field in it anymore in linux-next, so why is this warning still
showing up?

confused,

greg k-h