X-Git-Url: https://git.strongswan.org/?p=strongswan.git;a=blobdiff_plain;f=HACKING;h=b87faa3a786d60ba09a9a267a18b31ec9f1b8fd2;hp=17925545d6a5d8cafdf4ecc056eb837a9b7fd031;hb=1bd02e864c41f60625f6d7a7c1220b3c99f4120c;hpb=4986554f1a30d70ccb0d060be77367119561a383 diff --git a/HACKING b/HACKING index 1792554..b87faa3 100644 --- a/HACKING +++ b/HACKING @@ -38,19 +38,22 @@ Then you're in, start the build as usual: make install +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. + + uClibc support -------------- -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: +To run strongSwan on uClibc, you need at least: 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 -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 +It is fairly untested yet, so don't except to get it running without further tweaks.