2022-06-24 11:14:12

by Stephen Kitt

[permalink] [raw]
Subject: [PATCH] docs: admin-guide/sysctl: escape % symbols

% symbols need to be escaped to render correctly here, do so.

Signed-off-by: Stephen Kitt <[email protected]>
---
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:


base-commit: f2906aa863381afb0015a9eb7fefad885d4e5a56
--
2.30.2


2022-06-24 19:14:37

by Jonathan Corbet

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

Stephen Kitt <[email protected]> writes:

> % symbols need to be escaped to render correctly here, do so.
>
> Signed-off-by: Stephen Kitt <[email protected]>
> ---
> 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

2022-06-25 17:02:19

by Stephen Kitt

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

On Fri, 24 Jun 2022 13:09:25 -0600, Jonathan Corbet <[email protected]> wrote:
> Stephen Kitt <[email protected]> writes:
> > % symbols need to be escaped to render correctly here, do so.
> >
> > Signed-off-by: Stephen Kitt <[email protected]>
> > ---
> > 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.

Ah yes, thanks for looking into this!

Regards,

Stephen


Attachments:
(No filename) (849.00 B)
OpenPGP digital signature