summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAlexei Cazacov <[email protected]>2025-05-13 16:22:45 +0300
committerAlexei Cazacov <[email protected]>2025-06-26 11:58:26 +0300
commit8def878a59982d9a378cf0e3975cda86627f086e (patch)
tree14ec6cbd164a2ccd2576bda4cc1211e911d939aa
parent91fe5b358e211aa308effacb95ea2dc1d75590b0 (diff)
Doc: Update the benchmarking option descriptionsHEADdev
This commit adds a `perf` option description and mentions that the `tickcounter` options requires a hardware support. Fixes: QTBUG-134795 Pick-to: 6.10 6.9 6.8 Change-Id: I8462073850b6811508776b40e867e62eb88f78e7 Reviewed-by: Dennis Oberst <[email protected]>
-rw-r--r--src/testlib/doc/src/qttestlib-manual.qdoc8
1 files changed, 5 insertions, 3 deletions
diff --git a/src/testlib/doc/src/qttestlib-manual.qdoc b/src/testlib/doc/src/qttestlib-manual.qdoc
index 65bdd96e784..78157afa151 100644
--- a/src/testlib/doc/src/qttestlib-manual.qdoc
+++ b/src/testlib/doc/src/qttestlib-manual.qdoc
@@ -373,9 +373,11 @@
\list
\li \c -callgrind \br
- Uses Callgrind to time benchmarks (Linux only).
+ Uses Callgrind to time benchmarks (Linux and \macos).
+ \li \c -perf \br
+ Uses Linux perf events to time benchmarks
\li \c -tickcounter \br
- Uses CPU tick counters to time benchmarks.
+ Uses CPU tick counters to time benchmarks. Requires hardware support.
\li \c -eventcounter \br
Counts events received during benchmarks.
\li \c -minimumvalue \e n \br
@@ -452,7 +454,7 @@
The code inside the QBENCHMARK macro will be measured, and possibly also repeated
several times in order to get an accurate measurement. This depends on the selected
measurement back-end. Several back-ends are available. They can be selected on the
- command line:
+ command line (see \l{Benchmarking Options}):
\target testlib-benchmarking-measurement