Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) client-ip=23.128.96.18;
MIME-Version: 1.0
References: <20200929204157.26127-1-yoann.congal@smile.fr>
In-Reply-To: <20200929204157.26127-1-yoann.congal@smile.fr>
From:   "Rafael J. Wysocki" <rafael@kernel.org>
Date:   Wed, 30 Sep 2020 17:41:40 +0200
Message-ID: <CAJZ5v0h9Qkn8ymFjOVBR+WU1vDmb7CyDRsWT_Yo4yc8xVEn23A@mail.gmail.com>
Subject: Re: [PATCH] Documentation: PM: Fix a reStructuredText syntax error
To:     Yoann Congal <yoann.congal@smile.fr>
Cc:     "Rafael J. Wysocki" <rjw@rjwysocki.net>,
        Daniel Lezcano <daniel.lezcano@linaro.org>,
        Jonathan Corbet <corbet@lwn.net>,
        Linux PM <linux-pm@vger.kernel.org>,
        "open list:DOCUMENTATION" <linux-doc@vger.kernel.org>,
        Linux Kernel Mailing List <linux-kernel@vger.kernel.org>
Content-Type: text/plain; charset="UTF-8"
Precedence: bulk

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!