| Message ID | 20250123080102.1632517-1-usmanakinyemi202@gmail.com (mailing list archive) |
|---|---|
| State | Superseded |
| Headers | show |
| Series | usb: dwc3: Fix documentation warning for sg member | expand |
On Thu, Jan 23, 2025 at 01:31:02PM +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. > > Signed-off-by: Usman Akinyemi <usmanakinyemi202@gmail.com> What commit id does this fix? And what about the reported-by: line? thanks, greg k-h
On Thu, Jan 23, 2025 at 7:37 PM Greg KH <gregkh@linuxfoundation.org> wrote: > > On Thu, Jan 23, 2025 at 01:31:02PM +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. > > > > Signed-off-by: Usman Akinyemi <usmanakinyemi202@gmail.com> > > What commit id does this fix? And what about the reported-by: line? > > thanks, > Hi Greg, Thanks for replying. I was applying to Linux Mentorship(LFX) for fixing the Linux Kernel Bugs. One of the tasks was to look for documentation warnings and I saw this. I created a patch for it and sent it also. So, it is not reported. I am not sure if I am missing something though. Thank you. Usman. > greg k-h
On Thu, Jan 23, 2025 at 07:47:18PM +0530, Usman Akinyemi wrote: > On Thu, Jan 23, 2025 at 7:37 PM Greg KH <gregkh@linuxfoundation.org> wrote: > > > > On Thu, Jan 23, 2025 at 01:31:02PM +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. > > > > > > Signed-off-by: Usman Akinyemi <usmanakinyemi202@gmail.com> > > > > What commit id does this fix? And what about the reported-by: line? > > > > thanks, > > > Hi Greg, > > Thanks for replying. > > I was applying to Linux Mentorship(LFX) for fixing the Linux Kernel Bugs. > One of the tasks was to look for documentation warnings and I saw this. > > I created a patch for it and sent it also. So, it is not reported. It was, you might have missed it on the mailing list: https://lore.kernel.org/r/20250120182219.30dcb3c6@canb.auug.org.au Also it still needs a "Fixes:" tag. thanks, greg k-h
On Thu, Jan 23, 2025 at 7:52 PM Greg KH <gregkh@linuxfoundation.org> wrote: > > On Thu, Jan 23, 2025 at 07:47:18PM +0530, Usman Akinyemi wrote: > > On Thu, Jan 23, 2025 at 7:37 PM Greg KH <gregkh@linuxfoundation.org> wrote: > > > > > > On Thu, Jan 23, 2025 at 01:31:02PM +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. > > > > > > > > Signed-off-by: Usman Akinyemi <usmanakinyemi202@gmail.com> > > > > > > What commit id does this fix? And what about the reported-by: line? > > > > > > thanks, > > > > > Hi Greg, > > > > Thanks for replying. > > > > I was applying to Linux Mentorship(LFX) for fixing the Linux Kernel Bugs. > > One of the tasks was to look for documentation warnings and I saw this. > > > > I created a patch for it and sent it also. So, it is not reported. > > It was, you might have missed it on the mailing list: > https://lore.kernel.org/r/20250120182219.30dcb3c6@canb.auug.org.au > > Also it still needs a "Fixes:" tag. > > thanks, Thanks for this, I am sorry, I did not know. I sent the updated version. I hope it fixes this. Thank you. > > greg k-h
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
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. Signed-off-by: Usman Akinyemi <usmanakinyemi202@gmail.com> --- drivers/usb/dwc3/core.h | 1 + 1 file changed, 1 insertion(+)