* [PATCH v3] staging: rts5208: Add more details to Kconfig help
@ 2024-01-18 16:54 Jacob Lott
2024-01-18 17:53 ` Greg KH
0 siblings, 1 reply; 12+ messages in thread
From: Jacob Lott @ 2024-01-18 16:54 UTC (permalink / raw)
To: gregkh, linux-staging, linux-kernel; +Cc: 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 <jklott.git@gmail.com>
---
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
^ permalink raw reply related [flat|nested] 12+ messages in thread
* Re: [PATCH v3] staging: rts5208: Add more details to Kconfig help
2024-01-18 16:54 Jacob Lott
@ 2024-01-18 17:53 ` Greg KH
0 siblings, 0 replies; 12+ messages in thread
From: Greg KH @ 2024-01-18 17:53 UTC (permalink / raw)
To: Jacob Lott; +Cc: linux-staging, linux-kernel
On Thu, Jan 18, 2024 at 11:54:47AM -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 <jklott.git@gmail.com>
> ---
> 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
>
>
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
^ permalink raw reply [flat|nested] 12+ messages in thread
* [PATCH v3] staging: rts5208: Add more details to Kconfig help
@ 2024-01-18 17:59 Jacob Lott
2024-01-18 18:59 ` Greg KH
0 siblings, 1 reply; 12+ messages in thread
From: Jacob Lott @ 2024-01-18 17:59 UTC (permalink / raw)
To: gregkh, linux-staging, linux-kernel; +Cc: 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 <jklott.git@gmail.com>
---
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
^ permalink raw reply related [flat|nested] 12+ messages in thread
* Re: [PATCH v3] staging: rts5208: Add more details to Kconfig help
2024-01-18 17:59 Jacob Lott
@ 2024-01-18 18:59 ` Greg KH
2024-01-18 19:19 ` Randy Dunlap
0 siblings, 1 reply; 12+ messages in thread
From: Greg KH @ 2024-01-18 18:59 UTC (permalink / raw)
To: Jacob Lott; +Cc: linux-staging, linux-kernel
On Thu, Jan 18, 2024 at 12:59:48PM -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 <jklott.git@gmail.com>
> ---
> 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
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
^ permalink raw reply [flat|nested] 12+ messages in thread
* [PATCH v3] staging: rts5208: Add more details to Kconfig help
@ 2024-01-18 19:14 Jacob Lott
2024-01-19 5:56 ` Greg KH
0 siblings, 1 reply; 12+ messages in thread
From: Jacob Lott @ 2024-01-18 19:14 UTC (permalink / raw)
To: gregkh, linux-staging, linux-kernel; +Cc: 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 <jklott.git@gmail.com>
---
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
^ permalink raw reply related [flat|nested] 12+ messages in thread
* [PATCH v3] staging: rts5208: Add more details to Kconfig help
@ 2024-01-18 19:17 Jacob Lott
2024-01-19 6:34 ` Dan Carpenter
0 siblings, 1 reply; 12+ messages in thread
From: Jacob Lott @ 2024-01-18 19:17 UTC (permalink / raw)
To: gregkh, linux-staging, linux-kernel; +Cc: 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 <jklott.git@gmail.com>
---
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
^ permalink raw reply related [flat|nested] 12+ messages in thread
* Re: [PATCH v3] staging: rts5208: Add more details to Kconfig help
2024-01-18 18:59 ` Greg KH
@ 2024-01-18 19:19 ` Randy Dunlap
2024-01-18 19:21 ` Jacob Lott
0 siblings, 1 reply; 12+ messages in thread
From: Randy Dunlap @ 2024-01-18 19:19 UTC (permalink / raw)
To: Greg KH, Jacob Lott; +Cc: linux-staging, linux-kernel
On 1/18/24 10:59, Greg KH wrote:
> On Thu, Jan 18, 2024 at 12:59:48PM -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 <jklott.git@gmail.com>
>> ---
>> 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
>
>
> 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.
Jacob,
Immediately below the "---" line, not at the end of the patch.
> 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
>
--
#Randy
^ permalink raw reply [flat|nested] 12+ messages in thread
* Re: [PATCH v3] staging: rts5208: Add more details to Kconfig help
2024-01-18 19:19 ` Randy Dunlap
@ 2024-01-18 19:21 ` Jacob Lott
0 siblings, 0 replies; 12+ messages in thread
From: Jacob Lott @ 2024-01-18 19:21 UTC (permalink / raw)
To: Randy Dunlap, Greg KH; +Cc: linux-staging, linux-kernel
On 1/18/24 2:19 PM, Randy Dunlap wrote:
>
> On 1/18/24 10:59, Greg KH wrote:
>> On Thu, Jan 18, 2024 at 12:59:48PM -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 <jklott.git@gmail.com>
>>> ---
>>> 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
>>
>> 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.
> Jacob,
> Immediately below the "---" line, not at the end of the patch.
>
>
>> 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.
^ permalink raw reply [flat|nested] 12+ messages in thread
* Re: [PATCH v3] staging: rts5208: Add more details to Kconfig help
2024-01-18 19:14 Jacob Lott
@ 2024-01-19 5:56 ` Greg KH
0 siblings, 0 replies; 12+ messages in thread
From: Greg KH @ 2024-01-19 5:56 UTC (permalink / raw)
To: Jacob Lott; +Cc: linux-staging, linux-kernel
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 <jklott.git@gmail.com>
> ---
> 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
^ permalink raw reply [flat|nested] 12+ messages in thread
* Re: [PATCH v3] staging: rts5208: Add more details to Kconfig help
2024-01-18 19:17 [PATCH v3] staging: rts5208: Add more details to Kconfig help Jacob Lott
@ 2024-01-19 6:34 ` Dan Carpenter
2024-01-19 11:42 ` Jacob Lott
0 siblings, 1 reply; 12+ messages in thread
From: Dan Carpenter @ 2024-01-19 6:34 UTC (permalink / raw)
To: Jacob Lott; +Cc: gregkh, linux-staging, linux-kernel
On Thu, Jan 18, 2024 at 02:17:04PM -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 <jklott.git@gmail.com>
> ---
> v2 -> v3: Fixed spacing and newline in text
The commit message is still not line wrapped correctly at 72-75
characters. It should have been:
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.
Or:
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.
> 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.
In the original code there were three lines of help text.
1) Say Y here to include driver code to support the Realtek
2) PCI-E card reader rts5208/rts5288.
3) If this driver is compiled as a module, it will be named rts5208.
The minimum that checkpatch wants is 4 lines.
However, I feel like nothing you're adding here is useful information.
Some of it is just confusing like, "This driver facilitates
communication between the Linux kernel and the Realtek PCI-E card
reader." That line feels like information, but when you think about it,
it doesn't actually mean anything. The second paragraph is just
repeated information so it's kind of a waste of time.
Don't just obey checkpatch for the sake of obeying, if we can't think
of anything else useful to say then three lines is enough.
regards,
dan carpenter
^ permalink raw reply [flat|nested] 12+ messages in thread
* Re: [PATCH v3] staging: rts5208: Add more details to Kconfig help
2024-01-19 6:34 ` Dan Carpenter
@ 2024-01-19 11:42 ` Jacob Lott
2024-01-19 13:14 ` Dan Carpenter
0 siblings, 1 reply; 12+ messages in thread
From: Jacob Lott @ 2024-01-19 11:42 UTC (permalink / raw)
To: Dan Carpenter; +Cc: gregkh, linux-staging, linux-kernel
On 1/19/24 1:34 AM, Dan Carpenter wrote:
> On Thu, Jan 18, 2024 at 02:17:04PM -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 <jklott.git@gmail.com>
>> ---
>> v2 -> v3: Fixed spacing and newline in text
> The commit message is still not line wrapped correctly at 72-75
> characters. It should have been:
>
> 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.
>
> Or:
>
> 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.
>
>
>> 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.
>
> In the original code there were three lines of help text.
>
> 1) Say Y here to include driver code to support the Realtek
> 2) PCI-E card reader rts5208/rts5288.
> 3) If this driver is compiled as a module, it will be named rts5208.
>
> The minimum that checkpatch wants is 4 lines.
>
> However, I feel like nothing you're adding here is useful information.
> Some of it is just confusing like, "This driver facilitates
> communication between the Linux kernel and the Realtek PCI-E card
> reader." That line feels like information, but when you think about it,
> it doesn't actually mean anything. The second paragraph is just
> repeated information so it's kind of a waste of time.
>
> Don't just obey checkpatch for the sake of obeying, if we can't think
> of anything else useful to say then three lines is enough.
>
> regards,
> dan carpenter
>
Thank you for your feedback. Based off what Dan has said I would agree
that it is best to leave the information as is.
For the future when talking about line wrapping I've been going based
off VSCode's row/col count, is this not correct? For reference when
writing the commit I would use a new line before hitting 72 "col" on
each row. I ask for the future so I can make better commits.
^ permalink raw reply [flat|nested] 12+ messages in thread
* Re: [PATCH v3] staging: rts5208: Add more details to Kconfig help
2024-01-19 11:42 ` Jacob Lott
@ 2024-01-19 13:14 ` Dan Carpenter
0 siblings, 0 replies; 12+ messages in thread
From: Dan Carpenter @ 2024-01-19 13:14 UTC (permalink / raw)
To: Jacob Lott; +Cc: gregkh, linux-staging, linux-kernel
On Fri, Jan 19, 2024 at 06:42:57AM -0500, Jacob Lott wrote:
>
> For the future when talking about line wrapping I've been going based off
> VSCode's row/col count, is this not correct? For reference when writing the
> commit I would use a new line before hitting 72 "col" on each row. I ask for
> the future so I can make better commits.
I don't know anything about VSCode so I can't answer the question.
There aren't any tabs so really I can't imagine how VSCode could get the
col count wrong... (0_0)
regards,
dan carpenter
^ permalink raw reply [flat|nested] 12+ messages in thread
end of thread, other threads:[~2024-01-19 13:15 UTC | newest]
Thread overview: 12+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2024-01-18 19:17 [PATCH v3] staging: rts5208: Add more details to Kconfig help Jacob Lott
2024-01-19 6:34 ` Dan Carpenter
2024-01-19 11:42 ` Jacob Lott
2024-01-19 13:14 ` Dan Carpenter
-- strict thread matches above, loose matches on Subject: below --
2024-01-18 19:14 Jacob Lott
2024-01-19 5:56 ` Greg KH
2024-01-18 17:59 Jacob Lott
2024-01-18 18:59 ` Greg KH
2024-01-18 19:19 ` Randy Dunlap
2024-01-18 19:21 ` Jacob Lott
2024-01-18 16:54 Jacob Lott
2024-01-18 17:53 ` Greg KH
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox