perf test: Document the -w/--workload option

Wasn't documented so far, mention that it is mostly used in the shell
regression tests.

Signed-off-by: Arnaldo Carvalho de Melo <acme@redhat.com>
Reviewed-by: James Clark <james.clark@linaro.org>
Cc: Thomas Gleixner <tglx@linutronix.de>
Cc: Clark Williams <williams@redhat.com>
Link: https://lore.kernel.org/r/20241020021842.1752770-4-acme@kernel.org
Signed-off-by: Namhyung Kim <namhyung@kernel.org>

diff --git a/tools/perf/Documentation/perf-test.txt b/tools/perf/Documentation/perf-test.txt
index 9acb8d1f658890e9af9999f3fd93e20466c04cd6..efcdec528a8f7243f24b55577b3ead3769d724f7 100644 (file)
--- a/tools/perf/Documentation/perf-test.txt
+++ b/tools/perf/Documentation/perf-test.txt
@@ -48,3 +48,20 @@ OPTIONS
 
 --dso::
        Specify a DSO for the "Symbols" test.
+
+-w::
+--workload=::
+       Run a built-in workload, to list them use '--list-workloads', current ones include:
+       noploop, thloop, leafloop, sqrtloop, brstack, datasym and landlock.
+
+       Used with the shell script regression tests.
+
+       Some accept an extra parameter:
+
+               seconds: leafloop, noploop, sqrtloop, thloop
+               nrloops: brstack
+
+       The datasym and landlock workloads don't accept any.
+
+--list-workloads::
+       List the available workloads to use with -w/--workload.