Skip to contentSkip to conversation

staging: rts5208: Add more details to Kconfig help

PATCH Superseded Jacob Lott 3 participants 4 messages Jan 18, 2024 Staging

lore
Share & tools
lore

Jacob Lott

author
#0 lore raw

PATCH v3 1/1 staging: rts5208: Add more details to Kconfig help

The current help text is short and triggers a warning from checkpatch.pl. This patch adds more details to the help text which should provide better information for whether or not to enable the driver.

---
 drivers/staging/rts5208/Kconfig | 10 +++++++---
 1 file changed, 7 insertions(+), 3 deletions(-)
drivers/staging/rts5208/Kconfig +7 -3
index b864023d3ccb..c4664a26ba3b 100644
@@ -3,7 +3,11 @@ config RTS5208
 	tristate "Realtek PCI-E Card Reader RTS5208/5288 support"
 	depends on PCI && SCSI
 	help
-	  Say Y here to include driver code to support the Realtek
-	  PCI-E card reader rts5208/rts5288.
+	  Choose Y here to enable support for the Realtek PCI-E card reader
+	  RTS5208/5288. This driver facilitates communication between the Linux
+	  kernel and the Realtek PCI-E card reader.
 
-	  If this driver is compiled as a module, it will be named rts5208.
+	  If you opt to compile this driver as a module, it will be named rts5208.
+	  Selecting N will exclude this driver from the kernel build. Choose option
+	  Y if your system includes the Realtek PCI-E card reader rts5208/rts5288.
+	  When in doubt, it is generally safe to select N.
Signature · 3 lines
2.34.1

v3 fixes the tab spacing for line 6 in Kconfig
maintainer
#1 lore raw
Quoted 33 lines · Jacob Lott

The current help text is short and triggers a warning from checkpatch.pl. This patch adds more details to the help text which should provide better information for whether or not to enable the driver.

---
 drivers/staging/rts5208/Kconfig | 10 +++++++---
 1 file changed, 7 insertions(+), 3 deletions(-)
drivers/staging/rts5208/Kconfig +7 -3
index b864023d3ccb..c4664a26ba3b 100644
@@ -3,7 +3,11 @@ config RTS5208
 	tristate "Realtek PCI-E Card Reader RTS5208/5288 support"
 	depends on PCI && SCSI
 	help
-	  Say Y here to include driver code to support the Realtek
-	  PCI-E card reader rts5208/rts5288.
+	  Choose Y here to enable support for the Realtek PCI-E card reader
+	  RTS5208/5288. This driver facilitates communication between the Linux
+	  kernel and the Realtek PCI-E card reader.
 
-	  If this driver is compiled as a module, it will be named rts5208.
+	  If you opt to compile this driver as a module, it will be named rts5208.
+	  Selecting N will exclude this driver from the kernel build. Choose option
+	  Y if your system includes the Realtek PCI-E card reader rts5208/rts5288.
+	  When in doubt, it is generally safe to select N.
Signature · 3 lines
2.34.1

v3 fixes the tab spacing for line 6 in Kconfig

Hi,

This is the friendly patch-bot of Greg Kroah-Hartman. You have sent him a patch that has triggered this response. He used to manually respond to these common problems, but in order to save his sanity (he kept writing the same thing over and over, yet to different people), I was created. Hopefully you will not take offence and will fix the problem in your patch and resubmit it so that it can be accepted into the Linux kernel tree.

You are receiving this message because of the following common error(s) as indicated below:

- This looks like a new version of a previously submitted patch, but you did not list below the --- line any changes from the previous version. Please read the section entitled "The canonical patch format" in the kernel file, Documentation/process/submitting-patches.rst for what needs to be done here to properly describe this.

If you wish to discuss this problem further, or you have questions about how to resolve this issue, please feel free to respond to this email and Greg will reply once he has dug out from the pending patches received from other developers.

thanks,

greg k-h's patch email bot

#2 lore raw
Quoted 46 lines · Greg KH
Quoted 33 lines · Jacob Lott

The current help text is short and triggers a warning from checkpatch.pl. This patch adds more details to the help text which should provide better information for whether or not to enable the driver.

---
 drivers/staging/rts5208/Kconfig | 10 +++++++---
 1 file changed, 7 insertions(+), 3 deletions(-)
drivers/staging/rts5208/Kconfig +7 -3
index b864023d3ccb..c4664a26ba3b 100644
@@ -3,7 +3,11 @@ config RTS5208
 	tristate "Realtek PCI-E Card Reader RTS5208/5288 support"
 	depends on PCI && SCSI
 	help
-	  Say Y here to include driver code to support the Realtek
-	  PCI-E card reader rts5208/rts5288.
+	  Choose Y here to enable support for the Realtek PCI-E card reader
+	  RTS5208/5288. This driver facilitates communication between the Linux
+	  kernel and the Realtek PCI-E card reader.
 
-	  If this driver is compiled as a module, it will be named rts5208.
+	  If you opt to compile this driver as a module, it will be named rts5208.
+	  Selecting N will exclude this driver from the kernel build. Choose option
+	  Y if your system includes the Realtek PCI-E card reader rts5208/rts5288.
+	  When in doubt, it is generally safe to select N.
Signature · 3 lines
2.34.1

v3 fixes the tab spacing for line 6 in Kconfig

Hi,

This is the friendly patch-bot of Greg Kroah-Hartman. You have sent him a patch that has triggered this response. He used to manually respond to these common problems, but in order to save his sanity (he kept writing the same thing over and over, yet to different people), I was created. Hopefully you will not take offence and will fix the problem in your patch and resubmit it so that it can be accepted into the Linux kernel tree.

Quoted 5 lines

You are receiving this message because of the following common error(s) as indicated below:

- This looks like a new version of a previously submitted patch, but you did not list below the --- line any changes from the previous version.

Jacob,
Immediately below the "---" line, not at the end of the patch.

Quoted 13 lines

Please read the section entitled "The canonical patch format" in the kernel file, Documentation/process/submitting-patches.rst for what needs to be done here to properly describe this.

If you wish to discuss this problem further, or you have questions about how to resolve this issue, please feel free to respond to this email and Greg will reply once he has dug out from the pending patches received from other developers.

thanks,

greg k-h's patch email bot

Signature · 1 line
#Randy
author
#3 lore raw
Quoted 47 lines · Randy Dunlap
Quoted 45 lines · Greg KH
Quoted 33 lines · Jacob Lott

The current help text is short and triggers a warning from checkpatch.pl. This patch adds more details to the help text which should provide better information for whether or not to enable the driver.

---
  drivers/staging/rts5208/Kconfig | 10 +++++++---
  1 file changed, 7 insertions(+), 3 deletions(-)
drivers/staging/rts5208/Kconfig +7 -3
index b864023d3ccb..c4664a26ba3b 100644
@@ -3,7 +3,11 @@ config RTS5208
  	tristate "Realtek PCI-E Card Reader RTS5208/5288 support"
  	depends on PCI && SCSI
  	help
-	  Say Y here to include driver code to support the Realtek
-	  PCI-E card reader rts5208/rts5288.
+	  Choose Y here to enable support for the Realtek PCI-E card reader
+	  RTS5208/5288. This driver facilitates communication between the Linux
+	  kernel and the Realtek PCI-E card reader.
 
-	  If this driver is compiled as a module, it will be named rts5208.
+	  If you opt to compile this driver as a module, it will be named rts5208.
+	  Selecting N will exclude this driver from the kernel build. Choose option
+	  Y if your system includes the Realtek PCI-E card reader rts5208/rts5288.
+	  When in doubt, it is generally safe to select N.
Signature · 3 lines
2.34.1

v3 fixes the tab spacing for line 6 in Kconfig

Hi,

This is the friendly patch-bot of Greg Kroah-Hartman. You have sent him a patch that has triggered this response. He used to manually respond to these common problems, but in order to save his sanity (he kept writing the same thing over and over, yet to different people), I was created. Hopefully you will not take offence and will fix the problem in your patch and resubmit it so that it can be accepted into the Linux kernel tree.

Quoted 22 lines
Quoted 5 lines

You are receiving this message because of the following common error(s) as indicated below:

- This looks like a new version of a previously submitted patch, but you did not list below the --- line any changes from the previous version.

Jacob,
Immediately below the "---" line, not at the end of the patch.

Quoted 13 lines

Please read the section entitled "The canonical patch format" in the kernel file, Documentation/process/submitting-patches.rst for what needs to be done here to properly describe this.

If you wish to discuss this problem further, or you have questions about how to resolve this issue, please feel free to respond to this email and Greg will reply once he has dug out from the pending patches received from other developers.

thanks,

greg k-h's patch email bot

Just sent a fixed version over. I appreciate the feedback and patience on this.