| Message ID | afeeee8d52dac14c8e86e326b8fcee300dcb0d59.1620823573.git.mchehab+huawei@kernel.org (mailing list archive) |
|---|---|
| State | Not Applicable, archived |
| Headers | show |
| Series | Use ASCII subset instead of UTF-8 alternate symbols | expand |
On Wed, May 12, 2021 at 2:52 PM Mauro Carvalho Chehab <mchehab+huawei@kernel.org> wrote: > > The conversion tools used during DocBook/LaTeX/Markdown->ReST conversion > and some automatic rules which exists on certain text editors like > LibreOffice turned ASCII characters into some UTF-8 alternatives that > are better displayed on html and PDF. > > While it is OK to use UTF-8 characters in Linux, it is better to > use the ASCII subset instead of using an UTF-8 equivalent character > as it makes life easier for tools like grep, and are easier to edit > with the some commonly used text/source code editors. > > Also, Sphinx already do such conversion automatically outside literal blocks: > https://docutils.sourceforge.io/docs/user/smartquotes.html > > So, replace the occurences of the following UTF-8 characters: > > - U+00a0 (' '): NO-BREAK SPACE > > Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> Acked-by: Rafael J. Wysocki <rafael.j.wysocki@intel.com> > --- > Documentation/firmware-guide/acpi/dsd/graph.rst | 2 +- > 1 file changed, 1 insertion(+), 1 deletion(-) > > diff --git a/Documentation/firmware-guide/acpi/dsd/graph.rst b/Documentation/firmware-guide/acpi/dsd/graph.rst > index 7072db801aeb..954b99ec6b77 100644 > --- a/Documentation/firmware-guide/acpi/dsd/graph.rst > +++ b/Documentation/firmware-guide/acpi/dsd/graph.rst > @@ -159,7 +159,7 @@ References > > [2] Devicetree. https://www.devicetree.org, referenced 2016-10-03. > > -[3] Documentation/devicetree/bindings/graph.txt > +[3] Documentation/devicetree/bindings/graph.txt > > [4] Device Properties UUID For _DSD. > https://www.uefi.org/sites/default/files/resources/_DSD-device-properties-UUID.pdf, > -- > 2.30.2 >
diff --git a/Documentation/firmware-guide/acpi/dsd/graph.rst b/Documentation/firmware-guide/acpi/dsd/graph.rst index 7072db801aeb..954b99ec6b77 100644 --- a/Documentation/firmware-guide/acpi/dsd/graph.rst +++ b/Documentation/firmware-guide/acpi/dsd/graph.rst @@ -159,7 +159,7 @@ References [2] Devicetree. https://www.devicetree.org, referenced 2016-10-03. -[3] Documentation/devicetree/bindings/graph.txt +[3] Documentation/devicetree/bindings/graph.txt [4] Device Properties UUID For _DSD. https://www.uefi.org/sites/default/files/resources/_DSD-device-properties-UUID.pdf,
The conversion tools used during DocBook/LaTeX/Markdown->ReST conversion and some automatic rules which exists on certain text editors like LibreOffice turned ASCII characters into some UTF-8 alternatives that are better displayed on html and PDF. While it is OK to use UTF-8 characters in Linux, it is better to use the ASCII subset instead of using an UTF-8 equivalent character as it makes life easier for tools like grep, and are easier to edit with the some commonly used text/source code editors. Also, Sphinx already do such conversion automatically outside literal blocks: https://docutils.sourceforge.io/docs/user/smartquotes.html So, replace the occurences of the following UTF-8 characters: - U+00a0 (' '): NO-BREAK SPACE Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> --- Documentation/firmware-guide/acpi/dsd/graph.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)