| Message ID | 20250204134423.28051-1-purvayeshi550@gmail.com (mailing list archive) |
|---|---|
| State | New |
| Headers | show |
| Series | usb: dwc3: Fix kernel-doc warning for sg member in | expand |
On Tue, Feb 04, 2025 at 07:14:23PM +0530, Purva Yeshi wrote: > Added description for the 'sg' member in struct dwc3_request to > resolve the kerneldoc warning when running 'make htmldocs'. > > Signed-off-by: Purva Yeshi <purvayeshi550@gmail.com> > --- > 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 f11570c8ffd0..5e4daec322b7 100644 > --- a/drivers/usb/dwc3/core.h > +++ b/drivers/usb/dwc3/core.h > @@ -942,6 +942,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 the scatter-gather list > * @start_sg: pointer to the sg which should be queued next > * @num_pending_sgs: counter to pending sgs > * @remaining: amount of data remaining > -- > 2.34.1 > What kernel version/tree did you make this change against? thanks, greg k-h
On 04/02/25 19:15, Greg KH wrote: > On Tue, Feb 04, 2025 at 07:14:23PM +0530, Purva Yeshi wrote: >> Added description for the 'sg' member in struct dwc3_request to >> resolve the kerneldoc warning when running 'make htmldocs'. >> >> Signed-off-by: Purva Yeshi <purvayeshi550@gmail.com> >> --- >> 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 f11570c8ffd0..5e4daec322b7 100644 >> --- a/drivers/usb/dwc3/core.h >> +++ b/drivers/usb/dwc3/core.h >> @@ -942,6 +942,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 the scatter-gather list >> * @start_sg: pointer to the sg which should be queued next >> * @num_pending_sgs: counter to pending sgs >> * @remaining: amount of data remaining >> -- >> 2.34.1 >> > > What kernel version/tree did you make this change against? > > thanks, > > greg k-h The change was made against kernel version 6.13.0-rc7+. Thanks, Purva Yeshi
On Wed, Feb 05, 2025 at 02:15:08AM +0530, Purva Yeshi wrote: > On 04/02/25 19:15, Greg KH wrote: > > On Tue, Feb 04, 2025 at 07:14:23PM +0530, Purva Yeshi wrote: > > > Added description for the 'sg' member in struct dwc3_request to > > > resolve the kerneldoc warning when running 'make htmldocs'. > > > > > > Signed-off-by: Purva Yeshi <purvayeshi550@gmail.com> > > > --- > > > 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 f11570c8ffd0..5e4daec322b7 100644 > > > --- a/drivers/usb/dwc3/core.h > > > +++ b/drivers/usb/dwc3/core.h > > > @@ -942,6 +942,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 the scatter-gather list > > > * @start_sg: pointer to the sg which should be queued next > > > * @num_pending_sgs: counter to pending sgs > > > * @remaining: amount of data remaining > > > -- > > > 2.34.1 > > > > > > > What kernel version/tree did you make this change against? > > > > thanks, > > > > greg k-h > > The change was made against kernel version 6.13.0-rc7+. Please always work against the latest development tree for the subsystem you are working on, OR against linux-next, so that you don't end up duplicating work that others have already done, like was done here. thanks, greg k-h
On 05/02/25 10:57, Greg KH wrote: > On Wed, Feb 05, 2025 at 02:15:08AM +0530, Purva Yeshi wrote: >> On 04/02/25 19:15, Greg KH wrote: >>> On Tue, Feb 04, 2025 at 07:14:23PM +0530, Purva Yeshi wrote: >>>> Added description for the 'sg' member in struct dwc3_request to >>>> resolve the kerneldoc warning when running 'make htmldocs'. >>>> >>>> Signed-off-by: Purva Yeshi <purvayeshi550@gmail.com> >>>> --- >>>> 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 f11570c8ffd0..5e4daec322b7 100644 >>>> --- a/drivers/usb/dwc3/core.h >>>> +++ b/drivers/usb/dwc3/core.h >>>> @@ -942,6 +942,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 the scatter-gather list >>>> * @start_sg: pointer to the sg which should be queued next >>>> * @num_pending_sgs: counter to pending sgs >>>> * @remaining: amount of data remaining >>>> -- >>>> 2.34.1 >>>> >>> >>> What kernel version/tree did you make this change against? >>> >>> thanks, >>> >>> greg k-h >> >> The change was made against kernel version 6.13.0-rc7+. > > Please always work against the latest development tree for the subsystem > you are working on, OR against linux-next, so that you don't end up > duplicating work that others have already done, like was done here. > > thanks, > > greg k-h Thanks for the feedback. I’ll use the latest development tree and make sure to work against the right one next time. Best regards, Purva Yeshi
diff --git a/drivers/usb/dwc3/core.h b/drivers/usb/dwc3/core.h index f11570c8ffd0..5e4daec322b7 100644 --- a/drivers/usb/dwc3/core.h +++ b/drivers/usb/dwc3/core.h @@ -942,6 +942,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 the scatter-gather list * @start_sg: pointer to the sg which should be queued next * @num_pending_sgs: counter to pending sgs * @remaining: amount of data remaining
Added description for the 'sg' member in struct dwc3_request to resolve the kerneldoc warning when running 'make htmldocs'. Signed-off-by: Purva Yeshi <purvayeshi550@gmail.com> --- drivers/usb/dwc3/core.h | 1 + 1 file changed, 1 insertion(+)