[libc++] Add documentation for the new comment-triggered benchmarking bot #158167
+10
−0
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
llvmbot
added
the
libc++
|
@llvm/pr-subscribers-libcxx Author: Louis Dionne (ldionne) ChangesThe new benchmarking bot is experimental and is very rough on the edges. Full diff: https://github.com/llvm/llvm-project/pull/158167.diff 1 Files Affected:
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
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:
|
|
/libcxx-bot benchmark libcxx/test/benchmarks/containers/sequence/vector.bench.cpp Benchmark results: |
|
Let's hope it works like it did during my testing :) CI job running the benchmarks: https://github.com/llvm/llvm-project/actions/runs/17660356184/job/50192377946 |
ldionne
force-pushed
the
review/document-new-performance-buildbot
branch
from
7482317 to
def5b8d
Compare
|
Another try (https://github.com/llvm/llvm-project/actions/runs/17660748509) /libcxx-bot benchmark libcxx/test/benchmarks/join_view.bench.cpp libcxx/test/benchmarks/hash.bench.cpp Benchmark results:Benchmark results: |
|
/libcxx-bot benchmark libcxx/test/benchmarks |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The new benchmarking bot is experimental and is very rough on the edges.