linux-kernel - Re: [PATCH] Documentation: coccinelle: Escape --options to fix Sphinx output

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <alpine.DEB.2.22.394.2301291621350.2852@hadrien>
Date:   Sun, 29 Jan 2023 16:22:03 +0100 (CET)
From:   Julia Lawall <julia.lawall@...ia.fr>
To:     Jonathan Neuschäfer <j.neuschaefer@....net>
cc:     linux-doc@...r.kernel.org, Julia Lawall <Julia.Lawall@...ia.fr>,
        Nicolas Palix <nicolas.palix@...g.fr>,
        Jonathan Corbet <corbet@....net>, cocci@...ia.fr,
        linux-kernel@...r.kernel.org
Subject: Re: [PATCH] Documentation: coccinelle: Escape --options to fix Sphinx
 output



On Sun, 29 Jan 2023, Jonathan Neuschäfer wrote:

> Without such escaping, -- is rendered as – (en dash).
>
> Signed-off-by: Jonathan Neuschäfer <j.neuschaefer@....net>

Thanks.

Acked-by: Julia Lawall <Julia.Lawall@...ia.fr>

> ---
>  Documentation/dev-tools/coccinelle.rst | 8 ++++----
>  1 file changed, 4 insertions(+), 4 deletions(-)
>
> diff --git a/Documentation/dev-tools/coccinelle.rst b/Documentation/dev-tools/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
>
>  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 example
>  you may want to use::
>
>      rm -f err.log
> @@ -248,7 +248,7 @@ variables for .cocciconfig is as follows:
>
>  - 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
>
>  Since coccicheck runs through make, it naturally runs from the kernel
>  proper dir; as such the second rule above would be implied for picking up a
> @@ -265,8 +265,8 @@ The kernel coccicheck script has::
>      fi
>
>  KBUILD_EXTMOD is set when an explicit target with M= is used. For both cases
> -the spatch --dir argument is used, as such third rule applies when whether M=
> -is used or not, and when M= is used the target directory can have its own
> +the spatch ``--dir`` argument is used, as such third rule applies when whether
> +M= is used or not, and when M= is used the target directory can have its own
>  .cocciconfig file. When M= is not passed as an argument to coccicheck the
>  target directory is the same as the directory from where spatch was called.
>
> --
> 2.39.0
>
>