Skip to contentSkip to conversation

usb: dwc3: fix kernel-doc string in struct dwc3_ep

PATCH In review Jakov Novak 2 participants 2 messages Jun 24 – Jun 26

Subsystems (2)
lore
Share & tools
lore
#0 lore raw

PATCH 1/1 usb: dwc3: fix kernel-doc string in struct dwc3_ep

Building the documentation currently with make htmldocs gives the following errors:

  WARNING: ./drivers/usb/dwc3/core.h:803 Excess struct member 'regs' description in 'dwc3_ep'
  WARNING: ./drivers/usb/dwc3/core.h:803 Excess struct member 'regs' description in 'dwc3_ep'

This is because the member variable regs of the struct dwc3_ep was removed in a previous patch. Remove regs from the kernel-doc string, fixing the warning.

Fixes abdd1eef04f0cb3b ("usb: dwc3: Remove of dep->regs")
---
 drivers/usb/dwc3/core.h | 1 -
 1 file changed, 1 deletion(-)
drivers/usb/dwc3/core.h +0 -1
index e0dee9d28740..034e8d7717e1 100644
@@ -722,7 +722,6 @@ struct dwc3_event_buffer {
  * @cancelled_list: list of cancelled requests for this endpoint
  * @pending_list: list of pending requests for this endpoint
  * @started_list: list of started requests on this endpoint
- * @regs: pointer to first endpoint register
  * @trb_pool: array of transaction buffers
  * @trb_pool_dma: dma address of @trb_pool
  * @trb_enqueue: enqueue 'pointer' into TRB array
Signature · 1 line
2.54.0
maintainer Acked-by on v1 1/1
#1 lore raw
Quoted 31 lines · Jakov Novak

Building the documentation currently with make htmldocs gives the following errors:

  WARNING: ./drivers/usb/dwc3/core.h:803 Excess struct member 'regs' description in 'dwc3_ep'
  WARNING: ./drivers/usb/dwc3/core.h:803 Excess struct member 'regs' description in 'dwc3_ep'

This is because the member variable regs of the struct dwc3_ep was removed in a previous patch. Remove regs from the kernel-doc string, fixing the warning.

Fixes abdd1eef04f0cb3b ("usb: dwc3: Remove of dep->regs")
---
 drivers/usb/dwc3/core.h | 1 -
 1 file changed, 1 deletion(-)
drivers/usb/dwc3/core.h +0 -1
index e0dee9d28740..034e8d7717e1 100644
@@ -722,7 +722,6 @@ struct dwc3_event_buffer {
  * @cancelled_list: list of cancelled requests for this endpoint
  * @pending_list: list of pending requests for this endpoint
  * @started_list: list of started requests on this endpoint
- * @regs: pointer to first endpoint register
  * @trb_pool: array of transaction buffers
  * @trb_pool_dma: dma address of @trb_pool
  * @trb_enqueue: enqueue 'pointer' into TRB array
Signature · 1 line
2.54.0

Thanks,
Thinh