src/util/k5ev/README

   1 This directory builds a private libverto module using an embedded
   2 libev with renamed symbols (so we don't leak libev symbols into the
   3 namespace on platforms where we can't control the export list).
   4
   5 libev has built-in support for this kind of embedding, so we don't
   6 have to modify the libev sources.  Following libev's documentation,
   7 the following files have been copied from the ev sources:
   8
   9   ev.h
  10   ev_vars.h
  11   ev_wrap.h
  12   ev.c
  13   ev_select.c
  14   ev_poll.c
  15   ev_win32.c
  16   Symbols.ev
  17
  18 (Symbols.ev wasn't included in the 4.04 tar file due to an oversight,
  19 so it is taken from the appropriate tag in libev's source repository.)
  20
  21 To rename the exported symbols, we create rename.h from Symbols.ev.
  22 We also use Symbols.ev to construct the library export list.
  23 (Renaming libev's symbols would be unnecessary if libev's embedding
  24 had support for making its API symbols static, but it currently does
  25 not.)  The source file verto-k5ev.c wraps ev.c with appropriate
  26 embedding defines, and then defines the libverto module functions
  27 using the slightly modified contents of libverto's verto-ev.c.
  28
  29 The libev upstream project page is at:
  30
  31   http://software.schmorp.de/pkg/libev.html