public inbox for linux-kernel@vger.kernel.org
 help / color / mirror / Atom feed
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 3/4] docs: admin-guide: clarify perf bench all behavior
Date: Tue, 5 May 2026 12:27:31 -0600	[thread overview]
Message-ID: <186589b6-192a-4904-bc8b-7fd79af0d76f@linuxfoundation.org> (raw)
In-Reply-To: <20260503101429.254394-4-hank20010209@gmail.com>

On 5/3/26 04:14, Cheng-Han Wu wrote:
> The workload tracing guide lists a fixed set of benchmarks for
> "perf bench all". This list is stale and can become outdated when
> perf adds, removes, or renames benchmark collections or individual
> benchmarks.
> 
> Describe "perf bench all" as running all available benchmarks in the perf
> bench framework instead. Also document how to list the collections and
> benchmarks available on a given system.
> 
> Signed-off-by: Cheng-Han Wu <hank20010209@gmail.com>
> ---
>   .../admin-guide/workload-tracing.rst          | 20 +++++++++++++------
>   1 file changed, 14 insertions(+), 6 deletions(-)
> 
> diff --git a/Documentation/admin-guide/workload-tracing.rst b/Documentation/admin-guide/workload-tracing.rst
> index 43a3c8098654..c49c2a00a8b8 100644
> --- a/Documentation/admin-guide/workload-tracing.rst
> +++ b/Documentation/admin-guide/workload-tracing.rst
> @@ -243,13 +243,21 @@ which can help mitigate performance regressions. It also acts as a common
>   benchmarking framework, enabling developers to easily create test cases,
>   integrate transparently, and use performance-rich tooling.
>   
> -"perf bench all" command runs the following benchmarks:
> +"perf bench all" runs all available benchmarks in the perf bench
> +framework. The exact set of benchmarks depends on the perf version and on
> +the features enabled when perf was built.
>   
> - * sched/messaging
> - * sched/pipe
> - * syscall/basic
> - * mem/memcpy
> - * mem/memset
> +To list the benchmark collections available on the current system, run::
> +
> +  perf bench
> +
> +To list benchmarks in a collection, run::
> +
> +  perf bench <collection>
> +
> +For example, to list the benchmarks in the mem collection, run::
> +
> +  perf bench mem
>   
>   What is stress-ng and how do we use it?
>   =======================================

Looks to good to me.

Reviewed-by: Shuah Khan <skhan@linuxfoundation.org>

thanks,
-- Shuah

  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
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 [this message]
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=186589b6-192a-4904-bc8b-7fd79af0d76f@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