Skip to contentSkip to conversation

docs: fixing typo in the dwc3 struct

PATCH In review Vincenzo Palazzo 2 participants 2 messages Feb 20, 2023 – Feb 23, 2023

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

PATCH 1/1 docs: fixing typo in the dwc3 struct

This commit is fixing a typo inside the dwc3
struct that I found while I was understand how
the docs generation works.

Hope this will help.

---
 drivers/usb/dwc3/core.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
drivers/usb/dwc3/core.h +1 -1
index 8f9959ba9fd4..ac81d523710d 100644
@@ -1098,7 +1098,7 @@ struct dwc3_scratchpad_array {
  *			change quirk.
  * @dis_tx_ipgap_linecheck_quirk: set if we disable u2mac linestate
  *			check during HS transmit.
- * @resume-hs-terminations: Set if we enable quirk for fixing improper crc
+ * @resume_hs_terminations: Set if we enable quirk for fixing improper crc
  *			generation after resume from suspend.
  * @parkmode_disable_ss_quirk: set if we need to disable all SuperSpeed
  *			instances in park mode.
Signature · 1 line
2.39.2
maintainer
#1 lore raw

Hi Vincenzo,

Quoted 5 lines · Vincenzo Palazzo

This commit is fixing a typo inside the dwc3
struct that I found while I was understand how
the docs generation works.

Hope this will help.

Yes it does, but can you can omit that comment. You can review how to write a patch description here (see line wrap and "imperative mood" voice):

https://docs.kernel.org/process/submitting-patches.html

Quoted 22 lines
---
 drivers/usb/dwc3/core.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
drivers/usb/dwc3/core.h +1 -1
index 8f9959ba9fd4..ac81d523710d 100644
@@ -1098,7 +1098,7 @@ struct dwc3_scratchpad_array {
  *			change quirk.
  * @dis_tx_ipgap_linecheck_quirk: set if we disable u2mac linestate
  *			check during HS transmit.
- * @resume-hs-terminations: Set if we enable quirk for fixing improper crc
+ * @resume_hs_terminations: Set if we enable quirk for fixing improper crc
  *			generation after resume from suspend.
  * @parkmode_disable_ss_quirk: set if we need to disable all SuperSpeed
  *			instances in park mode.
Signature · 1 line
2.39.2

Can you add me (current maintainer of dwc3) to Cc list for changes related to dwc3?

Also, can you revise your $subject patch with "usb: dwc3:" prefix.

Thanks,
Thinh