Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / stdplus / 7d75a48513560d8735bb3d795bb8872af276ee43
commit7d75a48513560d8735bb3d795bb8872af276ee43[log] [tgz]
authorWilliam A. Kennington III <wak@google.com>Thu Jun 27 15:25:41 2019 -0700
committerWilliam A. Kennington III <wak@google.com>Thu Jun 27 15:31:30 2019 -0700
treed83fe7c2ddfc344ec75c47294e8ba80e40c70d61
parent8f1700e7ab886ed602c371265ff2c653a2deb485 [diff]
README: Expand documentation to include an overview of repo contents

Change-Id: Id719a64f69de8cb5d08efc8c7d1b654790bb32fb
Signed-off-by: William A. Kennington III <wak@google.com>
1 file changed
tree: d83fe7c2ddfc344ec75c47294e8ba80e40c70d61
  1. example/
  2. src/
  3. test/
  4. .clang-format
  5. .lcovrc
  6. LICENSE
  7. MAINTAINERS
  8. meson.build
  9. meson_options.txt
  10. README.md
README.md

stdplus

stdplus is a c++ project containing commonly used classes and functions for the Linux platform. Note the goals of this project are to implement only the minimum set of features needed by the OpenBMC project and other users. You may find the included set of functions currently quite sparse.

This project provides the following primitives:

  • A movable and copyable RAII helper wrapper which is used for wrapping c-native types that have custom destruction or copy reference logic.
  • Functions for trivially configuring signals without having to do the normal signal set operations from libc
  • C-Style Error Handler that wrap c-style functions which return errnos and negative error values into functions that throw c++ exceptions.

Dependencies

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

Building

For a standard release build, you want something like:

./bootstrap.sh
./configure --disable-examples --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