Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

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>

authored by

Sumera Priyadarsini and committed by
Jonathan Corbet
27b03cf1 ed13a92d

+8 -1
+8 -1
Documentation/dev-tools/coccinelle.rst
··· 224 224 225 225 rm -f err.log 226 226 export COCCI=scripts/coccinelle/misc/irqf_oneshot.cocci 227 - make coccicheck DEBUG_FILE="err.log" MODE=report SPFLAGS="--profile --show-trying" M=./drivers/mfd/arizona-irq.c 227 + make coccicheck DEBUG_FILE="err.log" MODE=report SPFLAGS="--profile --show-trying" M=./drivers/mfd 228 228 229 229 err.log will now have the profiling information, while stdout will 230 230 provide some progress information as Coccinelle moves forward with 231 231 work. 232 232 233 + NOTE: 234 + 233 235 DEBUG_FILE support is only supported when using coccinelle >= 1.0.2. 236 + 237 + Currently, DEBUG_FILE support is only available to check folders, and 238 + not single files. This is because checking a single file requires spatch 239 + to be called twice leading to DEBUG_FILE being set both times to the same value, 240 + giving rise to an error. 234 241 235 242 .cocciconfig support 236 243 --------------------