third_party.pigweed.src/pw_minimal_cpp_stdlib/docs.rst
Wyatt Hepler 0412a7d8e5 pw_minimal_cpp_stdlib: Extremely limited C++ lib
pw_minimal_cpp_stdlib is an extremely limited, non-standard
implementation of the C++ Standard Library. It requires C++17 and a C
standard library.

Change-Id: I2d0b8d6cf49730e2c746eddf2c4a23308af1eb6a
2020-01-29 16:05:18 -08:00

32 lines
949 B
ReStructuredText

.. _chapter-pw-minimal-cpp-stdlib:
.. default-domain:: cpp
---------------------
pw_minimal_cpp_stdlib
---------------------
The pw_minimal_cpp_stdlib module provides an extremely limited implementation of
the C++ Standard Library. This module falls far, far short of providing a
complete C++ Standard Library and should only be used in dire situations where
you happen to be compiling with C++17 but don't have a C++ Standard Library
available to you.
The C++ Standard Library headers (e.g. ``<cstdint>`` and ``<type_traits>``) are
defined in ``public/``. These files are symlinks to their implementations in
``public/internal/``.
.. tip::
You can automatically recreate the symlinks in ``public/`` by executing the
following Bash code from ``pw_minimal_cpp_stdlib/public/``.
.. code-block:: bash
for f in $(ls internal/); do ln -s internal/$f ${f%.h}; done
Requirments
===========
- C++17
- gcc or clang
- The C Standard Library