bcc2b2d6a946ae8777a5202cc088d25bfb62a87d
[bpt/coccinelle.git] / readme.txt
1 Coccinelle allows programmers to easily write some complex
2 style-preserving source-to-source transformations on C source code,
3 like for instance to perform some refactorings.
4
5 To install Coccinelle from its source, see the instructions in install.txt.
6 For more information on Coccinelle, type 'make docs' and see look at the
7 files in the docs/ directory. You may need to install the texlive-fonts-extra
8 packages from your distribution to compile some of the LaTeX documentation
9 files.
10
11 Once you have installed Coccinelle (either from the source or from one
12 of the binary form available on the Coccinelle website), You may have
13 to setup a few environment variables so that the Coccinelle program
14 know where to find its configuration files.
15 For bash do:
16
17 source env.sh
18
19 For tcsh do:
20
21 source env.csh
22
23
24
25 You can then test coccinelle with:
26
27 spatch -sp_file demos/simple.cocci demos/simple.c
28
29 If you downloaded the bytecode version of spatch you may first
30 have to install OCaml (which contains the 'ocamlrun' bytecode interpreter,
31 the equivalent of 'java', the Java virtual machine, but for OCaml) and then do:
32
33 ocamlrun spatch -sp_file demos/simple.cocci demos/simple.c