Skip to content

[libc++] Add documentation for the new comment-triggered benchmarking bot #158167

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 15, 2025
+10 −0
Merged

[libc++] Add documentation for the new comment-triggered benchmarking bot #158167

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions libcxx/docs/TestingLibcxx.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -531,6 +531,16 @@ Finally, use ``compare-benchmarks`` to compare both:
The ``compare-benchmarks`` script provides some useful options like creating a chart to easily visualize
differences in a browser window. Use ``compare-benchmarks --help`` for details.

Additionally, adding a comment of the following form to a libc++ PR will cause the specified benchmarks to be run
on our pre-commit CI infrastructure and the results to be reported in the PR by our CI system:

.. code-block::

/libcxx-bot benchmark <path/to/benchmark1.bench.cpp> <path/to/benchmark2.bench.cpp> ...

Note that this is currently experimental and the results should not be relied upon too strongly, since
we do not have dedicated hardware to run the benchmarks on.

.. _`Google Benchmark`: https://github.com/google/benchmark

.. _testing-hardening-assertions:
Expand Down
Loading