scripts/coccicheck/README

   1
   2                 Coccicheck version 0.1
   3
   4  -*- Usage -*-
   5
   6  1) ./configure mode <your project directory>
   7         This will setup some default directories.
   8         Check 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  2) make update
  14         This will create the `results` directory.
  15         It will contain all the files needed
  16         to apply the SmPL files to your project.
  17
  18  3) make [-jX] (where X is the number of cores to use)
  19         This will apply all the SmPL files found in
  20         the `cocci` directory to your project
  21         (as previously defined).
  22
  23 When it's done, you will get some "out" and "log" files in the
  24 `results` directory. "out" files will contain the output generated by
  25 the SmPL files, and the "log" files will contain the execution trace
  26 of spatch.
  27
  28 If you edit/add some SmPL files in `cocci` directory, you can use
  29 `make checkcocci` to parse them and see if there is any error.
  30
  31 Once the results are computed, you can either:
  32  - run `make viewres` to view all the results
  33  - run `make viewlog` to view the complete trace
  34  - run `make viewfilteredlog` to view the most important part of the trace
  35
  36