Re: [PATCH v2 29/40] docs: power: powercap: powercap.rst: Use ASCII subset instead of UTF-8 alternate symbols

From: Rafael J. Wysocki
Date: Wed May 12 2021 - 09:54:21 EST


On Wed, May 12, 2021 at 2:52 PM Mauro Carvalho Chehab
<mchehab+huawei@xxxxxxxxxx> 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@xxxxxxxxxx>

Acked-by: Rafael J. Wysocki <rafael.j.wysocki@xxxxxxxxx>

> ---
> Documentation/power/powercap/powercap.rst | 210 +++++++++++-----------
> 1 file changed, 105 insertions(+), 105 deletions(-)
>
> diff --git a/Documentation/power/powercap/powercap.rst b/Documentation/power/powercap/powercap.rst
> index e75d12596dac..c99122e0a1c8 100644
> --- a/Documentation/power/powercap/powercap.rst
> +++ b/Documentation/power/powercap/powercap.rst
> @@ -34,113 +34,113 @@ Example sysfs interface tree::
> /sys/devices/virtual/powercap
> └──intel-rapl
> ├──intel-rapl:0
> - │ ├──constraint_0_name
> - │ ├──constraint_0_power_limit_uw
> - │ ├──constraint_0_time_window_us
> - │ ├──constraint_1_name
> - │ ├──constraint_1_power_limit_uw
> - │ ├──constraint_1_time_window_us
> - │ ├──device -> ../../intel-rapl
> - │ ├──energy_uj
> - │ ├──intel-rapl:0:0
> - │ │ ├──constraint_0_name
> - │ │ ├──constraint_0_power_limit_uw
> - │ │ ├──constraint_0_time_window_us
> - │ │ ├──constraint_1_name
> - │ │ ├──constraint_1_power_limit_uw
> - │ │ ├──constraint_1_time_window_us
> - │ │ ├──device -> ../../intel-rapl:0
> - │ │ ├──energy_uj
> - │ │ ├──max_energy_range_uj
> - │ │ ├──name
> - │ │ ├──enabled
> - │ │ ├──power
> - │ │ │ ├──async
> - │ │ │ []
> - │ │ ├──subsystem -> ../../../../../../class/power_cap
> - │ │ └──uevent
> - │ ├──intel-rapl:0:1
> - │ │ ├──constraint_0_name
> - │ │ ├──constraint_0_power_limit_uw
> - │ │ ├──constraint_0_time_window_us
> - │ │ ├──constraint_1_name
> - │ │ ├──constraint_1_power_limit_uw
> - │ │ ├──constraint_1_time_window_us
> - │ │ ├──device -> ../../intel-rapl:0
> - │ │ ├──energy_uj
> - │ │ ├──max_energy_range_uj
> - │ │ ├──name
> - │ │ ├──enabled
> - │ │ ├──power
> - │ │ │ ├──async
> - │ │ │ []
> - │ │ ├──subsystem -> ../../../../../../class/power_cap
> - │ │ └──uevent
> - │ ├──max_energy_range_uj
> - │ ├──max_power_range_uw
> - │ ├──name
> - │ ├──enabled
> - │ ├──power
> - │ │ ├──async
> - │ │ []
> - │ ├──subsystem -> ../../../../../class/power_cap
> - │ ├──enabled
> - │ ├──uevent
> + │ ├──constraint_0_name
> + │ ├──constraint_0_power_limit_uw
> + │ ├──constraint_0_time_window_us
> + │ ├──constraint_1_name
> + │ ├──constraint_1_power_limit_uw
> + │ ├──constraint_1_time_window_us
> + │ ├──device -> ../../intel-rapl
> + │ ├──energy_uj
> + │ ├──intel-rapl:0:0
> + │ │ ├──constraint_0_name
> + │ │ ├──constraint_0_power_limit_uw
> + │ │ ├──constraint_0_time_window_us
> + │ │ ├──constraint_1_name
> + │ │ ├──constraint_1_power_limit_uw
> + │ │ ├──constraint_1_time_window_us
> + │ │ ├──device -> ../../intel-rapl:0
> + │ │ ├──energy_uj
> + │ │ ├──max_energy_range_uj
> + │ │ ├──name
> + │ │ ├──enabled
> + │ │ ├──power
> + │ │ │ ├──async
> + │ │ │ []
> + │ │ ├──subsystem -> ../../../../../../class/power_cap
> + │ │ └──uevent
> + │ ├──intel-rapl:0:1
> + │ │ ├──constraint_0_name
> + │ │ ├──constraint_0_power_limit_uw
> + │ │ ├──constraint_0_time_window_us
> + │ │ ├──constraint_1_name
> + │ │ ├──constraint_1_power_limit_uw
> + │ │ ├──constraint_1_time_window_us
> + │ │ ├──device -> ../../intel-rapl:0
> + │ │ ├──energy_uj
> + │ │ ├──max_energy_range_uj
> + │ │ ├──name
> + │ │ ├──enabled
> + │ │ ├──power
> + │ │ │ ├──async
> + │ │ │ []
> + │ │ ├──subsystem -> ../../../../../../class/power_cap
> + │ │ └──uevent
> + │ ├──max_energy_range_uj
> + │ ├──max_power_range_uw
> + │ ├──name
> + │ ├──enabled
> + │ ├──power
> + │ │ ├──async
> + │ │ []
> + │ ├──subsystem -> ../../../../../class/power_cap
> + │ ├──enabled
> + │ ├──uevent
> ├──intel-rapl:1
> - │ ├──constraint_0_name
> - │ ├──constraint_0_power_limit_uw
> - │ ├──constraint_0_time_window_us
> - │ ├──constraint_1_name
> - │ ├──constraint_1_power_limit_uw
> - │ ├──constraint_1_time_window_us
> - │ ├──device -> ../../intel-rapl
> - │ ├──energy_uj
> - │ ├──intel-rapl:1:0
> - │ │ ├──constraint_0_name
> - │ │ ├──constraint_0_power_limit_uw
> - │ │ ├──constraint_0_time_window_us
> - │ │ ├──constraint_1_name
> - │ │ ├──constraint_1_power_limit_uw
> - │ │ ├──constraint_1_time_window_us
> - │ │ ├──device -> ../../intel-rapl:1
> - │ │ ├──energy_uj
> - │ │ ├──max_energy_range_uj
> - │ │ ├──name
> - │ │ ├──enabled
> - │ │ ├──power
> - │ │ │ ├──async
> - │ │ │ []
> - │ │ ├──subsystem -> ../../../../../../class/power_cap
> - │ │ └──uevent
> - │ ├──intel-rapl:1:1
> - │ │ ├──constraint_0_name
> - │ │ ├──constraint_0_power_limit_uw
> - │ │ ├──constraint_0_time_window_us
> - │ │ ├──constraint_1_name
> - │ │ ├──constraint_1_power_limit_uw
> - │ │ ├──constraint_1_time_window_us
> - │ │ ├──device -> ../../intel-rapl:1
> - │ │ ├──energy_uj
> - │ │ ├──max_energy_range_uj
> - │ │ ├──name
> - │ │ ├──enabled
> - │ │ ├──power
> - │ │ │ ├──async
> - │ │ │ []
> - │ │ ├──subsystem -> ../../../../../../class/power_cap
> - │ │ └──uevent
> - │ ├──max_energy_range_uj
> - │ ├──max_power_range_uw
> - │ ├──name
> - │ ├──enabled
> - │ ├──power
> - │ │ ├──async
> - │ │ []
> - │ ├──subsystem -> ../../../../../class/power_cap
> - │ ├──uevent
> + │ ├──constraint_0_name
> + │ ├──constraint_0_power_limit_uw
> + │ ├──constraint_0_time_window_us
> + │ ├──constraint_1_name
> + │ ├──constraint_1_power_limit_uw
> + │ ├──constraint_1_time_window_us
> + │ ├──device -> ../../intel-rapl
> + │ ├──energy_uj
> + │ ├──intel-rapl:1:0
> + │ │ ├──constraint_0_name
> + │ │ ├──constraint_0_power_limit_uw
> + │ │ ├──constraint_0_time_window_us
> + │ │ ├──constraint_1_name
> + │ │ ├──constraint_1_power_limit_uw
> + │ │ ├──constraint_1_time_window_us
> + │ │ ├──device -> ../../intel-rapl:1
> + │ │ ├──energy_uj
> + │ │ ├──max_energy_range_uj
> + │ │ ├──name
> + │ │ ├──enabled
> + │ │ ├──power
> + │ │ │ ├──async
> + │ │ │ []
> + │ │ ├──subsystem -> ../../../../../../class/power_cap
> + │ │ └──uevent
> + │ ├──intel-rapl:1:1
> + │ │ ├──constraint_0_name
> + │ │ ├──constraint_0_power_limit_uw
> + │ │ ├──constraint_0_time_window_us
> + │ │ ├──constraint_1_name
> + │ │ ├──constraint_1_power_limit_uw
> + │ │ ├──constraint_1_time_window_us
> + │ │ ├──device -> ../../intel-rapl:1
> + │ │ ├──energy_uj
> + │ │ ├──max_energy_range_uj
> + │ │ ├──name
> + │ │ ├──enabled
> + │ │ ├──power
> + │ │ │ ├──async
> + │ │ │ []
> + │ │ ├──subsystem -> ../../../../../../class/power_cap
> + │ │ └──uevent
> + │ ├──max_energy_range_uj
> + │ ├──max_power_range_uw
> + │ ├──name
> + │ ├──enabled
> + │ ├──power
> + │ │ ├──async
> + │ │ []
> + │ ├──subsystem -> ../../../../../class/power_cap
> + │ ├──uevent
> ├──power
> - │ ├──async
> - │ []
> + │ ├──async
> + │ []
> ├──subsystem -> ../../../../class/power_cap
> ├──enabled
> └──uevent
> --
> 2.30.2
>