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

From: Bjorn Helgaas <helgaas@kernel.org>
To: Liu Song <liusong@linux.alibaba.com>
Cc: bhelgaas@google.com, linux-pci@vger.kernel.org,
	linux-kernel@vger.kernel.org, Andy Whitcroft <apw@canonical.com>,
	Joe Perches <joe@perches.com>
Subject: Re: [PATCH] PCI: eliminate abnormal characters when reads help information of "PCI_P2PDMA" under menuconfig
Date: Wed, 20 Jul 2022 12:23:28 -0500	[thread overview]
Message-ID: <20220720172328.GA1647083@bhelgaas> (raw)
In-Reply-To: <1658301723-111283-1-git-send-email-liusong@linux.alibaba.com>

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