Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20;
From:   Jonathan Corbet <corbet@lwn.net>
To:     Stephen Kitt <steve@sk2.org>, linux-kernel@vger.kernel.org
Cc:     Stephen Kitt <steve@sk2.org>, linux-doc@vger.kernel.org
Subject: Re: [PATCH] docs: admin-guide/sysctl: escape % symbols
In-Reply-To: <20220624110230.595740-1-steve@sk2.org>
References: <20220624110230.595740-1-steve@sk2.org>
Date:   Fri, 24 Jun 2022 13:09:25 -0600
Message-ID: <871qvd6fq2.fsf@meer.lwn.net>
MIME-Version: 1.0
Content-Type: text/plain
Precedence: bulk

Stephen Kitt <steve@sk2.org> writes:

> % symbols need to be escaped to render correctly here, do so.
>
> Signed-off-by: Stephen Kitt <steve@sk2.org>
> ---
>  Documentation/admin-guide/sysctl/kernel.rst | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/Documentation/admin-guide/sysctl/kernel.rst b/Documentation/admin-guide/sysctl/kernel.rst
> index ddccd1077462..079a51ed88a9 100644
> --- a/Documentation/admin-guide/sysctl/kernel.rst
> +++ b/Documentation/admin-guide/sysctl/kernel.rst
> @@ -38,8 +38,8 @@ acct
>  
>  If BSD-style process accounting is enabled these values control
>  its behaviour. If free space on filesystem where the log lives
> -goes below ``lowwater``% accounting suspends. If free space gets
> -above ``highwater``% accounting resumes. ``frequency`` determines
> +goes below ``lowwater``\% accounting suspends. If free space gets
> +above ``highwater``\% accounting resumes. ``frequency`` determines
>  how often do we check the amount of free space (value is in
>  seconds). Default:

Interesting...I had to go digging into why this is, because "%" isn't
really special for RST.  The real problem is that ``literal`` markup
needs to have word separators around it, and the recommended solution is
to use "\ " instead.

So I'll apply this, but tweak the changelog and add the extra spaces.

Thanks,

jon