[PATCH] Documentation: PM: Fix a reStructuredText syntax error

[PATCH] Documentation: PM: Fix a reStructuredText syntax error

[Yoann Congal]

Fix a reStructuredText syntax error in the cpuidle PM admin-guide
documentation: the ``...'' quotation marks are parsed as partial ''...''
reStructuredText markup and break the output formatting.

This change them to "...".

Signed-off-by: Yoann Congal <yoann.congal@smile.fr>
---
 Documentation/admin-guide/pm/cpuidle.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/admin-guide/pm/cpuidle.rst b/Documentation/admin-guide/pm/cpuidle.rst
index e70b365dbc60..191cfa4a450b 100644
--- a/Documentation/admin-guide/pm/cpuidle.rst
+++ b/Documentation/admin-guide/pm/cpuidle.rst
@@ -690,7 +690,7 @@ which of the two parameters is added to the kernel command line.  In the
 instruction of the CPUs (which, as a rule, suspends the execution of the program
 and causes the hardware to attempt to enter the shallowest available idle state)
 for this purpose, and if ``idle=poll`` is used, idle CPUs will execute a
-more or less ``lightweight'' sequence of instructions in a tight loop.  [Note
+more or less "lightweight" sequence of instructions in a tight loop.  [Note
 that using ``idle=poll`` is somewhat drastic in many cases, as preventing idle
 CPUs from saving almost any energy at all may not be the only effect of it.
 For example, on Intel hardware it effectively prevents CPUs from using
-- 
2.20.1

Re: [PATCH] Documentation: PM: Fix a reStructuredText syntax error

[Rafael J. Wysocki]

On Tue, Sep 29, 2020 at 10:43 PM Yoann Congal <yoann.congal@smile.fr> wrote:
>
> Fix a reStructuredText syntax error in the cpuidle PM admin-guide
> documentation: the ``...'' quotation marks are parsed as partial ''...''
> reStructuredText markup and break the output formatting.
>
> This change them to "...".
>
> Signed-off-by: Yoann Congal <yoann.congal@smile.fr>
> ---
>  Documentation/admin-guide/pm/cpuidle.rst | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/Documentation/admin-guide/pm/cpuidle.rst b/Documentation/admin-guide/pm/cpuidle.rst
> index e70b365dbc60..191cfa4a450b 100644
> --- a/Documentation/admin-guide/pm/cpuidle.rst
> +++ b/Documentation/admin-guide/pm/cpuidle.rst
> @@ -690,7 +690,7 @@ which of the two parameters is added to the kernel command line.  In the
>  instruction of the CPUs (which, as a rule, suspends the execution of the program
>  and causes the hardware to attempt to enter the shallowest available idle state)
>  for this purpose, and if ``idle=poll`` is used, idle CPUs will execute a
> -more or less ``lightweight'' sequence of instructions in a tight loop.  [Note
> +more or less "lightweight" sequence of instructions in a tight loop.  [Note
>  that using ``idle=poll`` is somewhat drastic in many cases, as preventing idle
>  CPUs from saving almost any energy at all may not be the only effect of it.
>  For example, on Intel hardware it effectively prevents CPUs from using
> --

Applied as 5.9-rc8 material, thanks!