2022-07-20 08:14:34

by Liu Song

[permalink] [raw]
Subject: [PATCH] PCI: eliminate abnormal characters when reads help information of "PCI_P2PDMA" under menuconfig

From: Liu Song <[email protected]>

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 <[email protected]>
---
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


2022-07-20 15:27:25

by Randy Dunlap

[permalink] [raw]
Subject: Re: [PATCH] PCI: eliminate abnormal characters when reads help information of "PCI_P2PDMA" under menuconfig



On 7/20/22 00:22, Liu Song wrote:
> From: Liu Song <[email protected]>
>
> 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 <[email protected]>

Acked-by: Randy Dunlap <[email protected]>
Tested-by: Randy Dunlap <[email protected]>

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

--
~Randy

2022-07-20 17:40:25

by Bjorn Helgaas

[permalink] [raw]
Subject: Re: [PATCH] PCI: eliminate abnormal characters when reads help information of "PCI_P2PDMA" under menuconfig

[+cc Andy, Joe, possible checkpatch question]

On Wed, Jul 20, 2022 at 03:22:03PM +0800, Liu Song wrote:
> From: Liu Song <[email protected]>
>
> 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 <[email protected]>
> ---
> 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
>

2022-08-01 22:04:12

by Bjorn Helgaas

[permalink] [raw]
Subject: Re: [PATCH] PCI: eliminate abnormal characters when reads help information of "PCI_P2PDMA" under menuconfig

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 <[email protected]>
> >
> > 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 <[email protected]>
> > ---
> > 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

2022-08-02 01:15:18

by Liu Song

[permalink] [raw]
Subject: Re: [PATCH] PCI: eliminate abnormal characters when reads help information of "PCI_P2PDMA" under menuconfig


在 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 <[email protected]>
>>>
>>> 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 <[email protected]>
>>> ---
>>> 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



2023-10-06 19:36:26

by Bjorn Helgaas

[permalink] [raw]
Subject: Re: [PATCH] PCI: eliminate abnormal characters when reads help information of "PCI_P2PDMA" under menuconfig

On Wed, Jul 20, 2022 at 03:22:03PM +0800, Liu Song wrote:
> From: Liu Song <[email protected]>
>
> 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 <[email protected]>

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 <[email protected]> later posted the same
patch at
https://lore.kernel.org/r/[email protected]

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