Fix language.

[radsecproxy.git] / lib / HACKING

diff --git a/lib/HACKING b/lib/HACKING
index 7246d0e..36287b8 100644 (file)
--- a/lib/HACKING
+++ b/lib/HACKING
@@ -1,6 +1,6 @@
 HACKING file for libradsec (in Emacs -*- org -*- mode).
 
-Status as of libradsec-0.0.1 (2011-03-24).
+Status as of libradsec-0.0.2.dev (2011-03-24).
 
 * Build instructions
 cd libradsec/lib
@@ -12,18 +12,25 @@ examples/client -r examples/client.conf blocking-tls; echo $?
 
 * Design of the API
 - There are three usage modes
-  - You use the send and receive calls (blocking mode)
-  - You register callbacks and run the libevent dispatch loop (user
-    dispatch mode)
-  - You run your own event loop, using fd's for select and do the I/O
-    using the libradsec send/receive calls (on-your-own mode)
-- Fully reentrant (FIXME: any issues with libfreeradius-radius?)
+  - Application use the send and receive calls (blocking mode)
+  - Application registers callbacks and runs the libevent dispatch
+    loop (a.k.a. user dispatch mode)
+  - Application runs its own event loop, using fd's for select and
+    performs I/O using the libradsec send/receive calls
+    (a.k.a. on-your-own mode)
+- User chooses allocation regime
 
+Note that as of 0.0.2.dev libradsec suffers from way too much focus on
+the behaviour of a blocking client and is totally useless as a server.
+Not only does it lack most of the functions needed for writing a
+server but it also contains at least one architectural mishap which
+kills the server idea -- a connection timeout (TCP) or a retransmit
+timeout (UDP) will result in the event loop being broken.  The same
+thing will happen if there's an error on a TCP connection, f.ex. a
+failing certificate validation (TLS).
 * Dependencies
-The details below apply to Ubuntu 10.10.
+Details apply to Ubuntu 10.10.
 
-- libfreeradius-radius (2.1.9+dfsg-1ubuntu1)
-  sudo apt-get install libfreeradius-dev libfreeradius2
 - libconfuse (2.7-1)
   sudo apt-get install libconfuse-dev libconfuse0
 - libevent from source (release-2.0.10-stable)
@@ -39,24 +46,24 @@ The details below apply to Ubuntu 10.10.
 - [TCP] short read
 - [TCP] short write
 - [TLS] basic tls support
+- [TLS] preshared key support
+- [TLS] verification of CN
 ** Known issues
 - error stack is only one entry deep
+- custom allocation scheme is not used in all places
 ** Not implemented
-- custom allocation scheme used in all places
-  issue: libfreeradius-radius
 - server failover
-- [TLS] verification of CN
-- [TLS] preshared key support
 - [DTLS] support
 
 * Found a bug?
-If possible, please build the library with DEBUG defined
-(CFLAGS=-DDEBUG) and reproduce the problem.  With DEBUG defined, lots
-of asserts are enabled which might give a hint about what's gone
-wrong.
+Please report it.  This is how we improve the quality of the code.
+
+If possible, please build the library with DEBUG defined (CFLAGS="-g
+-DDEBUG") and reproduce the problem.  With DEBUG defined, lots of
+asserts are enabled which might give a hint about what's gone wrong.
 
 Running the library under gdb is another good idea.  If you experience
-a crash, catching that in gdb and providing a backtrace is highly
+a crash, catching it in gdb and providing a backtrace is highly
 valuable for debugging.
 
 Contact: mailto:linus+libradsec@nordu.net