Skip to content

Commit

Permalink
Documentation: coccinelle: Escape --options to fix Sphinx output
Browse files Browse the repository at this point in the history
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>
  • Loading branch information
neuschaefer authored and Jonathan Corbet committed Jan 31, 2023
1 parent 9625f57 commit 19a1261
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions Documentation/dev-tools/coccinelle.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand All @@ -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.

Expand Down

0 comments on commit 19a1261

Please sign in to comment.