Documentation: coccinelle: Escape --options to fix Sphinx output
Commit Message
Without such escaping, -- is rendered as – (en dash).
Signed-off-by: Jonathan Neuschäfer <j.neuschaefer@gmx.net>
---
Documentation/dev-tools/coccinelle.rst | 8 ++++----
1 file changed, 4 insertions(+), 4 deletions(-)
--
2.39.0
Comments
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@gmx.net>
Thanks.
Acked-by: Julia Lawall <Julia.Lawall@inria.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
>
>
On Sun, Jan 29, 2023 at 04:14:08PM +0100, Jonathan Neuschäfer wrote:
> Without such escaping, -- is rendered as – (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. \-\-)
>
> Signed-off-by: Jonathan Neuschäfer <j.neuschaefer@gmx.net>
> ---
> 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.
>
You inline (wrap within inline code markup) these option keywords to match
other keywords.
Regardless, LGTM, thanks!
Reviewed-by: Bagas Sanjaya <bagasdotme@gmail.com>
Jonathan Neuschäfer <j.neuschaefer@gmx.net> writes:
> Without such escaping, -- is rendered as – (en dash).
>
> Signed-off-by: Jonathan Neuschäfer <j.neuschaefer@gmx.net>
> ---
> Documentation/dev-tools/coccinelle.rst | 8 ++++----
> 1 file changed, 4 insertions(+), 4 deletions(-)
Applied, thanks.
jon
@@ -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.