* [PATCH] Documentation: drop optional BOMs
@ 2021-05-06 23:19 Randy Dunlap
2021-05-07 1:30 ` Matthew Wilcox
` (2 more replies)
0 siblings, 3 replies; 4+ messages in thread
From: Randy Dunlap @ 2021-05-06 23:19 UTC (permalink / raw)
To: linux-kernel
Cc: Randy Dunlap, Jonathan Corbet, linux-doc, Mauro Carvalho Chehab,
Federico Vaga, Greg Kroah-Hartman, Matthew Wilcox
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@infradead.org>
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: linux-doc@vger.kernel.org
Cc: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
Cc: Federico Vaga <federico.vaga@vaga.pv.it>
Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Cc: Matthew Wilcox <willy@infradead.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(-)
--- 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
=============================
^ permalink raw reply [flat|nested] 4+ messages in thread
* Re: [PATCH] Documentation: drop optional BOMs
2021-05-06 23:19 [PATCH] Documentation: drop optional BOMs Randy Dunlap
@ 2021-05-07 1:30 ` Matthew Wilcox
2021-05-07 6:14 ` Greg Kroah-Hartman
2021-05-10 21:17 ` Jonathan Corbet
2 siblings, 0 replies; 4+ messages in thread
From: Matthew Wilcox @ 2021-05-07 1:30 UTC (permalink / raw)
To: Randy Dunlap
Cc: linux-kernel, Jonathan Corbet, linux-doc, Mauro Carvalho Chehab,
Federico Vaga, Greg Kroah-Hartman
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.
Reviewed-by: Matthew Wilcox (Oracle) <willy@infradead.org>
^ permalink raw reply [flat|nested] 4+ messages in thread
* Re: [PATCH] Documentation: drop optional BOMs
2021-05-06 23:19 [PATCH] Documentation: drop optional BOMs Randy Dunlap
2021-05-07 1:30 ` Matthew Wilcox
@ 2021-05-07 6:14 ` Greg Kroah-Hartman
2021-05-10 21:17 ` Jonathan Corbet
2 siblings, 0 replies; 4+ messages in thread
From: Greg Kroah-Hartman @ 2021-05-07 6:14 UTC (permalink / raw)
To: Randy Dunlap
Cc: linux-kernel, Jonathan Corbet, linux-doc, Mauro Carvalho Chehab,
Federico Vaga, Matthew Wilcox
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@infradead.org>
> Cc: Jonathan Corbet <corbet@lwn.net>
> Cc: linux-doc@vger.kernel.org
> Cc: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
> Cc: Federico Vaga <federico.vaga@vaga.pv.it>
> Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
> Cc: Matthew Wilcox <willy@infradead.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@linuxfoundation.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
> =============================
>
^ permalink raw reply [flat|nested] 4+ messages in thread
* Re: [PATCH] Documentation: drop optional BOMs
2021-05-06 23:19 [PATCH] Documentation: drop optional BOMs Randy Dunlap
2021-05-07 1:30 ` Matthew Wilcox
2021-05-07 6:14 ` Greg Kroah-Hartman
@ 2021-05-10 21:17 ` Jonathan Corbet
2 siblings, 0 replies; 4+ messages in thread
From: Jonathan Corbet @ 2021-05-10 21:17 UTC (permalink / raw)
To: Randy Dunlap, linux-kernel
Cc: Randy Dunlap, linux-doc, Mauro Carvalho Chehab, Federico Vaga,
Greg Kroah-Hartman, Matthew Wilcox
Randy Dunlap <rdunlap@infradead.org> writes:
> 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@infradead.org>
> Cc: Jonathan Corbet <corbet@lwn.net>
> Cc: linux-doc@vger.kernel.org
> Cc: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
> Cc: Federico Vaga <federico.vaga@vaga.pv.it>
> Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
> Cc: Matthew Wilcox <willy@infradead.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(-)
Applied, thanks.
jon
^ permalink raw reply [flat|nested] 4+ messages in thread
end of thread, other threads:[~2021-05-10 21:17 UTC | newest]
Thread overview: 4+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-05-06 23:19 [PATCH] Documentation: drop optional BOMs Randy Dunlap
2021-05-07 1:30 ` Matthew Wilcox
2021-05-07 6:14 ` Greg Kroah-Hartman
2021-05-10 21:17 ` Jonathan Corbet
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).