Re: [PATCH] docs: admin-guide/sysctl: escape % symbols

From: Jonathan Corbet
Date: Fri Jun 24 2022 - 15:09:30 EST


Stephen Kitt <steve@xxxxxxx> writes:

> % symbols need to be escaped to render correctly here, do so.
>
> Signed-off-by: Stephen Kitt <steve@xxxxxxx>
> ---
> 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