mirror of
https://fuchsia.googlesource.com/third_party/pigweed.googlesource.com/pigweed/pigweed
synced 2024-09-20 13:51:05 +00:00
051673443f
pw_perf_test is an upcoming module that will be similar to unit_test but will instead display performance data. A small overview of the timing interface is provided in pw_perf_test/docs.rst. Change-Id: I74798931b769e99b3b4c7822c9b467db96b7883c Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/112971 Reviewed-by: Wyatt Hepler <hepler@google.com> Commit-Queue: Brian Barcenas <bbarcenas@google.com>
21 lines
694 B
ReStructuredText
21 lines
694 B
ReStructuredText
.. _module-pw_perf_test:
|
|
|
|
============
|
|
pw_perf_test
|
|
============
|
|
Pigweed's perf test module provides an easy way to measure performance on
|
|
any test setup. By using an API similar to GoogleTest, this module aims to bring
|
|
a robust and intuitive testing framework to our users.
|
|
|
|
.. note::
|
|
This module is still under construction. Some features may not be available
|
|
yet.
|
|
|
|
---------
|
|
Timer API
|
|
---------
|
|
In order to provide meaningful performance timings for given functions, events,
|
|
etc a timing interface must be implemented from scratch to be able to provide
|
|
for the testing needs. The timing API meets these needs by implementing
|
|
either clock cycle record keeping or second based recordings.
|