mirrors
/
linux-stable
mirror of https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git
1
0
Fork 0
Code Issues Releases Wiki Activity

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>
This commit is contained in:
Jonathan Neuschäfer 2023-01-29 16:14:08 +01:00 committed by Jonathan Corbet
parent 9625f579b7
commit 19a1261322
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
Documentation/dev-tools/coccinelle.rst
View File

@ -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:
- 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::
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.