documentation: Cleanup and clarification

This change clarifies some of the built-in sd_event behavior and points
the reader to the relevant sd_event documentation where applicable.

Change-Id: Ic12d6a2d4364aa529240660a532af2bde4a4d89f
Signed-off-by: William A. Kennington III <wak@google.com>
4 files changed
tree: 8cd2532013466e2de2e7e6c8398bee732d13a751
  1. example/
  2. src/
  3. test/
  4. .clang-format
  5. .gitignore
  6. .lcovrc
  7. bootstrap.sh
  8. configure.ac
  9. LICENSE
  10. MAINTAINERS
  11. Makefile.am
  12. README.md
README.md

sdeventplus

sdeventplus is a c++ wrapper around the systemd sd_event apis meant to provide c++ ergonomics to their usage.

Dependencies

The sdeventplus library requires libsystemd for sd-event.

Test cases require google{test,mock}, valgrind, and lcov.

Building

For a standard release build, you want something like:

./bootstrap.sh
./configure --disable-tests
make
make install

For a test / debug build, a typical configuration is

./bootstrap.sh
./configure --enable-tests --enable-coverage --enable-valgrind
make
make check
make check-valgrind
make check-code-coverage