X-Git-Url: https://git.strongswan.org/?p=strongswan.git;a=blobdiff_plain;f=HACKING;h=3b24558a9bb80b7a4d63027a3cba6d8dffe68bde;hp=17925545d6a5d8cafdf4ecc056eb837a9b7fd031;hb=ecdbab8a2015c1365d4cb123b808746b5cd374f2;hpb=4986554f1a30d70ccb0d060be77367119561a383 diff --git a/HACKING b/HACKING index 1792554..3b24558 100644 --- a/HACKING +++ b/HACKING @@ -2,29 +2,31 @@ strongSwan - Development ------------------------- -Subversion repository +Git repository --------------------- For interested developers, we have a public repository. To check out and compile the code, you need the following tools: - - Subversion (1.3.1) - - a recent GNU C complier (gcc-3.4.6) - - recent autotools (autoconf-2.59, automake-1.9.6, libtool-1.5.22) - - the usual strongSwan dependencies (gmp >= 4.1.4, optional curl, ldap) - - perl (5.8.8) - - lex (flex-2.5.33) - - yacc (bison-2.1) - - gperf (3.0.1) - - Doxygen (1.4.6) + - Git + - a recent GNU C compiler (>= 3.x) + - automake + - autoconf + - libtool + - gettext + - perl + - lex/flex + - yacc/bison + - gperf + - optionally Doxygen -The numbers in brackets represent the versions used on our development systems, -other version MAY work, too. Not all tools are checked by the configure script, -as they are not needed in the tarball distributions, so check them manually. +To check out the master branch, use: -To check out the trunk, use: + git clone git://git.strongswan.org/strongswan.git - svn co http://www.strongswan.org/ikev2/trunk strongswan + or using HTTP + + git clone http://git.strongswan.org/strongswan.git After a successful check out, give the autotools a try: @@ -38,19 +40,18 @@ Then you're in, start the build as usual: make install -uClibc support --------------- +API documentation +----------------- + +Charon and libstrongswan contain inline code documentation. These comments can +be extracted using doxygen. It is built using 'make apidoc', which creates an +'apidoc' folder containing the HTML files. + +strongSwan wiki +--------------- -Support for uClibc is still work in progress. To get startet with strongSwan -on uClibc, yoou need version which supports getifaddrs ( > 0.9.28). -Additionally, you need the at least the following options: +A wiki for users and developers, including ticket system and source browser +is available at -String and Stdio Support ---> - [*] Support glibc's register_printf_function() - [*] Support the '%m' specifier in printf format strings -General Library Settings ---> - [*] Support global constructors and destructors + http://wiki.strongswan.org -We must reduce the number of printf handlers, as uClibc only supports 10 of -them. It is fairly untested yet, so don't except to get it running without -further tweaks.