mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
From: Jacob Lott <jklott.git@gmail.com>
To: Randy Dunlap <rdunlap@infradead.org>,
	gregkh@linuxfoundation.org, linux-staging@lists.linux.dev,
	linux-kernel@vger.kernel.org
Subject: Re: [PATCH v2] staging: rts5208: Add more details to Kconfig help
Date: Thu, 18 Jan 2024 11:50:38 -0500	[thread overview]
Message-ID: <5a60b50d-34f5-42a2-8112-f988b89f1e7f@gmail.com> (raw)
In-Reply-To: <3f4582ac-8180-417b-a83a-0b9f362cc5a0@infradead.org>


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 <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..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?

  reply	other threads:[~2024-01-18 16:50 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-01-18 16:09 Jacob Lott
2024-01-18 16:47 ` Randy Dunlap
2024-01-18 16:50   ` Jacob Lott [this message]
2024-01-18 16:51     ` Randy Dunlap

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=5a60b50d-34f5-42a2-8112-f988b89f1e7f@gmail.com \
    --to=jklott.git@gmail.com \
    --cc=gregkh@linuxfoundation.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-staging@lists.linux.dev \
    --cc=rdunlap@infradead.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox

all inboxes | Powered by JetHome®