[bpt/coccinelle.git] / install.txt


 ** Compilation **

You must first install a recent version of
 - OCaml (at least 3.09.2),
   see http://caml.inria.fr/download.en.html
   At least, OCaml 3.11 is required to use the OCaml scripting
   feature in the SmPL code.
 - The Menhir parser generator (at least 20080912),
   see http://cristal.inria.fr/~fpottier/menhir/
   (unless you got a version of the coccinelle source with
   the SmPL parser pre-generated)
 - Python and its development files (python-dev)
   (unless you run configure with the --without-python option)

Then simply type
 ./configure
 make depend
 make
 make install


'make' will compile the bytecode version by default.  You could use
'make all.opt' to have the optimized version.  If you compile both,
'make install' will take care of that and install both, spatch and
spatch.opt.  If you use only one of them, 'make install' will install
the one you have compiled, either spatch ou spatch.opt, under the
front-end spatch. You could use 'make world' to compile the bytecode
and the optimized code version.

We provide the files generated by menhir in the tarball.  However,
'make distclean' will remove them. You could either restore them from
the tarball or install menhir.  Using 'make clean' should be safe with
regards to these files.

Note: The test target is intended for developers. In particular, you
      should not expect that every test will pass.


 In order to use the OCaml scripting feature in SmPL, you must compile
Coccinelle with at least OCaml version 3.11.


 ** Bash integration **

 To have completion under Bash, you can execute the following command:

    make install-bash

 It will install the shell script 'scripts/spatch.bash_completion'
 in /etc/bash_completion.d/spatch

 You can manually copy that file elsewhere if you have a different
 bash_completion directory.


 ** Runtime dependencies **

 - Basic shell commands:
   - ls, cat, cp, mv, rm, grep, mkdir, find
 - Developper tool: diff


 ** Optional runtime dependencies **

 - To quickly apply the semantic patches
   - glimpse indexer

 - To use OCaml scripting feature in SmPL
   - ocaml-native-compilers or ocaml-nox
   - ocaml-findlib

 - To generate a PDF of the control flow graph with '-graphical_trace'
   - pdftk and graphviz (with PDF support)


 ** Dependencies for additional tools **

    git, pushd, popd, sed, diffstat, cpp

 ** Uninstall **

    To uninstall Coccinelle, you should use the following command

    make uninstall


    To also remove the bash completion script, run

    make uninstall-bash
Commit	Line	Data
174d1640 C	1
	2	Compilation
	3
	4	You must first install a recent version of
	5	- OCaml (at least 3.09.2),
34e49164	6	see http://caml.inria.fr/download.en.html
174d1640 C	7	At least, OCaml 3.11 is required to use the OCaml scripting
	8	feature in the SmPL code.
	9	- The Menhir parser generator (at least 20080912),
34e49164 C	10	see http://cristal.inria.fr/~fpottier/menhir/
	11	(unless you got a version of the coccinelle source with
	12	the SmPL parser pre-generated)
	13	- Python and its development files (python-dev)
	14	(unless you run configure with the --without-python option)
34e49164	15
174d1640	16	Then simply type
34e49164 C	17	./configure
	18	make depend
	19	make
	20	make install
	21
b1b2de81	22
708f4980 C	23
	24
	25
174d1640 C	26	'make' will compile the bytecode version by default. You could use
	27	'make all.opt' to have the optimized version. If you compile both,
	28	'make install' will take care of that and install both, spatch and
	29	spatch.opt. If you use only one of them, 'make install' will install
	30	the one you have compiled, either spatch ou spatch.opt, under the
	31	front-end spatch. You could use 'make world' to compile the bytecode
	32	and the optimized code version.
	33
	34	We provide the files generated by menhir in the tarball. However,
	35	'make distclean' will remove them. You could either restore them from
	36	the tarball or install menhir. Using 'make clean' should be safe with
	37	regards to these files.
	38
	39	Note: The test target is intended for developers. In particular, you
	40	should not expect that every test will pass.
	41
	42
	43	In order to use the OCaml scripting feature in SmPL, you must compile
	44	Coccinelle with at least OCaml version 3.11.
	45
	46
aba5c457 C	47
	48	Bash integration
	49
	50	To have completion under Bash, you can execute the following command:
	51
	52	make install-bash
	53
	54	It will install the shell script 'scripts/spatch.bash_completion'
	55	in /etc/bash_completion.d/spatch
	56
	57	You can manually copy that file elsewhere if you have a different
	58	bash_completion directory.
	59
	60
	61
174d1640 C	62	Runtime dependencies
	63
	64	- Basic shell commands:
	65	- ls, cat, cp, mv, rm, grep, mkdir, find
	66	- Developper tool: diff
	67
	68
	69	Optional runtime dependencies
	70
	71	- To quickly apply the semantic patches
	72	- glimpse indexer
	73
	74	- To use OCaml scripting feature in SmPL
	75	- ocaml-native-compilers or ocaml-nox
	76	- ocaml-findlib
	77
	78	- To generate a PDF of the control flow graph with '-graphical_trace'
	79	- pdftk and graphviz (with PDF support)
	80
	81
708f4980	82
174d1640	83	Dependencies for additional tools
9f8e26f4	84
174d1640	85	git, pushd, popd, sed, diffstat, cpp
aba5c457 C	86
	87	Uninstall
	88
	89	To uninstall Coccinelle, you should use the following command
	90
	91	make uninstall
	92
	93
	94	To also remove the bash completion script, run
	95
	96	make uninstall-bash