scop.c: fix typo in comment
[pet.git] / README
blobd63b3e06134fac50804e38fbab1a9424cd190384
1 Requirements:
3 - gmp (http://gmplib.org/)
4 - libyaml (http://pyyaml.org/wiki/LibYAML)
5 - LLVM/clang libraries, 2.9 or higher (http://clang.llvm.org/get_started.html)
7 Compilation:
9         git clone git://repo.or.cz/pet.git
10         cd pet
11         git submodule init
12         git submodule update
13         ./autogen.sh
14         ./configure
15         make
16         make check
18 Use:
20 The main entry point is pet_scop_extract_from_C_source.
21 This function extracts a scop from the C source file with the given name
22 and returns it as a pet_scop.  The scop corresponds to the piece
23 of code delimited by
25     #pragma scop
27 and
29     #pragma endscop
31 The code in between needs to consist only of expression statements,
32 if statements and for statements.  All access relations, loop initializations
33 and conditions need to be piecewise quasi-affine.
35 If the autodetect option has been set, pet will try to automatically
36 detect a scop and no pragmas are required.  On the other hand, pet
37 will not produce any warnings in this case as any code that does not
38 satisfy the requirements is considered to lie outside of the scop.
40 The layout of pet_scop is documented in include/pet.h.