Skip to contentSkip to conversation

usb: collapse USB_STORAGE Kconfig comment

PATCH Superseded David Disseldorp 2 participants 2 messages Nov 27, 2024

Subsystems (2)

v1 of 2 Superseded Latest is v2 →

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 usb: collapse USB_STORAGE Kconfig comment

The two Kconfig "comment" calls render in /proc/config.gz as split sections:
---
#
# NOTE: USB_STORAGE depends on SCSI but BLK_DEV_SD may #

#

 # also be needed; see USB_STORAGE Help for more info
 #
---

"make menuconfig" renders the comments as:
---
*** NOTE: USB_STORAGE depends on SCSI but BLK_DEV_SD may *** *** also be needed; see USB_STORAGE Help for more info ***
---

Kconfig doesn't support splitting a comment cleanly over two lines, so just collapse it into a single oversize comment.

Given the content of the comment, it might make more sense to change it to a '#' Kconfig source file comment, or drop it altogether.

---
 drivers/usb/storage/Kconfig | 3 +--
 1 file changed, 1 insertion(+), 2 deletions(-)
drivers/usb/storage/Kconfig +1 -2
index d17b60a644efb..4be1d617d63db 100644
@@ -3,8 +3,7 @@
 # USB Storage driver configuration
 #
 
-comment "NOTE: USB_STORAGE depends on SCSI but BLK_DEV_SD may"
-comment "also be needed; see USB_STORAGE Help for more info"
+comment "NOTE: USB_STORAGE depends on SCSI but BLK_DEV_SD may also be needed; see USB_STORAGE Help for more info"
 
 config USB_STORAGE
 	tristate "USB Mass Storage support"
Signature · 1 line
2.43.0
maintainer Acked-by on v1 1/1
#1 lore raw
Quoted 11 lines · David Disseldorp

The two Kconfig "comment" calls render in /proc/config.gz as split sections:
---
#
# NOTE: USB_STORAGE depends on SCSI but BLK_DEV_SD may #

#

 # also be needed; see USB_STORAGE Help for more info
 #
---

You'll need to rewrite this message; the "---" lines will confuse people's patch-handling tools.

Quoted 7 lines

"make menuconfig" renders the comments as:
---
*** NOTE: USB_STORAGE depends on SCSI but BLK_DEV_SD may *** *** also be needed; see USB_STORAGE Help for more info ***
---

Quoted 5 lines

Kconfig doesn't support splitting a comment cleanly over two lines, so just collapse it into a single oversize comment.

Given the content of the comment, it might make more sense to change it to a '#' Kconfig source file comment, or drop it altogether.

I think making it one long line is fine. When you resubmit, you can add:

Quoted 21 lines
---
 drivers/usb/storage/Kconfig | 3 +--
 1 file changed, 1 insertion(+), 2 deletions(-)
drivers/usb/storage/Kconfig +1 -2
index d17b60a644efb..4be1d617d63db 100644
@@ -3,8 +3,7 @@
 # USB Storage driver configuration
 #
 
-comment "NOTE: USB_STORAGE depends on SCSI but BLK_DEV_SD may"
-comment "also be needed; see USB_STORAGE Help for more info"
+comment "NOTE: USB_STORAGE depends on SCSI but BLK_DEV_SD may also be needed; see USB_STORAGE Help for more info"
 
 config USB_STORAGE
 	tristate "USB Mass Storage support"
Signature · 1 line
2.43.0

Alan Stern