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(-)
diff --git a/drivers/staging/rts5208/Kconfig b/drivers/staging/rts5208/Kconfig
index b864023d3ccb..4f9cc3f00e1a 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.
\ No newline at end of file
--
2.34.1
On 1/18/24 11:47 AM, Randy Dunlap wrote:
> Hi--
>
> On 1/18/24 08:09, 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]>
>> ---
>> 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..4f9cc3f00e1a 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
> Above line is indented with spaces. It should be on tab + 2 spaces.
>
>> + 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.
>
>> \ 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?
Hi--
On 1/18/24 08:09, 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]>
> ---
> 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..4f9cc3f00e1a 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
Above line is indented with spaces. It should be on tab + 2 spaces.
> + 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.
> \ No newline at end of file
Please add a newline at the end of the file.
thanks.
--
#Randy
On 1/18/24 08:50, Jacob Lott wrote:
>
> On 1/18/24 11:47 AM, Randy Dunlap wrote:
>> Hi--
>>
>> On 1/18/24 08:09, 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]>
>>> ---
>>> 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..4f9cc3f00e1a 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
>> Above line is indented with spaces. It should be on tab + 2 spaces.
>>
>>> + 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.
>>
>>> \ 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.
--
#Randy