Commit | Line | Data |
---|---|---|
4b9033a3 JC |
1 | .. Copyright 2010 Nicolas Palix <npalix@diku.dk> |
2 | .. Copyright 2010 Julia Lawall <julia@diku.dk> | |
3 | .. Copyright 2010 Gilles Muller <Gilles.Muller@lip6.fr> | |
e228b1e6 | 4 | |
4b9033a3 | 5 | .. highlight:: none |
e228b1e6 | 6 | |
4b9033a3 JC |
7 | Coccinelle |
8 | ========== | |
9 | ||
10 | Coccinelle is a tool for pattern matching and text transformation that has | |
11 | many uses in kernel development, including the application of complex, | |
12 | tree-wide patches and detection of problematic programming patterns. | |
13 | ||
14 | Getting Coccinelle | |
15 | ------------------- | |
e228b1e6 | 16 | |
ec97946e NP |
17 | The semantic patches included in the kernel use features and options |
18 | which are provided by Coccinelle version 1.0.0-rc11 and above. | |
19 | Using earlier versions will fail as the option names used by | |
20 | the Coccinelle files and coccicheck have been updated. | |
e228b1e6 | 21 | |
ec97946e | 22 | Coccinelle is available through the package manager |
e228b1e6 NP |
23 | of many distributions, e.g. : |
24 | ||
ec97946e NP |
25 | - Debian |
26 | - Fedora | |
27 | - Ubuntu | |
e228b1e6 NP |
28 | - OpenSUSE |
29 | - Arch Linux | |
30 | - NetBSD | |
31 | - FreeBSD | |
32 | ||
e228b1e6 NP |
33 | You can get the latest version released from the Coccinelle homepage at |
34 | http://coccinelle.lip6.fr/ | |
35 | ||
32af0898 NP |
36 | Information and tips about Coccinelle are also provided on the wiki |
37 | pages at http://cocci.ekstranet.diku.dk/wiki/doku.php | |
38 | ||
4b9033a3 | 39 | Once you have it, run the following command:: |
e228b1e6 NP |
40 | |
41 | ./configure | |
42 | make | |
43 | ||
4b9033a3 | 44 | as a regular user, and install it with:: |
e228b1e6 NP |
45 | |
46 | sudo make install | |
47 | ||
4b9033a3 JC |
48 | Supplemental documentation |
49 | --------------------------- | |
c100d537 LR |
50 | |
51 | For supplemental documentation refer to the wiki: | |
52 | ||
53 | https://bottest.wiki.kernel.org/coccicheck | |
54 | ||
55 | The wiki documentation always refers to the linux-next version of the script. | |
56 | ||
4b9033a3 JC |
57 | Using Coccinelle on the Linux kernel |
58 | ------------------------------------ | |
e228b1e6 NP |
59 | |
60 | A Coccinelle-specific target is defined in the top level | |
4b9033a3 JC |
61 | Makefile. This target is named ``coccicheck`` and calls the ``coccicheck`` |
62 | front-end in the ``scripts`` directory. | |
e228b1e6 | 63 | |
4b9033a3 JC |
64 | Four basic modes are defined: ``patch``, ``report``, ``context``, and |
65 | ``org``. The mode to use is specified by setting the MODE variable with | |
66 | ``MODE=<mode>``. | |
e228b1e6 | 67 | |
4b9033a3 | 68 | - ``patch`` proposes a fix, when possible. |
32af0898 | 69 | |
4b9033a3 | 70 | - ``report`` generates a list in the following format: |
e228b1e6 NP |
71 | file:line:column-column: message |
72 | ||
4b9033a3 JC |
73 | - ``context`` highlights lines of interest and their context in a |
74 | diff-like style.Lines of interest are indicated with ``-``. | |
e228b1e6 | 75 | |
4b9033a3 | 76 | - ``org`` generates a report in the Org mode format of Emacs. |
e228b1e6 | 77 | |
32af0898 | 78 | Note that not all semantic patches implement all modes. For easy use |
78a95b9b | 79 | of Coccinelle, the default mode is "report". |
e228b1e6 | 80 | |
78a95b9b | 81 | Two other modes provide some common combinations of these modes. |
e228b1e6 | 82 | |
4b9033a3 JC |
83 | - ``chain`` tries the previous modes in the order above until one succeeds. |
84 | ||
85 | - ``rep+ctxt`` runs successively the report mode and the context mode. | |
86 | It should be used with the C option (described later) | |
87 | which checks the code on a file basis. | |
e228b1e6 | 88 | |
4b9033a3 JC |
89 | Examples |
90 | ~~~~~~~~ | |
e228b1e6 | 91 | |
4b9033a3 | 92 | To make a report for every semantic patch, run the following command:: |
e228b1e6 | 93 | |
78a95b9b NP |
94 | make coccicheck MODE=report |
95 | ||
4b9033a3 | 96 | To produce patches, run:: |
78a95b9b NP |
97 | |
98 | make coccicheck MODE=patch | |
e228b1e6 NP |
99 | |
100 | ||
101 | The coccicheck target applies every semantic patch available in the | |
4b9033a3 | 102 | sub-directories of ``scripts/coccinelle`` to the entire Linux kernel. |
e228b1e6 | 103 | |
32af0898 | 104 | For each semantic patch, a commit message is proposed. It gives a |
e228b1e6 NP |
105 | description of the problem being checked by the semantic patch, and |
106 | includes a reference to Coccinelle. | |
107 | ||
108 | As any static code analyzer, Coccinelle produces false | |
109 | positives. Thus, reports must be carefully checked, and patches | |
110 | reviewed. | |
111 | ||
4b9033a3 | 112 | To enable verbose messages set the V= variable, for example:: |
26e56720 BS |
113 | |
114 | make coccicheck MODE=report V=1 | |
115 | ||
4b9033a3 JC |
116 | Coccinelle parallelization |
117 | --------------------------- | |
c930a1b2 | 118 | |
90d06a46 | 119 | By default, coccicheck tries to run as parallel as possible. To change |
4b9033a3 | 120 | the parallelism, set the J= variable. For example, to run across 4 CPUs:: |
90d06a46 KC |
121 | |
122 | make coccicheck MODE=report J=4 | |
123 | ||
c930a1b2 LR |
124 | As of Coccinelle 1.0.2 Coccinelle uses Ocaml parmap for parallelization, |
125 | if support for this is detected you will benefit from parmap parallelization. | |
126 | ||
127 | When parmap is enabled coccicheck will enable dynamic load balancing by using | |
4b9033a3 | 128 | ``--chunksize 1`` argument, this ensures we keep feeding threads with work |
c930a1b2 LR |
129 | one by one, so that we avoid the situation where most work gets done by only |
130 | a few threads. With dynamic load balancing, if a thread finishes early we keep | |
131 | feeding it more work. | |
132 | ||
133 | When parmap is enabled, if an error occurs in Coccinelle, this error | |
4b9033a3 | 134 | value is propagated back, the return value of the ``make coccicheck`` |
c930a1b2 | 135 | captures this return value. |
e228b1e6 | 136 | |
4b9033a3 JC |
137 | Using Coccinelle with a single semantic patch |
138 | --------------------------------------------- | |
e228b1e6 NP |
139 | |
140 | The optional make variable COCCI can be used to check a single | |
141 | semantic patch. In that case, the variable must be initialized with | |
142 | the name of the semantic patch to apply. | |
143 | ||
4b9033a3 | 144 | For instance:: |
e228b1e6 NP |
145 | |
146 | make coccicheck COCCI=<my_SP.cocci> MODE=patch | |
4b9033a3 JC |
147 | |
148 | or:: | |
149 | ||
e228b1e6 NP |
150 | make coccicheck COCCI=<my_SP.cocci> MODE=report |
151 | ||
152 | ||
4b9033a3 JC |
153 | Controlling Which Files are Processed by Coccinelle |
154 | --------------------------------------------------- | |
155 | ||
f95ab209 GD |
156 | By default the entire kernel source tree is checked. |
157 | ||
4b9033a3 JC |
158 | To apply Coccinelle to a specific directory, ``M=`` can be used. |
159 | For example, to check drivers/net/wireless/ one may write:: | |
32af0898 | 160 | |
f95ab209 | 161 | make coccicheck M=drivers/net/wireless/ |
ed621cc4 | 162 | |
32af0898 | 163 | To apply Coccinelle on a file basis, instead of a directory basis, the |
4b9033a3 | 164 | following command may be used:: |
32af0898 NP |
165 | |
166 | make C=1 CHECK="scripts/coccicheck" | |
167 | ||
4b9033a3 | 168 | To check only newly edited code, use the value 2 for the C flag, i.e.:: |
32af0898 NP |
169 | |
170 | make C=2 CHECK="scripts/coccicheck" | |
171 | ||
78a95b9b NP |
172 | In these modes, which works on a file basis, there is no information |
173 | about semantic patches displayed, and no commit message proposed. | |
174 | ||
32af0898 NP |
175 | This runs every semantic patch in scripts/coccinelle by default. The |
176 | COCCI variable may additionally be used to only apply a single | |
177 | semantic patch as shown in the previous section. | |
178 | ||
78a95b9b | 179 | The "report" mode is the default. You can select another one with the |
32af0898 NP |
180 | MODE variable explained above. |
181 | ||
4b9033a3 JC |
182 | Debugging Coccinelle SmPL patches |
183 | --------------------------------- | |
be1fa900 LR |
184 | |
185 | Using coccicheck is best as it provides in the spatch command line | |
186 | include options matching the options used when we compile the kernel. | |
187 | You can learn what these options are by using V=1, you could then | |
188 | manually run Coccinelle with debug options added. | |
189 | ||
190 | Alternatively you can debug running Coccinelle against SmPL patches | |
191 | by asking for stderr to be redirected to stderr, by default stderr | |
192 | is redirected to /dev/null, if you'd like to capture stderr you | |
4b9033a3 JC |
193 | can specify the ``DEBUG_FILE="file.txt"`` option to coccicheck. For |
194 | instance:: | |
be1fa900 LR |
195 | |
196 | rm -f cocci.err | |
197 | make coccicheck COCCI=scripts/coccinelle/free/kfree.cocci MODE=report DEBUG_FILE=cocci.err | |
198 | cat cocci.err | |
199 | ||
5c384dba LR |
200 | You can use SPFLAGS to add debugging flags, for instance you may want to |
201 | add both --profile --show-trying to SPFLAGS when debugging. For instance | |
4b9033a3 | 202 | you may want to use:: |
5c384dba LR |
203 | |
204 | rm -f err.log | |
205 | export COCCI=scripts/coccinelle/misc/irqf_oneshot.cocci | |
206 | make coccicheck DEBUG_FILE="err.log" MODE=report SPFLAGS="--profile --show-trying" M=./drivers/mfd/arizona-irq.c | |
207 | ||
208 | err.log will now have the profiling information, while stdout will | |
209 | provide some progress information as Coccinelle moves forward with | |
210 | work. | |
211 | ||
be1fa900 LR |
212 | DEBUG_FILE support is only supported when using coccinelle >= 1.2. |
213 | ||
4b9033a3 JC |
214 | .cocciconfig support |
215 | -------------------- | |
dd951fc1 LR |
216 | |
217 | Coccinelle supports reading .cocciconfig for default Coccinelle options that | |
218 | should be used every time spatch is spawned, the order of precedence for | |
219 | variables for .cocciconfig is as follows: | |
220 | ||
4b9033a3 JC |
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 | |
dd951fc1 LR |
224 | |
225 | Since coccicheck runs through make, it naturally runs from the kernel | |
226 | proper dir, as such the second rule above would be implied for picking up a | |
4b9033a3 | 227 | .cocciconfig when using ``make coccicheck``. |
dd951fc1 | 228 | |
4b9033a3 | 229 | ``make coccicheck`` also supports using M= targets.If you do not supply |
dd951fc1 | 230 | any M= target, it is assumed you want to target the entire kernel. |
4b9033a3 | 231 | The kernel coccicheck script has:: |
dd951fc1 LR |
232 | |
233 | if [ "$KBUILD_EXTMOD" = "" ] ; then | |
234 | OPTIONS="--dir $srctree $COCCIINCLUDE" | |
235 | else | |
236 | OPTIONS="--dir $KBUILD_EXTMOD $COCCIINCLUDE" | |
237 | fi | |
238 | ||
239 | KBUILD_EXTMOD is set when an explicit target with M= is used. For both cases | |
240 | the spatch --dir argument is used, as such third rule applies when whether M= | |
241 | is used or not, and when M= is used the target directory can have its own | |
242 | .cocciconfig file. When M= is not passed as an argument to coccicheck the | |
243 | target directory is the same as the directory from where spatch was called. | |
244 | ||
245 | If not using the kernel's coccicheck target, keep the above precedence | |
246 | order logic of .cocciconfig reading. If using the kernel's coccicheck target, | |
247 | override any of the kernel's .coccicheck's settings using SPFLAGS. | |
248 | ||
249 | We help Coccinelle when used against Linux with a set of sensible defaults | |
250 | options for Linux with our own Linux .cocciconfig. This hints to coccinelle | |
4b9033a3 | 251 | git can be used for ``git grep`` queries over coccigrep. A timeout of 200 |
dd951fc1 LR |
252 | seconds should suffice for now. |
253 | ||
254 | The options picked up by coccinelle when reading a .cocciconfig do not appear | |
255 | as arguments to spatch processes running on your system, to confirm what | |
4b9033a3 | 256 | options will be used by Coccinelle run:: |
dd951fc1 LR |
257 | |
258 | spatch --print-options-only | |
259 | ||
260 | You can override with your own preferred index option by using SPFLAGS. Take | |
261 | note that when there are conflicting options Coccinelle takes precedence for | |
262 | the last options passed. Using .cocciconfig is possible to use idutils, however | |
263 | given the order of precedence followed by Coccinelle, since the kernel now | |
264 | carries its own .cocciconfig, you will need to use SPFLAGS to use idutils if | |
265 | desired. See below section "Additional flags" for more details on how to use | |
266 | idutils. | |
267 | ||
4b9033a3 JC |
268 | Additional flags |
269 | ---------------- | |
ed621cc4 NP |
270 | |
271 | Additional flags can be passed to spatch through the SPFLAGS | |
8e826ad5 | 272 | variable. This works as Coccinelle respects the last flags |
4b9033a3 | 273 | given to it when options are in conflict. :: |
ed621cc4 | 274 | |
78a95b9b | 275 | make SPFLAGS=--use-glimpse coccicheck |
dd951fc1 LR |
276 | |
277 | Coccinelle supports idutils as well but requires coccinelle >= 1.0.6. | |
278 | When no ID file is specified coccinelle assumes your ID database file | |
279 | is in the file .id-utils.index on the top level of the kernel, coccinelle | |
4b9033a3 | 280 | carries a script scripts/idutils_index.sh which creates the database with:: |
dd951fc1 LR |
281 | |
282 | mkid -i C --output .id-utils.index | |
283 | ||
284 | If you have another database filename you can also just symlink with this | |
4b9033a3 | 285 | name. :: |
dd951fc1 | 286 | |
78a95b9b | 287 | make SPFLAGS=--use-idutils coccicheck |
ed621cc4 | 288 | |
dd951fc1 | 289 | Alternatively you can specify the database filename explicitly, for |
4b9033a3 | 290 | instance:: |
dd951fc1 LR |
291 | |
292 | make SPFLAGS="--use-idutils /full-path/to/ID" coccicheck | |
293 | ||
4b9033a3 | 294 | See ``spatch --help`` to learn more about spatch options. |
32af0898 | 295 | |
4b9033a3 | 296 | Note that the ``--use-glimpse`` and ``--use-idutils`` options |
78a95b9b NP |
297 | require external tools for indexing the code. None of them is |
298 | thus active by default. However, by indexing the code with | |
299 | one of these tools, and according to the cocci file used, | |
300 | spatch could proceed the entire code base more quickly. | |
301 | ||
4b9033a3 JC |
302 | SmPL patch specific options |
303 | --------------------------- | |
a9e064c0 LR |
304 | |
305 | SmPL patches can have their own requirements for options passed | |
306 | to Coccinelle. SmPL patch specific options can be provided by | |
4b9033a3 | 307 | providing them at the top of the SmPL patch, for instance:: |
a9e064c0 | 308 | |
4b9033a3 | 309 | // Options: --no-includes --include-headers |
a9e064c0 | 310 | |
4b9033a3 JC |
311 | SmPL patch Coccinelle requirements |
312 | ---------------------------------- | |
a9e064c0 LR |
313 | |
314 | As Coccinelle features get added some more advanced SmPL patches | |
315 | may require newer versions of Coccinelle. If an SmPL patch requires | |
316 | at least a version of Coccinelle, this can be specified as follows, | |
4b9033a3 | 317 | as an example if requiring at least Coccinelle >= 1.0.5:: |
a9e064c0 | 318 | |
4b9033a3 | 319 | // Requires: 1.0.5 |
a9e064c0 | 320 | |
4b9033a3 JC |
321 | Proposing new semantic patches |
322 | ------------------------------- | |
e228b1e6 NP |
323 | |
324 | New semantic patches can be proposed and submitted by kernel | |
325 | developers. For sake of clarity, they should be organized in the | |
4b9033a3 | 326 | sub-directories of ``scripts/coccinelle/``. |
e228b1e6 NP |
327 | |
328 | ||
4b9033a3 JC |
329 | Detailed description of the ``report`` mode |
330 | ------------------------------------------- | |
331 | ||
332 | ``report`` generates a list in the following format:: | |
e228b1e6 | 333 | |
e228b1e6 NP |
334 | file:line:column-column: message |
335 | ||
4b9033a3 JC |
336 | Example |
337 | ~~~~~~~ | |
e228b1e6 | 338 | |
4b9033a3 | 339 | Running:: |
e228b1e6 | 340 | |
9dcf7990 | 341 | make coccicheck MODE=report COCCI=scripts/coccinelle/api/err_cast.cocci |
e228b1e6 | 342 | |
4b9033a3 | 343 | will execute the following part of the SmPL script:: |
e228b1e6 | 344 | |
4b9033a3 JC |
345 | <smpl> |
346 | @r depends on !context && !patch && (org || report)@ | |
347 | expression x; | |
348 | position p; | |
349 | @@ | |
e228b1e6 | 350 | |
4b9033a3 | 351 | ERR_PTR@p(PTR_ERR(x)) |
e228b1e6 | 352 | |
4b9033a3 JC |
353 | @script:python depends on report@ |
354 | p << r.p; | |
355 | x << r.x; | |
356 | @@ | |
e228b1e6 | 357 | |
4b9033a3 JC |
358 | msg="ERR_CAST can be used with %s" % (x) |
359 | coccilib.report.print_report(p[0], msg) | |
360 | </smpl> | |
e228b1e6 NP |
361 | |
362 | This SmPL excerpt generates entries on the standard output, as | |
4b9033a3 | 363 | illustrated below:: |
e228b1e6 | 364 | |
4b9033a3 JC |
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 | |
e228b1e6 NP |
368 | |
369 | ||
4b9033a3 JC |
370 | Detailed description of the ``patch`` mode |
371 | ------------------------------------------ | |
e228b1e6 | 372 | |
4b9033a3 | 373 | When the ``patch`` mode is available, it proposes a fix for each problem |
e228b1e6 NP |
374 | identified. |
375 | ||
4b9033a3 JC |
376 | Example |
377 | ~~~~~~~ | |
378 | ||
379 | Running:: | |
e228b1e6 | 380 | |
9dcf7990 | 381 | make coccicheck MODE=patch COCCI=scripts/coccinelle/api/err_cast.cocci |
e228b1e6 | 382 | |
4b9033a3 | 383 | will execute the following part of the SmPL script:: |
e228b1e6 | 384 | |
4b9033a3 JC |
385 | <smpl> |
386 | @ depends on !context && patch && !org && !report @ | |
387 | expression x; | |
388 | @@ | |
e228b1e6 | 389 | |
4b9033a3 JC |
390 | - ERR_PTR(PTR_ERR(x)) |
391 | + ERR_CAST(x) | |
392 | </smpl> | |
e228b1e6 NP |
393 | |
394 | This SmPL excerpt generates patch hunks on the standard output, as | |
4b9033a3 | 395 | illustrated below:: |
e228b1e6 | 396 | |
4b9033a3 JC |
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 | |
e228b1e6 NP |
401 | alg = crypto_attr_alg(tb[1], CRYPTO_ALG_TYPE_CIPHER, |
402 | CRYPTO_ALG_TYPE_MASK); | |
403 | if (IS_ERR(alg)) | |
4b9033a3 JC |
404 | - return ERR_PTR(PTR_ERR(alg)); |
405 | + return ERR_CAST(alg); | |
406 | ||
e228b1e6 NP |
407 | /* Block size must be >= 4 bytes. */ |
408 | err = -EINVAL; | |
409 | ||
4b9033a3 JC |
410 | Detailed description of the ``context`` mode |
411 | -------------------------------------------- | |
e228b1e6 | 412 | |
4b9033a3 | 413 | ``context`` highlights lines of interest and their context |
e228b1e6 NP |
414 | in a diff-like style. |
415 | ||
4b9033a3 JC |
416 | **NOTE**: The diff-like output generated is NOT an applicable patch. The |
417 | intent of the ``context`` mode is to highlight the important lines | |
418 | (annotated with minus, ``-``) and gives some surrounding context | |
e228b1e6 NP |
419 | lines around. This output can be used with the diff mode of |
420 | Emacs to review the code. | |
421 | ||
4b9033a3 JC |
422 | Example |
423 | ~~~~~~~ | |
424 | ||
425 | Running:: | |
e228b1e6 | 426 | |
9dcf7990 | 427 | make coccicheck MODE=context COCCI=scripts/coccinelle/api/err_cast.cocci |
e228b1e6 | 428 | |
4b9033a3 | 429 | will execute the following part of the SmPL script:: |
e228b1e6 | 430 | |
4b9033a3 JC |
431 | <smpl> |
432 | @ depends on context && !patch && !org && !report@ | |
433 | expression x; | |
434 | @@ | |
e228b1e6 | 435 | |
4b9033a3 JC |
436 | * ERR_PTR(PTR_ERR(x)) |
437 | </smpl> | |
e228b1e6 NP |
438 | |
439 | This SmPL excerpt generates diff hunks on the standard output, as | |
4b9033a3 | 440 | illustrated below:: |
e228b1e6 | 441 | |
4b9033a3 JC |
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 | |
444 | +++ /tmp/nothing | |
445 | @@ -185,7 +185,6 @@ static struct crypto_instance *crypto_ct | |
e228b1e6 NP |
446 | alg = crypto_attr_alg(tb[1], CRYPTO_ALG_TYPE_CIPHER, |
447 | CRYPTO_ALG_TYPE_MASK); | |
448 | if (IS_ERR(alg)) | |
4b9033a3 JC |
449 | - return ERR_PTR(PTR_ERR(alg)); |
450 | ||
e228b1e6 NP |
451 | /* Block size must be >= 4 bytes. */ |
452 | err = -EINVAL; | |
453 | ||
4b9033a3 JC |
454 | Detailed description of the ``org`` mode |
455 | ---------------------------------------- | |
456 | ||
457 | ``org`` generates a report in the Org mode format of Emacs. | |
e228b1e6 | 458 | |
4b9033a3 JC |
459 | Example |
460 | ~~~~~~~ | |
e228b1e6 | 461 | |
4b9033a3 | 462 | Running:: |
e228b1e6 | 463 | |
9dcf7990 | 464 | make coccicheck MODE=org COCCI=scripts/coccinelle/api/err_cast.cocci |
e228b1e6 | 465 | |
4b9033a3 | 466 | will execute the following part of the SmPL script:: |
e228b1e6 | 467 | |
4b9033a3 JC |
468 | <smpl> |
469 | @r depends on !context && !patch && (org || report)@ | |
470 | expression x; | |
471 | position p; | |
472 | @@ | |
e228b1e6 | 473 | |
4b9033a3 | 474 | ERR_PTR@p(PTR_ERR(x)) |
e228b1e6 | 475 | |
4b9033a3 JC |
476 | @script:python depends on org@ |
477 | p << r.p; | |
478 | x << r.x; | |
479 | @@ | |
e228b1e6 | 480 | |
4b9033a3 JC |
481 | msg="ERR_CAST can be used with %s" % (x) |
482 | msg_safe=msg.replace("[","@(").replace("]",")") | |
483 | coccilib.org.print_todo(p[0], msg_safe) | |
484 | </smpl> | |
e228b1e6 NP |
485 | |
486 | This SmPL excerpt generates Org entries on the standard output, as | |
4b9033a3 | 487 | illustrated below:: |
e228b1e6 | 488 | |
4b9033a3 JC |
489 | * TODO [[view:/home/user/linux/crypto/ctr.c::face=ovl-face1::linb=188::colb=9::cole=16][ERR_CAST can be used with alg]] |
490 | * TODO [[view:/home/user/linux/crypto/authenc.c::face=ovl-face1::linb=619::colb=9::cole=16][ERR_CAST can be used with auth]] | |
491 | * TODO [[view:/home/user/linux/crypto/xts.c::face=ovl-face1::linb=227::colb=9::cole=16][ERR_CAST can be used with alg]] |