third_party.pigweed.src/pw_chrono_stl/docs.rst
Ewout van Bekkum 01a32af06a pw_chrono_stl: small docs fixup
Change-Id: I2665b848676166fe0d312ce543900dace8395a5e
Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/26340
Reviewed-by: Armando Montanez <amontanez@google.com>
Commit-Queue: Ewout van Bekkum <ewout@google.com>
2020-12-01 22:19:24 +00:00

29 lines
929 B
ReStructuredText

.. _module-pw_chrono_stl:
-------------
pw_chrono_stl
-------------
``pw_chrono_stl`` is a collection of ``pw_chrono`` backends that are implemented
using STL's ``std::chrono`` library.
.. warning::
This module is under construction, not ready for use, and the documentation
is incomplete.
SystemClock backend
-------------------
The STL based ``system_clock`` backend implements the ``pw_chrono:system_clock``
facade by using the ``std::chrono::steady_clock``. Note that the
``std::chrono::system_clock`` cannot be used as this is not always a monotonic
clock source.
See the documentation for ``pw_chrono`` for further details.
Build targets
-------------
The GN build for ``pw_chrono_stl`` has one target: ``system_clock``.
The ``system_clock`` target provides the
``pw_chrono_backend/system_clock_config.h`` and
``pw_chrono_backend/system_clock_inline.h`` headers and the backend for the
``pw_chrono:system_clock``.