scripts/coccicheck/README

   1
   2                 Coccicheck version 0.2.4
   3
   4  -*- Usage -*-
   5
   6  1) ./configure mode <your project directory>
   7         This will setup some default directories.
   8         Check in Makefile if they suit you!
   9         mode is either org or diff, depending on whether you want the
  10         output in Emacs org mode, or in diff format where - indicates not
  11         something to remove but an item of interest.
  12
  13         NB: The project directory must currently be an absolute path.
  14
  15         On bash, you can overwrite the default flags on the command line:
  16         SPFLAGS="-I my_include -timeout 30" ./configure mode <project>
  17
  18  2) make update
  19         This will create the `results` directory.
  20         It will contain all the files needed
  21         to apply the SmPL files to your project.
  22
  23  3) make [-jX] (where X is the number of cores to use)
  24         This will apply all the SmPL files found in
  25         the `cocci` directory to your project
  26         (as previously defined).
  27
  28 When it's done, you will get some "out" and "log" files in the
  29 `results` directory. "out" files will contain the output generated by
  30 the SmPL files, and the "log" files will contain the execution trace
  31 of spatch.
  32
  33 If you edit/add some SmPL files in `cocci` directory, you can use
  34 `make checkcocci` to parse them and see if there is any error.
  35
  36 Once the results are computed, you can either:
  37  - run `make viewres` to view all the bug reports
  38  - run `make viewlog` to view the complete execution trace
  39  - run `make viewfilteredlog` to only view unlikely errors of the trace
  40         Note that this filter will remove some error messages about
  41         timeout, parsing ... Check Makefile to see the exact list.
  42