Date:   Mon, 30 Jan 2023 09:00:42 +0700
From:   Bagas Sanjaya <bagasdotme@gmail.com>
To:     Jonathan =?utf-8?Q?Neusch=C3=A4fer?= <j.neuschaefer@gmx.net>,
        linux-doc@vger.kernel.org
Cc:     Julia Lawall <Julia.Lawall@inria.fr>,
        Nicolas Palix <nicolas.palix@imag.fr>,
        Jonathan Corbet <corbet@lwn.net>, cocci@inria.fr,
        linux-kernel@vger.kernel.org
Subject: Re: [PATCH] Documentation: coccinelle: Escape --options to fix
 Sphinx output
Message-ID: <Y9ckylqsgCDsZ/RQ@debian.me>
References: <20230129151408.1525324-1-j.neuschaefer@gmx.net>
MIME-Version: 1.0
Content-Type: multipart/signed; micalg=pgp-sha512;
        protocol="application/pgp-signature"; boundary="ZjUcdI54Zb96UmuA"
Content-Disposition: inline
In-Reply-To: <20230129151408.1525324-1-j.neuschaefer@gmx.net>
Precedence: bulk


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

On Sun, Jan 29, 2023 at 04:14:08PM +0100, Jonathan Neusch=C3=A4fer wrote:
> Without such escaping, -- is rendered as =E2=80=93 (en dash).

Well, the diff below is not what escaping means (to escape dashes is to
prepend each of them with a backslash, i.e. \-\-)

>=20
> Signed-off-by: Jonathan Neusch=C3=A4fer <j.neuschaefer@gmx.net>
> ---
>  Documentation/dev-tools/coccinelle.rst | 8 ++++----
>  1 file changed, 4 insertions(+), 4 deletions(-)
>=20
> diff --git a/Documentation/dev-tools/coccinelle.rst b/Documentation/dev-t=
ools/coccinelle.rst
> index d9976069ed126..535ce126fb4fa 100644
> --- a/Documentation/dev-tools/coccinelle.rst
> +++ b/Documentation/dev-tools/coccinelle.rst
> @@ -219,7 +219,7 @@ instance::
>      cat cocci.err
>=20
>  You can use SPFLAGS to add debugging flags; for instance you may want to
> -add both --profile --show-trying to SPFLAGS when debugging. For example
> +add both ``--profile --show-trying`` to SPFLAGS when debugging. For exam=
ple
>  you may want to use::
>=20
>      rm -f err.log
> @@ -248,7 +248,7 @@ variables for .cocciconfig is as follows:
>=20
>  - Your current user's home directory is processed first
>  - Your directory from which spatch is called is processed next
> -- The directory provided with the --dir option is processed last, if used
> +- The directory provided with the ``--dir`` option is processed last, if=
 used
>=20
>  Since coccicheck runs through make, it naturally runs from the kernel
>  proper dir; as such the second rule above would be implied for picking u=
p a
> @@ -265,8 +265,8 @@ The kernel coccicheck script has::
>      fi
>=20
>  KBUILD_EXTMOD is set when an explicit target with M=3D is used. For both=
 cases
> -the spatch --dir argument is used, as such third rule applies when wheth=
er M=3D
> -is used or not, and when M=3D is used the target directory can have its =
own
> +the spatch ``--dir`` argument is used, as such third rule applies when w=
hether
> +M=3D is used or not, and when M=3D is used the target directory can have=
 its own
>  .cocciconfig file. When M=3D is not passed as an argument to coccicheck =
the
>  target directory is the same as the directory from where spatch was call=
ed.
>=20
=20
You inline (wrap within inline code markup) these option keywords to match
other keywords.

Regardless, LGTM, thanks!

Reviewed-by: Bagas Sanjaya <bagasdotme@gmail.com>

--=20
An old man doll... just what I always wanted! - Clara

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

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

iHUEABYKAB0WIQSSYQ6Cy7oyFNCHrUH2uYlJVVFOowUCY9ckqwAKCRD2uYlJVVFO
oyiBAP0aa1/RSNCNahSW+EK6BW1iHcAY44D1wW6DUsAm/3Bo4gD9Gwm7Ygsfm5Rh
01WKHlO/JZInQUNJr0U7/2mlfSvJFgg=
=4V+F
-----END PGP SIGNATURE-----

--ZjUcdI54Zb96UmuA--