From: Leandro Lucarella Date: Fri, 18 May 2007 19:02:58 +0000 (+0000) Subject: Update documentation about library stability. X-Git-Tag: 0.6~6 X-Git-Url: https://git.llucax.com/software/eventxx.git/commitdiff_plain/1530ce62134f3d9f8a127254b74665da7f5421a0 Update documentation about library stability. --- diff --git a/eventxx b/eventxx index 88ea47b..bbd6d4c 100644 --- a/eventxx +++ b/eventxx @@ -130,11 +130,11 @@ * * @section Status * - * This library has not been widely used yet, so it lacks proper testing. - * Because templates are not even compiled when they are not used, don't be - * surprised if you catch a piece of code that doesn't compile. The library - * has no support for buffered events yet. It doesn't support the HTTP stuff, - * and probably never will because that has nothing to do with event handling. + * This library has not been widely used yet, but it's used in some serious + * projects, so I think it's moderately stable now. The library has no support + * for buffered events yet, but patches are welcome. It doesn't support the + * HTTP stuff, and probably never will because that has nothing to do with + * event handling. * * If you notice that when using @eventxx your program leaks some memory, don't * blame me, blame @libevent :) @libevent has a known bug on @c event_base_free() @@ -142,19 +142,17 @@ * patch your libevent (for example, using this patch * written by Mark D. Anderson, and who knows why it's not still applied). If - * you do so, you can compile your programs with @c -DEVENTXX_EVENT_BASE_FREE_FIX - * so @c event_base_free() gets called in the eventxx::dispatcher @link - * eventxx::dispatcher::~dispatcher() destructor @endlink. - * - * That said, I think it's still pretty usable anyways. If something is broken - * it would be really easy to fix because @eventxx is just a simple wrapper - * around @libevent. So, please try it out, and if you have any problems, - * drop me an + * you do so, you can compile your programs with + * @c -DEVENTXX_EVENT_BASE_FREE_FIX so @c event_base_free() gets called in the + * eventxx::dispatcher @link eventxx::dispatcher::~dispatcher() destructor + * @endlink. + * + * If something is broken it would be really easy to fix because @eventxx is + * just a simple wrapper around @libevent. So, please try it out, and if you + * have any problems, drop me an * e-mail and and I'll fix it ASAP (or provide a patch and you will be my * best friend ;). * - * Patches to support buffered events are welcome too. - * * * @author Leandro Lucarella *