linux-kernel - Re: [PATCH] Documentation: drop optional BOMs

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Date:   Fri, 7 May 2021 08:14:10 +0200
From:   Greg Kroah-Hartman <gregkh@...uxfoundation.org>
To:     Randy Dunlap <rdunlap@...radead.org>
Cc:     linux-kernel@...r.kernel.org, Jonathan Corbet <corbet@....net>,
        linux-doc@...r.kernel.org,
        Mauro Carvalho Chehab <mchehab+samsung@...nel.org>,
        Federico Vaga <federico.vaga@...a.pv.it>,
        Matthew Wilcox <willy@...radead.org>
Subject: Re: [PATCH] Documentation: drop optional BOMs

On Thu, May 06, 2021 at 04:19:07PM -0700, Randy Dunlap wrote:
> A few of the Documentation .rst files begin with a Unicode
> byte order mark (BOM). The BOM may signify endianess for
> 16-bit or 32-bit encodings or indicate that the text stream
> is indeed Unicode. We don't need it for either of those uses.
> It may also interfere with (confuse) some software.
> 
> Since we don't need it and its use is optional, just delete
> the uses of it in Documentation/.
> 
> https://en.wikipedia.org/wiki/Byte_order_mark
> 
> Fixes: 898bd37a9206 ("docs: block: convert to ReST")
> Fixes: edba5eecfd6e ("doc:it_IT: add some process/* translations")
> Fixes: 675aaf05d898 ("docs: xen-tpmfront.txt: convert it to .rstX")
> Fixes: 458f69ef3665 ("docs: timers: convert docs to ReST and rename to *.rst")
> Fixes: d80b5005c5dd ("docs: usb: convert documents to ReST")
> Signed-off-by: Randy Dunlap <rdunlap@...radead.org>
> Cc: Jonathan Corbet <corbet@....net>
> Cc: linux-doc@...r.kernel.org
> Cc: Mauro Carvalho Chehab <mchehab+samsung@...nel.org>
> Cc: Federico Vaga <federico.vaga@...a.pv.it>
> Cc: Greg Kroah-Hartman <gregkh@...uxfoundation.org>
> Cc: Matthew Wilcox <willy@...radead.org>
> ---
>  Documentation/block/data-integrity.rst                 |    2 +-
>  Documentation/process/kernel-enforcement-statement.rst |    2 +-
>  Documentation/security/tpm/xen-tpmfront.rst            |    2 +-
>  Documentation/timers/no_hz.rst                         |    2 +-
>  Documentation/usb/mtouchusb.rst                        |    2 +-
>  Documentation/usb/usb-serial.rst                       |    2 +-
>  6 files changed, 6 insertions(+), 6 deletions(-)

That's crazy, nice catch!

Reviewed-by: Greg Kroah-Hartman <gregkh@...uxfoundation.org>

> 
> --- linux-next-20210506.orig/Documentation/block/data-integrity.rst
> +++ linux-next-20210506/Documentation/block/data-integrity.rst
> @@ -1,4 +1,4 @@
> -==============
> +==============
>  Data Integrity
>  ==============
>  
> --- linux-next-20210506.orig/Documentation/process/kernel-enforcement-statement.rst
> +++ linux-next-20210506/Documentation/process/kernel-enforcement-statement.rst
> @@ -1,4 +1,4 @@
> -.. _process_statement_kernel:
> +.. _process_statement_kernel:
>  
>  Linux Kernel Enforcement Statement
>  ----------------------------------
> --- linux-next-20210506.orig/Documentation/timers/no_hz.rst
> +++ linux-next-20210506/Documentation/timers/no_hz.rst
> @@ -1,4 +1,4 @@
> -======================================
> +======================================
>  NO_HZ: Reducing Scheduling-Clock Ticks
>  ======================================
>  
> --- linux-next-20210506.orig/Documentation/usb/mtouchusb.rst
> +++ linux-next-20210506/Documentation/usb/mtouchusb.rst
> @@ -1,4 +1,4 @@
> -================
> +================
>  mtouchusb driver
>  ================
>  
> --- linux-next-20210506.orig/Documentation/usb/usb-serial.rst
> +++ linux-next-20210506/Documentation/usb/usb-serial.rst
> @@ -1,4 +1,4 @@
> -==========
> +==========
>  USB serial
>  ==========
>  
> --- linux-next-20210506.orig/Documentation/security/tpm/xen-tpmfront.rst
> +++ linux-next-20210506/Documentation/security/tpm/xen-tpmfront.rst
> @@ -1,4 +1,4 @@
> -=============================
> +=============================
>  Virtual TPM interface for Xen
>  =============================
>