diff mbox series

PCI: eliminate abnormal characters when reads help information of "PCI_P2PDMA" under menuconfig

Message ID 1658301723-111283-1-git-send-email-liusong@linux.alibaba.com
State New
Headers show
Series PCI: eliminate abnormal characters when reads help information of "PCI_P2PDMA" under menuconfig | expand

Commit Message

Liu Song July 20, 2022, 7:22 a.m. UTC 
From: Liu Song <liusong@linux.alibaba.com>

Read the help information of PCI_P2PDMA through make menuconfig,
"Enables" is partially displayed as garbled characters, so fix it.

Signed-off-by: Liu Song <liusong@linux.alibaba.com>
---
 drivers/pci/Kconfig | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Randy Dunlap July 20, 2022, 3:17 p.m. UTC | #1 
On 7/20/22 00:22, Liu Song wrote:
> From: Liu Song <liusong@linux.alibaba.com>
> 
> Read the help information of PCI_P2PDMA through make menuconfig,
> "Enables" is partially displayed as garbled characters, so fix it.
> 
> Signed-off-by: Liu Song <liusong@linux.alibaba.com>

Acked-by: Randy Dunlap <rdunlap@infradead.org>
Tested-by: Randy Dunlap <rdunlap@infradead.org>

Thanks.

> ---
>  drivers/pci/Kconfig | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/drivers/pci/Kconfig b/drivers/pci/Kconfig
> index 133c732..8102b78 100644
> --- a/drivers/pci/Kconfig
> +++ b/drivers/pci/Kconfig
> @@ -166,7 +166,7 @@ config PCI_P2PDMA
>  	depends on ZONE_DEVICE
>  	select GENERIC_ALLOCATOR
>  	help
> -	  Enableѕ drivers to do PCI peer-to-peer transactions to and from
> +	  Enables drivers to do PCI peer-to-peer transactions to and from
>  	  BARs that are exposed in other devices that are the part of
>  	  the hierarchy where peer-to-peer DMA is guaranteed by the PCI
>  	  specification to work (ie. anything below a single PCI bridge).
Bjorn Helgaas July 20, 2022, 5:23 p.m. UTC | #2 
[+cc Andy, Joe, possible checkpatch question]

On Wed, Jul 20, 2022 at 03:22:03PM +0800, Liu Song wrote:
> From: Liu Song <liusong@linux.alibaba.com>
> 
> Read the help information of PCI_P2PDMA through make menuconfig,
> "Enables" is partially displayed as garbled characters, so fix it.
> 
> Signed-off-by: Liu Song <liusong@linux.alibaba.com>
> ---
>  drivers/pci/Kconfig | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/drivers/pci/Kconfig b/drivers/pci/Kconfig
> index 133c732..8102b78 100644
> --- a/drivers/pci/Kconfig
> +++ b/drivers/pci/Kconfig
> @@ -166,7 +166,7 @@ config PCI_P2PDMA
>  	depends on ZONE_DEVICE
>  	select GENERIC_ALLOCATOR
>  	help
> -	  Enableѕ drivers to do PCI peer-to-peer transactions to and from
> +	  Enables drivers to do PCI peer-to-peer transactions to and from

I see this problem ("Enables" renders as "Enable ~U" because the "s"
is actually UTF-8 D195, CYRILLIC SMALL LETTER DZE).

"file" found the following other Kconfig files that also contain
UTF-8:

  drivers/pci/Kconfig
    D195 CYRILLIC SMALL LETTER DZE, which looks like "s"
    "Enables" renders as "Enable ~U"
  net/netfilter/ipvs/Kconfig
    C2A0 NO-BREAK SPACE
    renders fine
  drivers/mtd/nand/raw/Kconfig
    MTD_NAND_CAFE  C389 LATIN CAPITAL LETTER E WITH ACUTE
    "CAFÉ" renders as "CAF ~I"
  drivers/mtd/spi-nor/Kconfig
    MTD_SPI_NOR_USE_4K_SECTORS
    "16 × 4 KiB" renders as "16  ~W 4 KiB"
  drivers/net/can/usb/Kconfig
  drivers/net/can/peak_canfd/Kconfig
  drivers/gpu/drm/panel/Kconfig
  drivers/platform/mellanox/Kconfig
  kernel/time/Kconfig
  crypto/Kconfig
  arch/Kconfig

Some of these are clearly wrong (Cyrillic letter), some are
unnecessary (non-breakable space), some are arguable ("CAFÉ" and "16 ×
4 KiB" -- these take advantage of UTF-8 in useful ways).

Not being a charset guru, I dunno if the rendering problem means
my terminal is set incorrectly or if they all need to be changed.

But I think we should address all of them at the same time.  If we do
need to avoid UTF-8 in Kconfig help, maybe checkpatch should look for
it.

>  	  BARs that are exposed in other devices that are the part of
>  	  the hierarchy where peer-to-peer DMA is guaranteed by the PCI
>  	  specification to work (ie. anything below a single PCI bridge).
> -- 
> 1.8.3.1
>
Bjorn Helgaas Aug. 1, 2022, 9:56 p.m. UTC | #3 
On Wed, Jul 20, 2022 at 12:23:29PM -0500, Bjorn Helgaas wrote:
> [+cc Andy, Joe, possible checkpatch question]
> 
> On Wed, Jul 20, 2022 at 03:22:03PM +0800, Liu Song wrote:
> > From: Liu Song <liusong@linux.alibaba.com>
> > 
> > Read the help information of PCI_P2PDMA through make menuconfig,
> > "Enables" is partially displayed as garbled characters, so fix it.
> > 
> > Signed-off-by: Liu Song <liusong@linux.alibaba.com>
> > ---
> >  drivers/pci/Kconfig | 2 +-
> >  1 file changed, 1 insertion(+), 1 deletion(-)
> > 
> > diff --git a/drivers/pci/Kconfig b/drivers/pci/Kconfig
> > index 133c732..8102b78 100644
> > --- a/drivers/pci/Kconfig
> > +++ b/drivers/pci/Kconfig
> > @@ -166,7 +166,7 @@ config PCI_P2PDMA
> >  	depends on ZONE_DEVICE
> >  	select GENERIC_ALLOCATOR
> >  	help
> > -	  Enableѕ drivers to do PCI peer-to-peer transactions to and from
> > +	  Enables drivers to do PCI peer-to-peer transactions to and from
> 
> I see this problem ("Enables" renders as "Enable ~U" because the "s"
> is actually UTF-8 D195, CYRILLIC SMALL LETTER DZE).
> 
> "file" found the following other Kconfig files that also contain
> UTF-8:
> 
>   drivers/pci/Kconfig
>     D195 CYRILLIC SMALL LETTER DZE, which looks like "s"
>     "Enables" renders as "Enable ~U"
>   net/netfilter/ipvs/Kconfig
>     C2A0 NO-BREAK SPACE
>     renders fine
>   drivers/mtd/nand/raw/Kconfig
>     MTD_NAND_CAFE  C389 LATIN CAPITAL LETTER E WITH ACUTE
>     "CAFÉ" renders as "CAF ~I"
>   drivers/mtd/spi-nor/Kconfig
>     MTD_SPI_NOR_USE_4K_SECTORS
>     "16 × 4 KiB" renders as "16  ~W 4 KiB"
>   drivers/net/can/usb/Kconfig
>   drivers/net/can/peak_canfd/Kconfig
>   drivers/gpu/drm/panel/Kconfig
>   drivers/platform/mellanox/Kconfig
>   kernel/time/Kconfig
>   crypto/Kconfig
>   arch/Kconfig
> 
> Some of these are clearly wrong (Cyrillic letter), some are
> unnecessary (non-breakable space), some are arguable ("CAFÉ" and "16 ×
> 4 KiB" -- these take advantage of UTF-8 in useful ways).
> 
> Not being a charset guru, I dunno if the rendering problem means
> my terminal is set incorrectly or if they all need to be changed.
> 
> But I think we should address all of them at the same time.  If we do
> need to avoid UTF-8 in Kconfig help, maybe checkpatch should look for
> it.

Any progress on this problem?  I certainly agree that it should be
fixed; I would just like to fix all the problems, not just the PCI
one.

Bjorn
Liu Song Aug. 2, 2022, 1:11 a.m. UTC | #4 
在 2022/8/2 05:56, Bjorn Helgaas 写道:
> On Wed, Jul 20, 2022 at 12:23:29PM -0500, Bjorn Helgaas wrote:
>> [+cc Andy, Joe, possible checkpatch question]
>>
>> On Wed, Jul 20, 2022 at 03:22:03PM +0800, Liu Song wrote:
>>> From: Liu Song <liusong@linux.alibaba.com>
>>>
>>> Read the help information of PCI_P2PDMA through make menuconfig,
>>> "Enables" is partially displayed as garbled characters, so fix it.
>>>
>>> Signed-off-by: Liu Song <liusong@linux.alibaba.com>
>>> ---
>>>   drivers/pci/Kconfig | 2 +-
>>>   1 file changed, 1 insertion(+), 1 deletion(-)
>>>
>>> diff --git a/drivers/pci/Kconfig b/drivers/pci/Kconfig
>>> index 133c732..8102b78 100644
>>> --- a/drivers/pci/Kconfig
>>> +++ b/drivers/pci/Kconfig
>>> @@ -166,7 +166,7 @@ config PCI_P2PDMA
>>>   	depends on ZONE_DEVICE
>>>   	select GENERIC_ALLOCATOR
>>>   	help
>>> -	  Enableѕ drivers to do PCI peer-to-peer transactions to and from
>>> +	  Enables drivers to do PCI peer-to-peer transactions to and from
>> I see this problem ("Enables" renders as "Enable ~U" because the "s"
>> is actually UTF-8 D195, CYRILLIC SMALL LETTER DZE).
>>
>> "file" found the following other Kconfig files that also contain
>> UTF-8:
>>
>>    drivers/pci/Kconfig
>>      D195 CYRILLIC SMALL LETTER DZE, which looks like "s"
>>      "Enables" renders as "Enable ~U"
>>    net/netfilter/ipvs/Kconfig
>>      C2A0 NO-BREAK SPACE
>>      renders fine
>>    drivers/mtd/nand/raw/Kconfig
>>      MTD_NAND_CAFE  C389 LATIN CAPITAL LETTER E WITH ACUTE
>>      "CAFÉ" renders as "CAF ~I"
>>    drivers/mtd/spi-nor/Kconfig
>>      MTD_SPI_NOR_USE_4K_SECTORS
>>      "16 × 4 KiB" renders as "16  ~W 4 KiB"
>>    drivers/net/can/usb/Kconfig
>>    drivers/net/can/peak_canfd/Kconfig
>>    drivers/gpu/drm/panel/Kconfig
>>    drivers/platform/mellanox/Kconfig
>>    kernel/time/Kconfig
>>    crypto/Kconfig
>>    arch/Kconfig
>>
>> Some of these are clearly wrong (Cyrillic letter), some are
>> unnecessary (non-breakable space), some are arguable ("CAFÉ" and "16 ×
>> 4 KiB" -- these take advantage of UTF-8 in useful ways).
>>
>> Not being a charset guru, I dunno if the rendering problem means
>> my terminal is set incorrectly or if they all need to be changed.
>>
>> But I think we should address all of them at the same time.  If we do
>> need to avoid UTF-8 in Kconfig help, maybe checkpatch should look for
>> it.
> Any progress on this problem?  I certainly agree that it should be
> fixed; I would just like to fix all the problems, not just the PCI
> one.
>
> Bjorn


Totally agree, according to your suggestion, I will resubmit with all 
the revisions.


Thanks
Bjorn Helgaas Oct. 6, 2023, 7:36 p.m. UTC | #5 
On Wed, Jul 20, 2022 at 03:22:03PM +0800, Liu Song wrote:
> From: Liu Song <liusong@linux.alibaba.com>
> 
> Read the help information of PCI_P2PDMA through make menuconfig,
> "Enables" is partially displayed as garbled characters, so fix it.
> 
> Signed-off-by: Liu Song <liusong@linux.alibaba.com>

I think I derailed this by suggesting that we fix other Kconfig files
at the same time, which ended up with a cross-subsystem patch that
nobody picked up.  My fault, sorry.

So I applied this now to pci/misc for v6.7, thank you!

Uwe just posted an identical patch, so I updated the commit log to
mention his patch as well:

  PCI: Replace unnecessary UTF-8 in Kconfig

  The CONFIG_PCI_P2PDMA Kconfig help text contains a Cyrillic small "Dze"
  (ѕ).  When menuconfig renders it, it looks like "Enable ~U drivers" instead
  of "Enables drivers".

  Replace it by a plain "s" so the help text is displayed correctly by
  menuconfig.

  Uwe Kleine-König <u.kleine-koenig@pengutronix.de> later posted the same
  patch at
  https://lore.kernel.org/r/20231006150209.87666-1-u.kleine-koenig@pengutronix.de

> ---
>  drivers/pci/Kconfig | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/drivers/pci/Kconfig b/drivers/pci/Kconfig
> index 133c732..8102b78 100644
> --- a/drivers/pci/Kconfig
> +++ b/drivers/pci/Kconfig
> @@ -166,7 +166,7 @@ config PCI_P2PDMA
>  	depends on ZONE_DEVICE
>  	select GENERIC_ALLOCATOR
>  	help
> -	  Enableѕ drivers to do PCI peer-to-peer transactions to and from
> +	  Enables drivers to do PCI peer-to-peer transactions to and from
>  	  BARs that are exposed in other devices that are the part of
>  	  the hierarchy where peer-to-peer DMA is guaranteed by the PCI
>  	  specification to work (ie. anything below a single PCI bridge).
> -- 
> 1.8.3.1
>
diff mbox series

Patch

diff --git a/drivers/pci/Kconfig b/drivers/pci/Kconfig
index 133c732..8102b78 100644
--- a/drivers/pci/Kconfig
+++ b/drivers/pci/Kconfig
@@ -166,7 +166,7 @@  config PCI_P2PDMA
 	depends on ZONE_DEVICE
 	select GENERIC_ALLOCATOR
 	help
-	  Enableѕ drivers to do PCI peer-to-peer transactions to and from
+	  Enables drivers to do PCI peer-to-peer transactions to and from
 	  BARs that are exposed in other devices that are the part of
 	  the hierarchy where peer-to-peer DMA is guaranteed by the PCI
 	  specification to work (ie. anything below a single PCI bridge).