diff mbox series

usb: collapse USB_STORAGE Kconfig comment

Message ID 20241127072644.3591-2-ddiss@suse.de (mailing list archive)
State Superseded
Headers show
Series usb: collapse USB_STORAGE Kconfig comment | expand

Commit Message

David Disseldorp Nov. 27, 2024, 7:26 a.m. UTC
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.

Signed-off-by: David Disseldorp <ddiss@suse.de>
---
 drivers/usb/storage/Kconfig | 3 +--
 1 file changed, 1 insertion(+), 2 deletions(-)

Comments

Alan Stern Nov. 27, 2024, 3:22 p.m. UTC | #1
On Wed, Nov 27, 2024 at 06:26:45PM +1100, David Disseldorp wrote:
> 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.

> 
> "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.

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

Acked-by: Alan Stern <stern@rowland.harvard.edu>

> Signed-off-by: David Disseldorp <ddiss@suse.de>
> ---
>  drivers/usb/storage/Kconfig | 3 +--
>  1 file changed, 1 insertion(+), 2 deletions(-)
> 
> diff --git a/drivers/usb/storage/Kconfig b/drivers/usb/storage/Kconfig
> index d17b60a644efb..4be1d617d63db 100644
> --- a/drivers/usb/storage/Kconfig
> +++ b/drivers/usb/storage/Kconfig
> @@ -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"
> -- 
> 2.43.0

Alan Stern
diff mbox series

Patch

diff --git a/drivers/usb/storage/Kconfig b/drivers/usb/storage/Kconfig
index d17b60a644efb..4be1d617d63db 100644
--- a/drivers/usb/storage/Kconfig
+++ b/drivers/usb/storage/Kconfig
@@ -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"