]> git.ipfire.org Git - people/ms/strongswan.git/blame - HACKING
somehow missed these changes during the portability branch back-merge
[people/ms/strongswan.git] / HACKING
CommitLineData
c0d63ac9
MW
1 -------------------------
2 strongSwan - Development
3 -------------------------
4
4986554f
MW
5Subversion repository
6---------------------
7
c0d63ac9
MW
8For interested developers, we have a public repository. To check out and
9compile the code, you need the following tools:
10
11 - Subversion (1.3.1)
12 - a recent GNU C complier (gcc-3.4.6)
13 - recent autotools (autoconf-2.59, automake-1.9.6, libtool-1.5.22)
14 - the usual strongSwan dependencies (gmp >= 4.1.4, optional curl, ldap)
15 - perl (5.8.8)
16 - lex (flex-2.5.33)
17 - yacc (bison-2.1)
18 - gperf (3.0.1)
19 - Doxygen (1.4.6)
20
21The numbers in brackets represent the versions used on our development systems,
22other version MAY work, too. Not all tools are checked by the configure script,
23as they are not needed in the tarball distributions, so check them manually.
24
25To check out the trunk, use:
26
27 svn co http://www.strongswan.org/ikev2/trunk strongswan
28
29After a successful check out, give the autotools a try:
30
31 cd strongswan/
32 ./autogen.sh
33
34Then you're in, start the build as usual:
35
36 ./configure [options]
37 make
38 make install
4986554f
MW
39
40
432b298e
MW
41API documentation
42-----------------
e3606f2b
MW
43Charon and libstrongswan contain inline code documentation. These comments can
44be extracted using doxygen. It is built using 'make apidoc', which creates an
45'apidoc' folder containing the HTML files.
432b298e
MW
46
47
4986554f
MW
48uClibc support
49--------------
50
432b298e 51To run strongSwan on uClibc, you need at least:
4986554f
MW
52
53String and Stdio Support --->
54 [*] Support glibc's register_printf_function()
4986554f
MW
55General Library Settings --->
56 [*] Support global constructors and destructors
57
9e3e46a5 58It is fairly untested yet, so don't except to get it running without
4986554f 59further tweaks.