[PATCH] scsi: ufs: clean up the Kconfig file

[PATCH] scsi: ufs: clean up the Kconfig file

[Randy Dunlap]

Fix multiple problems of punctuation, grammar, and spacing in the
UFS Kconfig file.
Also remove the line that says that this code is based on itself.

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Alim Akhtar <alim.akhtar@samsung.com>
Cc: Avri Altman <avri.altman@wdc.com>
Cc: linux-scsi@vger.kernel.org
Cc: "James E.J. Bottomley" <jejb@linux.ibm.com>
Cc: "Martin K. Petersen" <martin.petersen@oracle.com>
---
 drivers/scsi/ufs/Kconfig |   33 ++++++++++++++++-----------------
 1 file changed, 16 insertions(+), 17 deletions(-)

--- linux-next-20211022.orig/drivers/scsi/ufs/Kconfig
+++ linux-next-20211022/drivers/scsi/ufs/Kconfig
@@ -1,7 +1,6 @@
 #
 # Kernel configuration file for the UFS Host Controller
 #
-# This code is based on drivers/scsi/ufs/Kconfig
 # Copyright (C) 2011-2013 Samsung India Software Operations
 #
 # Authors:
@@ -39,7 +38,7 @@ config SCSI_UFSHCD
 	select DEVFREQ_GOV_SIMPLE_ONDEMAND
 	select NLS
 	help
-	  This selects the support for UFS devices in Linux, say Y and make
+	  This selects the support for UFS devices in Linux. Say Y and make
 	  sure that you know the name of your UFS host adapter (the card
 	  inside your computer that "speaks" the UFS protocol, also
 	  called UFS Host Controller), because you will be asked for it.
@@ -51,7 +50,7 @@ config SCSI_UFSHCD
 	  (the one containing the directory /) is located on a UFS device.
 
 config SCSI_UFSHCD_PCI
-	tristate "PCI bus based UFS Controller support"
+	tristate "PCI bus-based UFS Controller support"
 	depends on SCSI_UFSHCD && PCI
 	help
 	  This selects the PCI UFS Host Controller Interface. Select this if
@@ -70,12 +69,12 @@ config SCSI_UFS_DWC_TC_PCI
 	  If unsure, say N.
 
 config SCSI_UFSHCD_PLATFORM
-	tristate "Platform bus based UFS Controller support"
+	tristate "Platform bus-based UFS Controller support"
 	depends on SCSI_UFSHCD
 	depends on HAS_IOMEM
 	help
 	  This selects the UFS host controller support. Select this if
-	  you have an UFS controller on Platform bus.
+	  you have a UFS controller on Platform bus.
 
 	  If you have a controller with this interface, say Y or M here.
 
@@ -103,23 +102,23 @@ config SCSI_UFS_QCOM
 	select QCOM_SCM if SCSI_UFS_CRYPTO
 	select RESET_CONTROLLER
 	help
-	  This selects the QCOM specific additions to UFSHCD platform driver.
-	  UFS host on QCOM needs some vendor specific configuration before
-	  accessing the hardware which includes PHY configuration and vendor
+	  This selects the QCOM-specific additions to UFSHCD platform driver.
+	  UFS host on QCOM needs some vendor-specific configuration before
+	  accessing the hardware which includes PHY configuration and vendor-
 	  specific registers.
 
 	  Select this if you have UFS controller on QCOM chipset.
 	  If unsure, say N.
 
 config SCSI_UFS_MEDIATEK
-	tristate "Mediatek specific hooks to UFS controller platform driver"
+	tristate "Mediatek-specific hooks to UFS controller platform driver"
 	depends on SCSI_UFSHCD_PLATFORM && ARCH_MEDIATEK
 	select PHY_MTK_UFS
 	select RESET_TI_SYSCON
 	help
-	  This selects the Mediatek specific additions to UFSHCD platform driver.
-	  UFS host on Mediatek needs some vendor specific configuration before
-	  accessing the hardware which includes PHY configuration and vendor
+	  This selects the Mediatek-specific additions to UFSHCD platform driver.
+	  UFS host on Mediatek needs some vendor-specific configuration before
+	  accessing the hardware which includes PHY configuration and vendor-
 	  specific registers.
 
 	  Select this if you have UFS controller on Mediatek chipset.
@@ -127,10 +126,10 @@ config SCSI_UFS_MEDIATEK
 	  If unsure, say N.
 
 config SCSI_UFS_HISI
-	tristate "Hisilicon specific hooks to UFS controller platform driver"
+	tristate "Hisilicon-specific hooks to UFS controller platform driver"
 	depends on (ARCH_HISI || COMPILE_TEST) && SCSI_UFSHCD_PLATFORM
 	help
-	  This selects the Hisilicon specific additions to UFSHCD platform driver.
+	  This selects the Hisilicon-specific additions to UFSHCD platform driver.
 
 	  Select this if you have UFS controller on Hisilicon chipset.
 	  If unsure, say N.
@@ -165,10 +164,10 @@ config SCSI_UFS_BSG
 	  If unsure, say N.
 
 config SCSI_UFS_EXYNOS
-	tristate "Exynos specific hooks to UFS controller platform driver"
+	tristate "Exynos-specific hooks to UFS controller platform driver"
 	depends on SCSI_UFSHCD_PLATFORM && (ARCH_EXYNOS || COMPILE_TEST)
 	help
-	  This selects the Samsung Exynos SoC specific additions to UFSHCD
+	  This selects the Samsung Exynos SoC-specific additions to UFSHCD
 	  platform driver.  UFS host on Samsung Exynos SoC includes HCI and
 	  UNIPRO layer, and associates with UFS-PHY driver.
 
@@ -201,7 +200,7 @@ config SCSI_UFS_FAULT_INJECTION
 	  to test the UFS error handler and abort handler.
 
 config SCSI_UFS_HWMON
-	bool "UFS  Temperature Notification"
+	bool "UFS Temperature Notification"
 	depends on SCSI_UFSHCD=HWMON || HWMON=y
 	help
 	  This provides support for UFS hardware monitoring. If enabled,

Re: [PATCH] scsi: ufs: clean up the Kconfig file

[Bart Van Assche]

On 10/23/21 23:43, Randy Dunlap wrote:
> @@ -39,7 +38,7 @@ config SCSI_UFSHCD
>   	select DEVFREQ_GOV_SIMPLE_ONDEMAND
>   	select NLS
>   	help
> -	  This selects the support for UFS devices in Linux, say Y and make
> +	  This selects the support for UFS devices in Linux. Say Y and make

How about changing "This selects the support for UFS devices in Linux"
into "Enables support for UFS devices"? "the" should be left out from a
grammatical point of view and "in Linux" is redundant.

>   	  sure that you know the name of your UFS host adapter (the card
>   	  inside your computer that "speaks" the UFS protocol, also
>   	  called UFS Host Controller), because you will be asked for it.
> @@ -51,7 +50,7 @@ config SCSI_UFSHCD
>   	  (the one containing the directory /) is located on a UFS device.
>   
>   config SCSI_UFSHCD_PCI
> -	tristate "PCI bus based UFS Controller support"
> +	tristate "PCI bus-based UFS Controller support"

Even with this change applied capitalization is inconsistent.

Thanks,

Bart.

Re: [PATCH] scsi: ufs: clean up the Kconfig file

[Randy Dunlap]

On 10/24/21 2:29 PM, Bart Van Assche wrote:
> On 10/23/21 23:43, Randy Dunlap wrote:
>> @@ -39,7 +38,7 @@ config SCSI_UFSHCD
>>       select DEVFREQ_GOV_SIMPLE_ONDEMAND
>>       select NLS
>>       help
>> -      This selects the support for UFS devices in Linux, say Y and make
>> +      This selects the support for UFS devices in Linux. Say Y and make
> 
> How about changing "This selects the support for UFS devices in Linux"
> into "Enables support for UFS devices"? "the" should be left out from a
> grammatical point of view and "in Linux" is redundant.

OK, done (locally).

>>         sure that you know the name of your UFS host adapter (the card
>>         inside your computer that "speaks" the UFS protocol, also
>>         called UFS Host Controller), because you will be asked for it.
>> @@ -51,7 +50,7 @@ config SCSI_UFSHCD
>>         (the one containing the directory /) is located on a UFS device.
>>   config SCSI_UFSHCD_PCI
>> -    tristate "PCI bus based UFS Controller support"
>> +    tristate "PCI bus-based UFS Controller support"
> 
> Even with this change applied capitalization is inconsistent.

I don't doubt it, but could you be more explicit about
which word(s) you mean, please?

I see one "pci" in the Kconfig file.
I see several "Controller" vs. "controller."
I see a few of "Support" vs. "support."

Which are you referring to? (or something else)

thanks.
-- 
~Randy

Re: [PATCH] scsi: ufs: clean up the Kconfig file

[Bart Van Assche]

On 10/24/21 16:35, Randy Dunlap wrote:
> On 10/24/21 2:29 PM, Bart Van Assche wrote:
>> On 10/23/21 23:43, Randy Dunlap wrote:
>>>         sure that you know the name of your UFS host adapter (the card
>>>         inside your computer that "speaks" the UFS protocol, also
>>>         called UFS Host Controller), because you will be asked for it.
>>> @@ -51,7 +50,7 @@ config SCSI_UFSHCD
>>>         (the one containing the directory /) is located on a UFS device.
>>>   config SCSI_UFSHCD_PCI
>>> -    tristate "PCI bus based UFS Controller support"
>>> +    tristate "PCI bus-based UFS Controller support"
>>
>> Even with this change applied capitalization is inconsistent.
> 
> I don't doubt it, but could you be more explicit about
> which word(s) you mean, please?
> 
> I see one "pci" in the Kconfig file.
> I see several "Controller" vs. "controller."
> I see a few of "Support" vs. "support."
> 
> Which are you referring to? (or something else)

I was referring to the word "Controller". Although English is not my native
language, shouldn't "UFS Controller" be changed into "UFS controller" since
neither "bus-based" nor "support" are capitalized?

Thanks,

Bart.

Re: [PATCH] scsi: ufs: clean up the Kconfig file

[Randy Dunlap]

Hi Bart--

On 10/24/21 6:17 PM, Bart Van Assche wrote:
> On 10/24/21 16:35, Randy Dunlap wrote:
>> On 10/24/21 2:29 PM, Bart Van Assche wrote:
>>> On 10/23/21 23:43, Randy Dunlap wrote:
>>>>         sure that you know the name of your UFS host adapter (the card
>>>>         inside your computer that "speaks" the UFS protocol, also
>>>>         called UFS Host Controller), because you will be asked for it.
>>>> @@ -51,7 +50,7 @@ config SCSI_UFSHCD
>>>>         (the one containing the directory /) is located on a UFS device.
>>>>   config SCSI_UFSHCD_PCI
>>>> -    tristate "PCI bus based UFS Controller support"
>>>> +    tristate "PCI bus-based UFS Controller support"
>>>
>>> Even with this change applied capitalization is inconsistent.
>>
>> I don't doubt it, but could you be more explicit about
>> which word(s) you mean, please?
>>
>> I see one "pci" in the Kconfig file.

I changed that one. ^^^

>> I see several "Controller" vs. "controller."
>> I see a few of "Support" vs. "support."
>>
>> Which are you referring to? (or something else)
> 
> I was referring to the word "Controller". Although English is not my native
> language, shouldn't "UFS Controller" be changed into "UFS controller" since
> neither "bus-based" nor "support" are capitalized?

That's not so clear to me, but then I don't have access to the UFS specs.

This help text:
	  UFS host adapter (the card
	  inside your computer that "speaks" the UFS protocol, also
	  called UFS Host Controller)

might imply that the spec calls it "UFS Host Controller", but I can't
read it (AFAIK). OTOH, if that's just a common (non-spec) name for it,
then yes, it should be in lower case ("controller").

I'm leaning towards using "controller" everywhere -- or not changing
any of them. :)
Oh well.

Do you have any insights into this?

thanks.
-- 
~Randy