]> git.ipfire.org Git - thirdparty/kernel/linux.git/commitdiff
docs: admin-guide: fix stress-ng command examples
authorCheng-Han Wu <hank20010209@gmail.com>
Sun, 3 May 2026 10:14:27 +0000 (18:14 +0800)
committerJonathan Corbet <corbet@lwn.net>
Fri, 15 May 2026 14:48:28 +0000 (08:48 -0600)
The workload tracing guide includes stress-ng command examples with a
stray "command." word at the end. This makes the examples invalid if they
are copied and run directly.

Remove the stray word from the stress-ng example. Also use "--" in the
perf record example to clearly separate perf record options from the
workload command being recorded.

Signed-off-by: Cheng-Han Wu <hank20010209@gmail.com>
Reviewed-by: Shuah Khan <skhan@linuxfoundation.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Message-ID: <20260503101429.254394-3-hank20010209@gmail.com>

Documentation/admin-guide/workload-tracing.rst

index 22cb05025ffcb6ab1fb4749ba9faeacd7770d3be..43a3c8098654a08538a11bb33e72d41cd624405e 100644 (file)
@@ -271,7 +271,7 @@ exercised:
 
 The following command runs the stressor::
 
-  stress-ng --netdev 1 -t 60 --metrics command.
+  stress-ng --netdev 1 -t 60 --metrics
 
 We can use the perf record command to record the events and information
 associated with a process. This command records the profiling data in the
@@ -281,7 +281,7 @@ Using the following commands you can record the events associated with the
 netdev stressor, view the generated report perf.data and annotate the output
 to view the statistics of each instruction of the program::
 
-  perf record stress-ng --netdev 1 -t 60 --metrics command.
+  perf record -- stress-ng --netdev 1 -t 60 --metrics
   perf report
   perf annotate