Re: [PATCH 39/53] docs: dev-tools: testing-overview.rst: avoid using UTF-8 chars

From: Mauro Carvalho Chehab
Date: Wed May 12 2021 - 04:52:27 EST


Em Mon, 10 May 2021 12:48:22 +0200
Marco Elver <elver@xxxxxxxxxx> escreveu:

> On Mon, 10 May 2021 at 12:27, Mauro Carvalho Chehab
> <mchehab+huawei@xxxxxxxxxx> wrote:
> >
> > While UTF-8 characters can be used at the Linux documentation,
> > the best is to use them only when ASCII doesn't offer a good replacement.
> > So, replace the occurences of the following UTF-8 characters:
> >
> > - U+2014 ('—'): EM DASH
> >
> > Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@xxxxxxxxxx>
> > ---
> > Documentation/dev-tools/testing-overview.rst | 4 ++--
> > 1 file changed, 2 insertions(+), 2 deletions(-)
> >
> > diff --git a/Documentation/dev-tools/testing-overview.rst b/Documentation/dev-tools/testing-overview.rst
> > index b5b46709969c..8adffc26a2ec 100644
> > --- a/Documentation/dev-tools/testing-overview.rst
> > +++ b/Documentation/dev-tools/testing-overview.rst
> > @@ -18,8 +18,8 @@ frameworks. These both provide infrastructure to help make running tests and
> > groups of tests easier, as well as providing helpers to aid in writing new
> > tests.
> >
> > -If you're looking to verify the behaviour of the Kernel — particularly specific
> > -parts of the kernel — then you'll want to use KUnit or kselftest.
> > +If you're looking to verify the behaviour of the Kernel - particularly specific
> > +parts of the kernel - then you'll want to use KUnit or kselftest.
>
> Single dash is incorrect punctuation here. So that Sphinx gives us the
> correct em dash, these should be '--'.

On Sphinx[1]:

-- is equivalent to EN DASH;
--- is equivalent to EM DASH.

[1] https://docutils.sourceforge.io/docs/user/smartquotes.html

I'll change this on a next spin.

Thanks,
Mauro