u-boot/doc/README.coccinelle

12 tree-wide patches and detection of problematic programming patterns.
15 -------------------
18 which are provided by Coccinelle version 1.0.0-rc11 and above.
25  - Debian
26  - Fedora
27  - Ubuntu
28  - OpenSUSE
29  - Arch Linux
30  - NetBSD
31  - FreeBSD
49 ---------------------------
55 The wiki documentation always refers to the linux-next version of the script.
58 ------------------------------------
60 A Coccinelle-specific target is defined in the top level
62 front-end in the ``scripts`` directory.
68 - ``patch`` proposes a fix, when possible.
70 - ``report`` generates a list in the following format:
71   file:line:column-column: message
73 - ``context`` highlights lines of interest and their context in a
74   diff-like style.Lines of interest are indicated with ``-``.
76 - ``org`` generates a report in the Org mode format of Emacs.
83 - ``chain`` tries the previous modes in the order above until one succeeds.
85 - ``rep+ctxt`` runs successively the report mode and the context mode.
102 sub-directories of ``scripts/coccinelle`` to the entire Linux kernel.
117 ---------------------------
128 ``--chunksize 1`` argument, this ensures we keep feeding threads with work
138 ---------------------------------------------
140 The optional make variable COCCI can be used to check a single
154 ---------------------------------------------------
159 For example, to check drivers/net/wireless/ one may write::
166     make C=1 CHECK="scripts/coccicheck"
168 To check only newly edited code, use the value 2 for the C flag, i.e.::
170     make C=2 CHECK="scripts/coccicheck"
183 ---------------------------------
196     rm -f cocci.err
201 add both --profile --show-trying to SPFLAGS when debugging. For instance
204     rm -f err.log
206 …occicheck DEBUG_FILE="err.log" MODE=report SPFLAGS="--profile --show-trying" M=./drivers/mfd/arizo…
215 --------------------
221 - Your current user's home directory is processed first
222 - Your directory from which spatch is called is processed next
223 - The directory provided with the --dir option is processed last, if used
234         OPTIONS="--dir $srctree $COCCIINCLUDE"
236         OPTIONS="--dir $KBUILD_EXTMOD $COCCIINCLUDE"
240 the spatch --dir argument is used, as such third rule applies when whether M=
255 as arguments to spatch processes running on your system, to confirm what
258       spatch --print-options-only
269 ----------------
275     make SPFLAGS=--use-glimpse coccicheck
279 is in the file .id-utils.index on the top level of the kernel, coccinelle
282     mkid -i C --output .id-utils.index
287     make SPFLAGS=--use-idutils coccicheck
292     make SPFLAGS="--use-idutils /full-path/to/ID" coccicheck
294 See ``spatch --help`` to learn more about spatch options.
296 Note that the ``--use-glimpse`` and ``--use-idutils`` options
303 ---------------------------
309 	// Options: --no-includes --include-headers
312 ----------------------------------
322 -------------------------------
326 sub-directories of ``scripts/coccinelle/``.
330 -------------------------------------------
334   file:line:column-column: message
365     /home/user/linux/crypto/ctr.c:188:9-16: ERR_CAST can be used with alg
366     /home/user/linux/crypto/authenc.c:619:9-16: ERR_CAST can be used with auth
367     /home/user/linux/crypto/xts.c:227:9-16: ERR_CAST can be used with alg
371 ------------------------------------------
390     - ERR_PTR(PTR_ERR(x))
397     diff -u -p a/crypto/ctr.c b/crypto/ctr.c
398     --- a/crypto/ctr.c 2010-05-26 10:49:38.000000000 +0200
399     +++ b/crypto/ctr.c 2010-06-03 23:44:49.000000000 +0200
400     @@ -185,7 +185,7 @@ static struct crypto_instance *crypto_ct
404     -		return ERR_PTR(PTR_ERR(alg));
408  	err = -EINVAL;
411 --------------------------------------------
414 in a diff-like style.
416       **NOTE**: The diff-like output generated is NOT an applicable patch. The
418       (annotated with minus, ``-``) and gives some surrounding context
442     diff -u -p /home/user/linux/crypto/ctr.c /tmp/nothing
443     --- /home/user/linux/crypto/ctr.c	2010-05-26 10:49:38.000000000 +0200
445     @@ -185,7 +185,6 @@ static struct crypto_instance *crypto_ct
449     -		return ERR_PTR(PTR_ERR(alg));
452  	err = -EINVAL;
455 ----------------------------------------
489 …* TODO [[view:/home/user/linux/crypto/ctr.c::face=ovl-face1::linb=188::colb=9::cole=16][ERR_CAST c…
490 …* TODO [[view:/home/user/linux/crypto/authenc.c::face=ovl-face1::linb=619::colb=9::cole=16][ERR_CA…
491 …* TODO [[view:/home/user/linux/crypto/xts.c::face=ovl-face1::linb=227::colb=9::cole=16][ERR_CAST c…