staging: rts5208: Add more details to Kconfig help
PATCH v2 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
@@ -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 · 1 line
2.34.1
Hi--
Quoted 15 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.
Signed-off-by Jacob Lott <[email protected]>--- drivers/staging/rts5208/Kconfig | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-)drivers/staging/rts5208/Kconfig +0
-0
drivers/staging/rts5208/Kconfig config RTS5208 · line 6
Quoted 6 lines
drivers/staging/rts5208/Kconfig +1
-2@@ -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
Above line is indented with spaces. It should be on tab + 2 spaces.
drivers/staging/rts5208/Kconfig config RTS5208 · line 13
Quoted 8 lines
drivers/staging/rts5208/Kconfig +6
-1+ 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.
That's not incorrect, but it is verbose IMO.
More than we usually say.
Quoted 1 line
\ No newline at end of file
Please add a newline at the end of the file.
thanks.
Signature · 1 line
#Randy
Quoted 37 lines · Randy Dunlap
Hi--
Quoted 15 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.
Signed-off-by Jacob Lott <[email protected]>--- drivers/staging/rts5208/Kconfig | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-)drivers/staging/rts5208/Kconfig +0
-0drivers/staging/rts5208/Kconfig config RTS5208 · line 6
Quoted 6 lines
drivers/staging/rts5208/Kconfig +1
-2@@ -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 readerAbove line is indented with spaces. It should be on tab + 2 spaces.
drivers/staging/rts5208/Kconfig config RTS5208 · line 13
Quoted 8 lines
drivers/staging/rts5208/Kconfig +6
-1+ 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.That's not incorrect, but it is verbose IMO.
More than we usually say.
Quoted 4 lines
Quoted 1 line
\ No newline at end of file
Please add a newline at the end of the file.
thanks.
In general is there an option/additional check I can run besides checkpatch.pl to catch issues with tabs, newlines, col width, etc?
Quoted 35 lines · Jacob Lott
Quoted 33 lines · Randy Dunlap
Hi--
Quoted 15 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.
Signed-off-by Jacob Lott <[email protected]>---
drivers/staging/rts5208/Kconfig| 10 +++++++---1 file changed, 7 insertions(+), 3 deletions(-)drivers/staging/rts5208/Kconfig +0
-0@@ -3,7 +3,11 @@ config RTS5208Quoted 6 lines
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 readerAbove line is indented with spaces. It should be on tab + 2 spaces.
Quoted 7 lines
+ 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.
Quoted 8 lines
Quoted 7 lines
That's not incorrect, but it is verbose IMO.
More than we usually say.Quoted 1 line
\ No newline at end of file
Please add a newline at the end of the file.
thanks.
In general is there an option/additional check I can run besides checkpatch.pl to catch issues with tabs, newlines, col width, etc?
Not that I know of.
Signature · 1 line
#Randy