2024-01-18 19:16:45

by Jacob Lott

[permalink] [raw]
Subject: [PATCH v3] 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.

Signed-off-by: Jacob Lott <[email protected]>
---
v2 -> v3: Fixed spacing and newline in text
v1 -> v2: Corrected line spacing based off feedback

drivers/staging/rts5208/Kconfig | 10 +++++++---
1 file changed, 7 insertions(+), 3 deletions(-)

diff --git a/drivers/staging/rts5208/Kconfig b/drivers/staging/rts5208/Kconfig
index b864023d3ccb..c4664a26ba3b 100644
--- a/drivers/staging/rts5208/Kconfig
+++ b/drivers/staging/rts5208/Kconfig
@@ -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.
--
2.34.1

v3 fixes the tab spacing for line 6 in Kconfig


2024-01-19 05:56:55

by Greg Kroah-Hartman

[permalink] [raw]
Subject: Re: [PATCH v3] staging: rts5208: Add more details to Kconfig help

On Thu, Jan 18, 2024 at 02:14:26PM -0500, Jacob Lott wrote:
> 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]>
> ---
> v2 -> v3: Fixed spacing and newline in text
> v1 -> v2: Corrected line spacing based off feedback

I see multiple "v3" patches with this subject line, they can't all be
correct, right?

Please always increment the version and say what changed when you send a
new version, so please send v4.

thanks,

greg k-h