Commit 19a12613 authored by Jonathan Neuschäfer's avatar Jonathan Neuschäfer Committed by Jonathan Corbet

Documentation: coccinelle: Escape --options to fix Sphinx output

Without such escaping, -- is rendered as – (en dash).
Signed-off-by: default avatarJonathan Neuschäfer <j.neuschaefer@gmx.net>
Acked-by: default avatarJulia Lawall <Julia.Lawall@inria.fr>
Link: https://lore.kernel.org/r/20230129151408.1525324-1-j.neuschaefer@gmx.netSigned-off-by: default avatarJonathan Corbet <corbet@lwn.net>
parent 9625f579
...@@ -219,7 +219,7 @@ instance:: ...@@ -219,7 +219,7 @@ instance::
cat cocci.err cat cocci.err
You can use SPFLAGS to add debugging flags; for instance you may want to 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:: you may want to use::
rm -f err.log rm -f err.log
...@@ -248,7 +248,7 @@ variables for .cocciconfig is as follows: ...@@ -248,7 +248,7 @@ variables for .cocciconfig is as follows:
- Your current user's home directory is processed first - Your current user's home directory is processed first
- Your directory from which spatch is called is processed next - 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 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 proper dir; as such the second rule above would be implied for picking up a
...@@ -265,8 +265,8 @@ The kernel coccicheck script has:: ...@@ -265,8 +265,8 @@ The kernel coccicheck script has::
fi fi
KBUILD_EXTMOD is set when an explicit target with M= is used. For both cases 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= the spatch ``--dir`` argument is used, as such third rule applies when whether
is used or not, and when M= is used the target directory can have its own 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 .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. target directory is the same as the directory from where spatch was called.
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment