Skip to content

Commit 0058cc8

Browse files
authored
[libc++] Add documentation for the new comment-triggered benchmarking bot (#158167)
The new benchmarking bot is experimental and is very rough on the edges.
1 parent dd8767b commit 0058cc8

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

libcxx/docs/TestingLibcxx.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -531,6 +531,16 @@ Finally, use ``compare-benchmarks`` to compare both:
531531
The ``compare-benchmarks`` script provides some useful options like creating a chart to easily visualize
532532
differences in a browser window. Use ``compare-benchmarks --help`` for details.
533533

534+
Additionally, adding a comment of the following form to a libc++ PR will cause the specified benchmarks to be run
535+
on our pre-commit CI infrastructure and the results to be reported in the PR by our CI system:
536+
537+
.. code-block::
538+
539+
/libcxx-bot benchmark <path/to/benchmark1.bench.cpp> <path/to/benchmark2.bench.cpp> ...
540+
541+
Note that this is currently experimental and the results should not be relied upon too strongly, since
542+
we do not have dedicated hardware to run the benchmarks on.
543+
534544
.. _`Google Benchmark`: https://github.com/google/benchmark
535545

536546
.. _testing-hardening-assertions:

0 commit comments

Comments
 (0)