* [PATCH] docs: admin-guide/sysctl: escape % symbols
@ 2022-06-24 11:02 Stephen Kitt
2022-06-24 19:09 ` Jonathan Corbet
0 siblings, 1 reply; 3+ messages in thread
From: Stephen Kitt @ 2022-06-24 11:02 UTC (permalink / raw)
To: linux-kernel; +Cc: Stephen Kitt, Jonathan Corbet, linux-doc
% 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:
base-commit: f2906aa863381afb0015a9eb7fefad885d4e5a56
--
2.30.2
^ permalink raw reply related [flat|nested] 3+ messages in thread
* Re: [PATCH] docs: admin-guide/sysctl: escape % symbols
2022-06-24 11:02 [PATCH] docs: admin-guide/sysctl: escape % symbols Stephen Kitt
@ 2022-06-24 19:09 ` Jonathan Corbet
2022-06-25 15:22 ` Stephen Kitt
0 siblings, 1 reply; 3+ messages in thread
From: Jonathan Corbet @ 2022-06-24 19:09 UTC (permalink / raw)
To: Stephen Kitt, linux-kernel; +Cc: Stephen Kitt, linux-doc
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
^ permalink raw reply [flat|nested] 3+ messages in thread
* Re: [PATCH] docs: admin-guide/sysctl: escape % symbols
2022-06-24 19:09 ` Jonathan Corbet
@ 2022-06-25 15:22 ` Stephen Kitt
0 siblings, 0 replies; 3+ messages in thread
From: Stephen Kitt @ 2022-06-25 15:22 UTC (permalink / raw)
To: Jonathan Corbet; +Cc: linux-kernel, linux-doc
[-- Attachment #1: Type: text/plain, Size: 1573 bytes --]
On Fri, 24 Jun 2022 13:09:25 -0600, Jonathan Corbet <corbet@lwn.net> wrote:
> 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.
Ah yes, thanks for looking into this!
Regards,
Stephen
[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 833 bytes --]
^ permalink raw reply [flat|nested] 3+ messages in thread
end of thread, other threads:[~2022-06-25 16:38 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2022-06-24 11:02 [PATCH] docs: admin-guide/sysctl: escape % symbols Stephen Kitt
2022-06-24 19:09 ` Jonathan Corbet
2022-06-25 15:22 ` Stephen Kitt
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).