[libcxx-commits] [libcxx] 0058cc8 - [libc++] Add documentation for the new comment-triggered benchmarking bot (#158167)

[via libcxx-commits]

Author: Louis Dionne
Date: 2025-09-15T08:44:51-04:00
New Revision: 0058cc81f14bc76d1c81ba3bd20d9e341e047277

URL: https://github.com/llvm/llvm-project/commit/0058cc81f14bc76d1c81ba3bd20d9e341e047277
DIFF: https://github.com/llvm/llvm-project/commit/0058cc81f14bc76d1c81ba3bd20d9e341e047277.diff

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

The new benchmarking bot is experimental and is very rough on the edges.

Added: 
    

Modified: 
    libcxx/docs/TestingLibcxx.rst

Removed: 
    


################################################################################
diff  --git a/libcxx/docs/TestingLibcxx.rst b/libcxx/docs/TestingLibcxx.rst
index 44463385b81a7..227791031bab0 100644
--- a/libcxx/docs/TestingLibcxx.rst
+++ b/libcxx/docs/TestingLibcxx.rst
@@ -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
 
diff erences 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: