*** empty log message ***

[software/libev.git] / README.embed

diff --git a/README.embed b/README.embed
index caf11451912beecc7d5e58a2198655af40683969..cc908a104775fab536934e3a3d78d3add5346b72 100644 (file)
--- a/README.embed
+++ b/README.embed
@@ -1,6 +1,6 @@
 EMBEDDING THE LIBEV CODE INTO YOUR OWN PROGRAMS
 
 EMBEDDING THE LIBEV CODE INTO YOUR OWN PROGRAMS
 

-    Instead of building the libev library you cna also include the code
+    Instead of building the libev library you can also include the code

     as-is into your programs. To update, you only have to copy a few files
     into your source tree.
 
     as-is into your programs. To update, you only have to copy a few files
     into your source tree.
 


@@ -17,11 +17,17 @@ FILESETS
 
     This will automatically include ev.h, too, and should be done in a
     single C source file only to provide the function implementations. To
 
     This will automatically include ev.h, too, and should be done in a
     single C source file only to provide the function implementations. To

-    use it, do the same for ev.h in all users:
+    use it, do the same for ev.h in all files wishing to use this API
+    (best done by writing a wrapper around ev.h that you can include
+    instead and where you can put other configuration options):

 
         #define EV_STANDALONE   1
         #include "ev.h"
 
 
         #define EV_STANDALONE   1
         #include "ev.h"
 

+    Both header files and implementation files can be compiled with a C++
+    compiler (at least, thats a stated goal, and breakage will be treated
+    as a bug).
+

     You need the following files in your source tree, or in a directory
     in your include path (e.g. in libev/ when using -Ilibev):
 
     You need the following files in your source tree, or in a directory
     in your include path (e.g. in libev/ when using -Ilibev):
 


@@ -31,7 +37,7 @@ FILESETS
         ev_wrap.h
         ev_win32.c
 
         ev_wrap.h
         ev_win32.c
 

-        ev_select.c     only when select backend is enabled (which is by default)
+        ev_select.c     only when select backend is enabled (which is 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_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)


@@ -92,6 +98,15 @@ PREPROCESSOR SYMBOLS
        done: if no other method takes over, select will be it. Otherwise
        the select backend will not be compiled in.
 
        done: if no other method takes over, select will be it. Otherwise
        the select backend will not be compiled in.
 

+    EV_SELECT_USE_WIN32_HANDLES
+
+       When defined to 1, the select backend will assume that select
+       doesn't understand file descriptors but wants osf handles on
+       win32 (this is the case when the select to be used is the winsock
+       select). This means that it will call _get_osfhandle on the fd to
+       convert it to an OS handle. Should not be defined on non-win32
+       platforms.
+

     EV_USE_POLL
 
        If defined to be "1", libev will compile in support for the poll(2)
     EV_USE_POLL
 
        If defined to be "1", libev will compile in support for the poll(2)


@@ -126,7 +141,7 @@ PREPROCESSOR SYMBOLS
 
            #define EV_COMMON                       \
              SV *self; /* contains this struct */  \
 
            #define EV_COMMON                       \
              SV *self; /* contains this struct */  \

-             SV *cb_sv, *fh;
+             SV *cb_sv, *fh /* note no trailing ";" */

 
     EV_PROTOTYPES
 
 
     EV_PROTOTYPES