From: Shuah Khan <skhan@linuxfoundation.org>
To: Cheng-Han Wu <hank20010209@gmail.com>, Jonathan Corbet <corbet@lwn.net>
Cc: Randy Dunlap <rdunlap@infradead.org>,
linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org,
Shuah Khan <skhan@linuxfoundation.org>
Subject: Re: [PATCH 2/4] docs: admin-guide: fix stress-ng command examples
Date: Tue, 5 May 2026 12:27:16 -0600 [thread overview]
Message-ID: <c3ae10f0-c409-4adb-af58-45fd7c8a530c@linuxfoundation.org> (raw)
In-Reply-To: <20260503101429.254394-3-hank20010209@gmail.com>
On 5/3/26 04:14, Cheng-Han Wu wrote:
> 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>
> ---
> Documentation/admin-guide/workload-tracing.rst | 4 ++--
> 1 file changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/Documentation/admin-guide/workload-tracing.rst b/Documentation/admin-guide/workload-tracing.rst
> index 22cb05025ffc..43a3c8098654 100644
> --- a/Documentation/admin-guide/workload-tracing.rst
> +++ b/Documentation/admin-guide/workload-tracing.rst
> @@ -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
>
Looks to good to me.
Reviewed-by: Shuah Khan <skhan@linuxfoundation.org>
thanks,
-- Shuah
next prev parent reply other threads:[~2026-05-05 18:27 UTC|newest]
Thread overview: 9+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-05-03 10:14 [PATCH 0/4] docs: admin-guide: improve workload tracing guide Cheng-Han Wu
2026-05-03 10:14 ` [PATCH 1/4] docs: admin-guide: fix typos in " Cheng-Han Wu
2026-05-05 18:26 ` Shuah Khan
2026-05-03 10:14 ` [PATCH 2/4] docs: admin-guide: fix stress-ng command examples Cheng-Han Wu
2026-05-05 18:27 ` Shuah Khan [this message]
2026-05-03 10:14 ` [PATCH 3/4] docs: admin-guide: clarify perf bench all behavior Cheng-Han Wu
2026-05-05 18:27 ` Shuah Khan
2026-05-03 10:14 ` [PATCH 4/4] docs: admin-guide: add IGNORE_DIRS example for cscope Cheng-Han Wu
2026-05-05 18:24 ` Shuah Khan
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=c3ae10f0-c409-4adb-af58-45fd7c8a530c@linuxfoundation.org \
--to=skhan@linuxfoundation.org \
--cc=corbet@lwn.net \
--cc=hank20010209@gmail.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=rdunlap@infradead.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox