[libcxx-commits] [libcxx] e84f79e - [libc++][docs] Use --show-all in the sample command-line to run benchmarks
Louis Dionne via libcxx-commits
libcxx-commits at lists.llvm.org
Thu Dec 5 12:52:07 PST 2024
Author: Louis Dionne
Date: 2024-12-05T15:52:02-05:00
New Revision: e84f79e925bf49600e24e0d11e20c282037e4a2c
URL: https://github.com/llvm/llvm-project/commit/e84f79e925bf49600e24e0d11e20c282037e4a2c
DIFF: https://github.com/llvm/llvm-project/commit/e84f79e925bf49600e24e0d11e20c282037e4a2c.diff
LOG: [libc++][docs] Use --show-all in the sample command-line to run benchmarks
It's really not useful at all to run benchmarks without --show-all since
you don't get the benchmark output. And since --show-all is the suggested
default way to run benchmarks, it's not necessary anymore to mention it
right below.
Added:
Modified:
libcxx/docs/TestingLibcxx.rst
Removed:
################################################################################
diff --git a/libcxx/docs/TestingLibcxx.rst b/libcxx/docs/TestingLibcxx.rst
index 6d2c954489f62e..cf092fabd046f5 100644
--- a/libcxx/docs/TestingLibcxx.rst
+++ b/libcxx/docs/TestingLibcxx.rst
@@ -452,12 +452,7 @@ when running the benchmarks. For example,
.. code-block:: bash
- $ libcxx/utils/libcxx-lit <build> -sv libcxx/test/benchmarks/string.bench.cpp --param optimization=speed
-
-If you want to see where a benchmark is located (e.g. you want to store the executable
-for subsequent analysis), you can print that information by passing ``--show-all`` to
-``lit``. That will print the command-lines being executed, which includes the location
-of the executable created for that benchmark.
+ $ libcxx/utils/libcxx-lit <build> libcxx/test/benchmarks/string.bench.cpp --show-all --param optimization=speed
Note that benchmarks are only dry-run when run via the ``check-cxx`` target since
we only want to make sure they don't rot. Do not rely on the results of benchmarks
More information about the libcxx-commits
mailing list