| Message ID | 14b86d84efa6b2c5a7a27e58671e0abcb493cb57.1620823573.git.mchehab+huawei@kernel.org |
|---|---|
| State | New |
| 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+201c ('“'): LEFT DOUBLE QUOTATION MARK > - U+201d ('”'): RIGHT DOUBLE QUOTATION MARK > > Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> Acked-by: Rafael J. Wysocki <rafael.j.wysocki@intel.com> > --- > Documentation/firmware-guide/acpi/lpit.rst | 2 +- > 1 file changed, 1 insertion(+), 1 deletion(-) > > diff --git a/Documentation/firmware-guide/acpi/lpit.rst b/Documentation/firmware-guide/acpi/lpit.rst > index 37922a903573..d7d6c406074a 100644 > --- a/Documentation/firmware-guide/acpi/lpit.rst > +++ b/Documentation/firmware-guide/acpi/lpit.rst > @@ -5,7 +5,7 @@ Low Power Idle Table (LPIT) > =========================== > > To enumerate platform Low Power Idle states, Intel platforms are using > -“Low Power Idle Table” (LPIT). More details about this table can be > +"Low Power Idle Table" (LPIT). More details about this table can be > downloaded from: > https://www.uefi.org/sites/default/files/resources/Intel_ACPI_Low_Power_S0_Idle.pdf > > -- > 2.30.2 >
diff --git a/Documentation/firmware-guide/acpi/lpit.rst b/Documentation/firmware-guide/acpi/lpit.rst index 37922a903573..d7d6c406074a 100644 --- a/Documentation/firmware-guide/acpi/lpit.rst +++ b/Documentation/firmware-guide/acpi/lpit.rst @@ -5,7 +5,7 @@ Low Power Idle Table (LPIT) =========================== To enumerate platform Low Power Idle states, Intel platforms are using -“Low Power Idle Table” (LPIT). More details about this table can be +"Low Power Idle Table" (LPIT). More details about this table can be downloaded from: https://www.uefi.org/sites/default/files/resources/Intel_ACPI_Low_Power_S0_Idle.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+201c ('“'): LEFT DOUBLE QUOTATION MARK - U+201d ('”'): RIGHT DOUBLE QUOTATION MARK Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> --- Documentation/firmware-guide/acpi/lpit.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)