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;
Date:   Sat, 25 Jun 2022 17:22:45 +0200
From:   Stephen Kitt <steve@sk2.org>
To:     Jonathan Corbet <corbet@lwn.net>
Cc:     linux-kernel@vger.kernel.org, linux-doc@vger.kernel.org
Subject: Re: [PATCH] docs: admin-guide/sysctl: escape % symbols
Message-ID: <20220625172245.15d0ae7b@heffalump.sk2.org>
In-Reply-To: <871qvd6fq2.fsf@meer.lwn.net>
References: <20220624110230.595740-1-steve@sk2.org>
        <871qvd6fq2.fsf@meer.lwn.net>
MIME-Version: 1.0
Content-Type: multipart/signed; boundary="Sig_/Pe0R7RzTtKL/6ALA3/RL0CV";
 protocol="application/pgp-signature"; micalg=pgp-sha512
Precedence: bulk

--Sig_/Pe0R7RzTtKL/6ALA3/RL0CV
Content-Type: text/plain; charset=US-ASCII
Content-Transfer-Encoding: quoted-printable

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
> > =20
> >  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: =20
>=20
> 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.
>=20
> So I'll apply this, but tweak the changelog and add the extra spaces.

Ah yes, thanks for looking into this!

Regards,

Stephen

--Sig_/Pe0R7RzTtKL/6ALA3/RL0CV
Content-Type: application/pgp-signature
Content-Description: OpenPGP digital signature

-----BEGIN PGP SIGNATURE-----

iQIzBAEBCgAdFiEEnPVX/hPLkMoq7x0ggNMC9Yhtg5wFAmK3KEUACgkQgNMC9Yht
g5z18Q/9ERonRuANlr+e7Zjg4opVcYZC+lOypAfauXJvP6DGiXqF4bOOgUezE7ns
EGtHKyKm2HWIwnrdu1WdkHl5RcLsGLrcBRrTWSEqABXauv0zHSM8cdqNosfBaz/g
WgZA41bc7VzBL/70gjwPXqV9OYS/03Vq+TLPznQ/mw0PEdFIQTaR+7Y9AL61r1Tw
NUNkNMb65jPmyeNDdAhLXtvRn3JHibEPAq9kpc4QNejCN/1Yu2Q0OPxeEppEUXZA
1JRGttDrRjAxMeWYiSJc9iaVc20qLMdcy79mugBbd5vGqVzPBT0Je4sEkHrTJvtn
8oP+sr77/nCiGp8ZrzqJEszdJUd/SclMz8MiDQvq/ls023feuGwUm5wdX6WY2k2r
aPIdH2JPG7h6b2Rh2SEtF7um4KB3pbQr+wqj2PlYOSV7x20lSwCpZ5rOWgpn6FhI
UMdbeYDZKN0ptpd0gOuwvgk5E3G5mFzovRTE0QbNRiI906Xw1ceiR1qlzfHKtgec
8pygx+p/nftHWg7Zsg/KckA3iS8F/64nsJ+e1Q1Y4dnjZI+jUxiij3IGO8Njqe+t
963mF+/GdecjtObLsgX2b46Wl1GCMCzXSlTULrzLrSL6wr3d/5pqohI/wJRzsPSd
qJpWgAYlEWMvRi/dbubIBHJ2hF8xjhEonVthUbrb4UiZYJvdtqs=
=ADlL
-----END PGP SIGNATURE-----

--Sig_/Pe0R7RzTtKL/6ALA3/RL0CV--