summaryrefslogtreecommitdiff
path: root/Documentation/dev-tools/coccinelle.rst
diff options
context:
space:
mode:
authorJonathan Neuschäfer <j.neuschaefer@gmx.net>2023-01-29 18:14:08 +0300
committerJonathan Corbet <corbet@lwn.net>2023-01-31 23:55:44 +0300
commit19a1261322335642282cc100867cb93579b03f0b (patch)
treee7dad0708a8673bcd194cb81a712ffa988cb5d6f /Documentation/dev-tools/coccinelle.rst
parent9625f579b7f2536c508a6e741606ca4102c64bc5 (diff)
downloadlinux-19a1261322335642282cc100867cb93579b03f0b.tar.xz
Documentation: coccinelle: Escape --options to fix Sphinx output
Without such escaping, -- is rendered as – (en dash). Signed-off-by: Jonathan Neuschäfer <j.neuschaefer@gmx.net> Acked-by: Julia Lawall <Julia.Lawall@inria.fr> Link: https://lore.kernel.org/r/20230129151408.1525324-1-j.neuschaefer@gmx.net Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Diffstat (limited to 'Documentation/dev-tools/coccinelle.rst')
-rw-r--r--Documentation/dev-tools/coccinelle.rst8
1 files changed, 4 insertions, 4 deletions
diff --git a/Documentation/dev-tools/coccinelle.rst b/Documentation/dev-tools/coccinelle.rst
index d9976069ed12..535ce126fb4f 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.