Received-SPF: pass (google.com: best guess record for domain of linux-kernel-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) client-ip=209.132.180.67;
Date:   Mon, 24 Feb 2020 19:47:19 +0100
From:   Jonathan =?utf-8?Q?Neusch=C3=A4fer?= <j.neuschaefer@gmx.net>
To:     Jonathan Corbet <corbet@lwn.net>
Cc:     Jonathan =?utf-8?Q?Neusch=C3=A4fer?= <j.neuschaefer@gmx.net>,
        linux-doc@vger.kernel.org, Andi Kleen <ak@linux.intel.com>,
        Thomas Gleixner <tglx@linutronix.de>,
        Randy Dunlap <rdunlap@infradead.org>,
        "Darrick J. Wong" <darrick.wong@oracle.com>,
        Arnd Bergmann <arnd@arndb.de>,
        "Chang S. Bae" <chang.seok.bae@intel.com>,
        linux-kernel@vger.kernel.org
Subject: Re: [PATCH] docs: process: changes.rst: Escape --version to fix
 Sphinx output
Message-ID: <20200224184719.GA2363@latitude>
References: <20200223222228.27089-1-j.neuschaefer@gmx.net>
 <20200224110815.6f7561d1@lwn.net>
MIME-Version: 1.0
Content-Type: multipart/signed; micalg=pgp-sha512;
        protocol="application/pgp-signature"; boundary="tKW2IUtsqtDRztdT"
Content-Disposition: inline
In-Reply-To: <20200224110815.6f7561d1@lwn.net>
User-Agent: Mutt/1.10.1 (2018-07-13)
Sender: linux-kernel-owner@vger.kernel.org
Precedence: bulk


--tKW2IUtsqtDRztdT
Content-Type: text/plain; charset=utf-8
Content-Disposition: inline
Content-Transfer-Encoding: quoted-printable

On Mon, Feb 24, 2020 at 11:08:15AM -0700, Jonathan Corbet wrote:
> On Sun, 23 Feb 2020 23:22:27 +0100
> Jonathan Neusch=C3=A4fer <j.neuschaefer@gmx.net> wrote:
>=20
> > Without double-backticks, Sphinx wrongly turns "--version" into
> > "=E2=80=93version" with a Unicode EN DASH (U+2013), that is visually ea=
sy to
> > confuse with a single ASCII dash.
> >=20
> > Signed-off-by: Jonathan Neusch=C3=A4fer <j.neuschaefer@gmx.net>
>=20
> This certainly seems worth addressing.  But I would *really* rather find
> a way to tell Sphinx not to do that rather than making all of these
> tweaks - which we will certainly find ourselves having to do over and
> over again.  I can try to look into that in a bit, but if somebody were
> to beat me to it ... :)

This seems to do the trick:


diff --git a/Documentation/conf.py b/Documentation/conf.py
index 3c7bdf4cd31f..8f2a7ae95184 100644
--- a/Documentation/conf.py
+++ b/Documentation/conf.py
@@ -587,6 +587,9 @@ pdf_documents =3D [
 kerneldoc_bin =3D '../scripts/kernel-doc'
 kerneldoc_srctree =3D '..'

+# Render -- as two dashes
+smartquotes =3D False
+
 # ------------------------------------------------------------------------=
------
 # Since loadConfig overwrites settings from the global namespace, it has t=
o be
 # the last statement in the conf.py file

(Documentation at https://www.sphinx-doc.org/en/master/usage/configuration.=
html#confval-smartquotes)


Jonathan Neusch=C3=A4fer

--tKW2IUtsqtDRztdT
Content-Type: application/pgp-signature; name="signature.asc"

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

iQIzBAABCgAdFiEEvHAHGBBjQPVy+qvDCDBEmo7zX9sFAl5UGjAACgkQCDBEmo7z
X9suPw//SJEUBOwuKVasHsBaBFpALZvFpkVKtlYVbYVEFOaadikgUyNnnYqbaLVS
4yHQtGpwPe7putz3cdDsiFdJ1TmZGwy3NbpSS9clLxo/BL8IQJZFnnbGqkWdFYWu
HWiv/pROGlnzPOiZRWn7jndmRWcj8xvFpx87YimwP13duu4rSEUKQ40EqdJdXUkw
jb+jSZ7jopFr2zXkWMAAtvKU0yVRQ2ZCIdIRUBS17y+PaOMFRDXu6ALmDINOKChv
fiXQ8S7K7LBKk3/w/WDgMHY/PiYcOfGM7MDeHos7pkYRR3JfacZZufS4tEZAn7VG
N+8l5WxJlIZmr7e27yx4X9vYabsb0jngmZd2pVMlkiTnfddUlro18A0DYwcWlLYR
YwqTR56zh1Ire1emuxiJsUu0DU9ppO7O0I1zHgZ6ESBob18GeJzoHRXiruCa1RGq
Hc62JAtMipfgLhJ1Tr8zV1Uxqsp2zTZfqiMPtNux72SDnLyDofvPJ/3aQG5Kr+Iz
ueFjGRUdtuEvACOG0fTmtfbmqOxSB6ms9bgzpYd0GymzeZuRf7qBkPiyOiVRNtew
o4UbEVYRgYJcA6H+p2wSGbieOnvoGV4qrn0vGE2gAoLxoaxNBU4D1xHVMRYmLCQZ
S1VvafKS/SwOtvEDwjpUo8d0FC5oz7+tv+EIm5XFipPqpY8kMOU=
=6TUA
-----END PGP SIGNATURE-----

--tKW2IUtsqtDRztdT--