*** empty log message ***

[software/libev.git] / README.embed

diff --git a/README.embed b/README.embed
index 3e37f05d54d39d01c8acd1f402cef8e060b9bdb9..7712102f5d5bea57ba428d42991ea1251ca4f5ad 100644 (file)
--- a/README.embed
+++ b/README.embed
@@ -8,6 +8,8 @@ EMBEDDING THE LIBEV CODE INTO YOUR OWN PROGRAMS
 
 FILESETS
 
+    CORE EVENT LOOP
+
     To include only the libev core (all the ev_* functions):
 
         #define EV_STANDALONE   1
@@ -27,6 +29,16 @@ FILESETS
         ev.c
         ev_vars.h
         ev_wrap.h
+        ev_win32.c
+
+        ev_select.c     only when select backend is enabled (which is by default)
+        ev_poll.c       only when poll backend is enabled (disabled by default)
+        ev_epoll.c      only when the epoll backend is enabled (disabled by default)
+        ev_kqueue.c     only when the kqueue backend is enabled (disabled by default)
+
+    "ev.c" includes the backend files directly when enabled.
+
+    LIBEVENT COMPATIBILITY API
 
     To include the libevent compatibility API, also include:
 
@@ -114,7 +126,7 @@ PREPROCESSOR SYMBOLS
 
            #define EV_COMMON                       \
              SV *self; /* contains this struct */  \
-             SV *cb_sv, *fh;
+             SV *cb_sv, *fh /* note no trailing ";" */
 
     EV_PROTOTYPES
 
@@ -133,8 +145,10 @@ PREPROCESSOR SYMBOLS
 
 EXAMPLES
 
-    For a real-world example of a program the includes libev verbatim, you
-    can have a look at the EV perl module (http://software.schmorp.de/pkg/EV.html).
-    It has the libev files in the liev/ subdirectory and includes them in the
-    EV.xs files. Only this file will be compiled.
+    For a real-world example of a program the includes libev
+    verbatim, you can have a look at the EV perl module
+    (http://software.schmorp.de/pkg/EV.html).  It has the libev files in
+    the libev/ subdirectory and includes them in the EV/EVAPI.h (public
+    interface) and EV.xs (implementation) files. Only the EV.xs file will
+    be compiled.