Received-SPF: pass (google.com: domain of linux-kernel+bounces-30371-linux.lists.archive=gmail.com@vger.kernel.org designates 139.178.88.99 as permitted sender) client-ip=139.178.88.99;
Message-ID: <954506be-2c8a-443a-8cc3-db0fcad9539f@infradead.org>
Date: Thu, 18 Jan 2024 08:51:52 -0800
Precedence: bulk
MIME-Version: 1.0
User-Agent: Mozilla Thunderbird
Subject: Re: [PATCH v2] staging: rts5208: Add more details to Kconfig help
Content-Language: en-US
To: Jacob Lott <jklott.git@gmail.com>, gregkh@linuxfoundation.org,
 linux-staging@lists.linux.dev, linux-kernel@vger.kernel.org
References: <20240118160901.71756-1-jklott.git@gmail.com>
 <3f4582ac-8180-417b-a83a-0b9f362cc5a0@infradead.org>
 <5a60b50d-34f5-42a2-8112-f988b89f1e7f@gmail.com>
From: Randy Dunlap <rdunlap@infradead.org>
In-Reply-To: <5a60b50d-34f5-42a2-8112-f988b89f1e7f@gmail.com>
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit


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

Not that I know of.

-- 
#Randy