Update documentation.
authorGuus Sliepen <guus@tinc-vpn.org>
Fri, 18 May 2007 11:54:16 +0000 (11:54 +0000)
committerGuus Sliepen <guus@tinc-vpn.org>
Fri, 18 May 2007 11:54:16 +0000 (11:54 +0000)
NEWS
README
doc/tinc.texi

diff --git a/NEWS b/NEWS
index 1183ab7..2ad93e5 100644 (file)
--- a/NEWS
+++ b/NEWS
@@ -1,3 +1,9 @@
+Version 1.1-cvs              Work in progress
+
+ * Use libevent to handle I/O events and timeouts.
+
+ * Use splay trees instead of AVL trees.
+
 Version 1.0.8                May 16 2007
 
  * Fixed some memory and resource leaks.
diff --git a/README b/README
index 1f523d7..b7ba7b6 100644 (file)
--- a/README
+++ b/README
@@ -1,4 +1,4 @@
-This is the README file for tinc version 1.0.8. Installation
+This is the README file for tinc version 1.1-cvs. Installation
 instructions may be found in the INSTALL file.
 
 tinc is Copyright (C) 1998-2007 by:
@@ -55,7 +55,7 @@ should be changed into "Device", and "Device" should be changed into
 Compatibility
 -------------
 
-Version 1.0.8 is compatible with 1.0pre8, 1.0 and later, but not with older
+Version 1.1-cvs is compatible with 1.0pre8, 1.0 and later, but not with older
 versions of tinc.
 
 
@@ -78,6 +78,9 @@ Since 1.0, the lzo library is also used for optional compression. You need this
 library whether or not you plan to enable compression. You can find it at
 http://www.oberhumer.com/opensource/lzo/.
 
+Since 1.1, the libevent library is used for the main event loop. You can find
+it at http://monkey.org/~provos/libevent/.
+
 In order to compile tinc, you will need a GNU C compiler environment.
 
 
index 35b5e69..c968eb3 100644 (file)
@@ -43,7 +43,7 @@ permission notice identical to this one.
 @cindex copyright
 This is the info manual for @value{PACKAGE} version @value{VERSION}, a Virtual Private Network daemon.
 
-Copyright @copyright{} 1998-2006 Ivo Timmermans,
+Copyright @copyright{} 1998-2007 Ivo Timmermans,
 Guus Sliepen <guus@@tinc-vpn.org> and
 Wessel Dankers <wsl@@tinc-vpn.org>.
 
@@ -389,6 +389,7 @@ having them installed, configure will give you an error message, and stop.
 * OpenSSL::
 * zlib::
 * lzo::
+* libevent::
 @end menu
 
 
@@ -501,6 +502,27 @@ make sure you build development and runtime libraries (which is the
 default).
 
 
+@c ==================================================================
+@node       libevent
+@subsection libevent
+
+@cindex libevent
+For the main event loop, tinc uses the libevent library.
+
+If this library is not installed, you wil get an error when configuring
+tinc for build.
+
+You can use your operating system's package manager to install this if
+available.  Make sure you install the development AND runtime versions
+of this package.
+
+If you have to install libevent manually, you can get the source code
+from @url{http://monkey.org/~provos/libevent/}.  Instructions on how to configure,
+build and install this package are included within the package.  Please
+make sure you build development and runtime libraries (which is the
+default).
+
+
 @c
 @c
 @c