summaryrefslogtreecommitdiff
path: root/Documentation/dev-tools/coccinelle.rst
diff options
context:
space:
mode:
authorSumera Priyadarsini <sylphrenadin@gmail.com>2020-11-26 13:27:30 +0530
committerJonathan Corbet <corbet@lwn.net>2020-12-03 15:45:18 -0700
commit27b03cf1b772f40f97f5c22dafce668436fb548d (patch)
tree20abe3acd97d468154948f5b96e6ca3ad11448ef /Documentation/dev-tools/coccinelle.rst
parented13a92d0fdec0f36791343d39bc646d91cd7d98 (diff)
Documentation: Coccinelle: Improve command example for debugging patches
Modify Coccinelle documentation to clarify usage of make command to run coccicheck on a folder. Changes in v2: - Give example of folder instead of file - Add note Signed-off-by: Sumera Priyadarsini <sylphrenadin@gmail.com> Link: https://lore.kernel.org/r/20201126075730.w6brpeuviefmsxhl@adolin Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Diffstat (limited to 'Documentation/dev-tools/coccinelle.rst')
-rw-r--r--Documentation/dev-tools/coccinelle.rst9
1 files changed, 8 insertions, 1 deletions
diff --git a/Documentation/dev-tools/coccinelle.rst b/Documentation/dev-tools/coccinelle.rst
index 74c5e6aeeff5..9c454de5a7f7 100644
--- a/Documentation/dev-tools/coccinelle.rst
+++ b/Documentation/dev-tools/coccinelle.rst
@@ -224,14 +224,21 @@ you may want to use::
rm -f err.log
export COCCI=scripts/coccinelle/misc/irqf_oneshot.cocci
- make coccicheck DEBUG_FILE="err.log" MODE=report SPFLAGS="--profile --show-trying" M=./drivers/mfd/arizona-irq.c
+ make coccicheck DEBUG_FILE="err.log" MODE=report SPFLAGS="--profile --show-trying" M=./drivers/mfd
err.log will now have the profiling information, while stdout will
provide some progress information as Coccinelle moves forward with
work.
+NOTE:
+
DEBUG_FILE support is only supported when using coccinelle >= 1.0.2.
+Currently, DEBUG_FILE support is only available to check folders, and
+not single files. This is because checking a single file requires spatch
+to be called twice leading to DEBUG_FILE being set both times to the same value,
+giving rise to an error.
+
.cocciconfig support
--------------------