Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / stdplus / 3b4c20fe517c23fbe8d1418ee3cdb98b59b2fd30
commit3b4c20fe517c23fbe8d1418ee3cdb98b59b2fd30[log] [tgz]
authorBrandon Kim <brandonkim@google.com>Thu Feb 06 16:08:31 2020 -0800
committerBrandon Kim <brandonkim@google.com>Thu Feb 06 16:29:09 2020 -0800
tree6c6401c868ef4fa9fa1545c726c422a2a13355e5
parentf1c46f813fed48f18c4f846d597df5e87a91b5d0 [diff]
README.md: Update documentation for using meson

The README was outdated and was pointing to using automake instead of
meson.

Change-Id: Id8dcf2cdb1a5546a56e77328342779e10cedea20
Signed-off-by: Brandon Kim <brandonkim@google.com>
1 file changed
tree: 6c6401c868ef4fa9fa1545c726c422a2a13355e5
  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.
  • String Utilities that focus on providing helpful wrappers like efficient string append and concatenation.

Dependencies

Test cases require google{test,mock}, valgrind, and lcov. It also requires the Meson Build System which can be installed following the instructions at mesonbuild.com.

Building

For a standard release build, you want something like:

meson setup -Dexamples=false -Dtests=disabled builddir
ninja -C builddir
ninja -C builddir install

For a test / debug build, a typical configuration is

meson setup -Dtests=enabled builddir
meson test -C builddir