2024-05-21 22:36:31

by Ian Rogers

[permalink] [raw]
Subject: [PATCH v1] perf docs: Fix typos

Assorted typo fixes.

Signed-off-by: Ian Rogers <[email protected]>
---
tools/perf/Documentation/perf-kwork.txt | 4 ++--
tools/perf/Documentation/perf-mem.txt | 2 +-
tools/perf/Documentation/perf-record.txt | 2 +-
3 files changed, 4 insertions(+), 4 deletions(-)

diff --git a/tools/perf/Documentation/perf-kwork.txt b/tools/perf/Documentation/perf-kwork.txt
index 109ace1d5e90..21e607669d78 100644
--- a/tools/perf/Documentation/perf-kwork.txt
+++ b/tools/perf/Documentation/perf-kwork.txt
@@ -1,4 +1,4 @@
-perf-kowrk(1)
+perf-kwork(1)
=============

NAME
@@ -35,7 +35,7 @@ There are several variants of 'perf kwork':
perf kwork top
perf kwork top -b

- By default it shows the individual work events such as irq, workqeueu,
+ By default it shows the individual work events such as irq, workqueue,
including the run time and delay (time between raise and actually entry):

Runtime start Runtime end Cpu Kwork name Runtime Delaytime
diff --git a/tools/perf/Documentation/perf-mem.txt b/tools/perf/Documentation/perf-mem.txt
index 19862572e3f2..47456b212e99 100644
--- a/tools/perf/Documentation/perf-mem.txt
+++ b/tools/perf/Documentation/perf-mem.txt
@@ -21,7 +21,7 @@ and stores are sampled. Use the -t option to limit to loads or stores.

Note that on Intel systems the memory latency reported is the use-latency,
not the pure load (or store latency). Use latency includes any pipeline
-queueing delays in addition to the memory subsystem latency.
+queuing delays in addition to the memory subsystem latency.

On Arm64 this uses SPE to sample load and store operations, therefore hardware
and kernel support is required. See linkperf:perf-arm-spe[1] for a setup guide.
diff --git a/tools/perf/Documentation/perf-record.txt b/tools/perf/Documentation/perf-record.txt
index 6015fdd08fb6..77578c0a142a 100644
--- a/tools/perf/Documentation/perf-record.txt
+++ b/tools/perf/Documentation/perf-record.txt
@@ -311,7 +311,7 @@ OPTIONS
User can change the size by passing the size after comma like
"--call-graph dwarf,4096".

- When "fp" recording is used, perf tries to save stack enties
+ When "fp" recording is used, perf tries to save stack entries
up to the number specified in sysctl.kernel.perf_event_max_stack
by default. User can change the number by passing it after comma
like "--call-graph fp,32".
--
2.45.1.288.g0e0cd299f1-goog



2024-05-28 15:56:14

by James Clark

[permalink] [raw]
Subject: Re: [PATCH v1] perf docs: Fix typos



On 21/05/2024 23:35, Ian Rogers wrote:
> Assorted typo fixes.
>
> Signed-off-by: Ian Rogers <[email protected]>

Reviewed-by: James Clark <[email protected]>

> ---
> tools/perf/Documentation/perf-kwork.txt | 4 ++--
> tools/perf/Documentation/perf-mem.txt | 2 +-
> tools/perf/Documentation/perf-record.txt | 2 +-
> 3 files changed, 4 insertions(+), 4 deletions(-)
>
> diff --git a/tools/perf/Documentation/perf-kwork.txt b/tools/perf/Documentation/perf-kwork.txt
> index 109ace1d5e90..21e607669d78 100644
> --- a/tools/perf/Documentation/perf-kwork.txt
> +++ b/tools/perf/Documentation/perf-kwork.txt
> @@ -1,4 +1,4 @@
> -perf-kowrk(1)
> +perf-kwork(1)
> =============
>
> NAME
> @@ -35,7 +35,7 @@ There are several variants of 'perf kwork':
> perf kwork top
> perf kwork top -b
>
> - By default it shows the individual work events such as irq, workqeueu,
> + By default it shows the individual work events such as irq, workqueue,
> including the run time and delay (time between raise and actually entry):
>
> Runtime start Runtime end Cpu Kwork name Runtime Delaytime
> diff --git a/tools/perf/Documentation/perf-mem.txt b/tools/perf/Documentation/perf-mem.txt
> index 19862572e3f2..47456b212e99 100644
> --- a/tools/perf/Documentation/perf-mem.txt
> +++ b/tools/perf/Documentation/perf-mem.txt
> @@ -21,7 +21,7 @@ and stores are sampled. Use the -t option to limit to loads or stores.
>
> Note that on Intel systems the memory latency reported is the use-latency,
> not the pure load (or store latency). Use latency includes any pipeline
> -queueing delays in addition to the memory subsystem latency.
> +queuing delays in addition to the memory subsystem latency.
>
> On Arm64 this uses SPE to sample load and store operations, therefore hardware
> and kernel support is required. See linkperf:perf-arm-spe[1] for a setup guide.
> diff --git a/tools/perf/Documentation/perf-record.txt b/tools/perf/Documentation/perf-record.txt
> index 6015fdd08fb6..77578c0a142a 100644
> --- a/tools/perf/Documentation/perf-record.txt
> +++ b/tools/perf/Documentation/perf-record.txt
> @@ -311,7 +311,7 @@ OPTIONS
> User can change the size by passing the size after comma like
> "--call-graph dwarf,4096".
>
> - When "fp" recording is used, perf tries to save stack enties
> + When "fp" recording is used, perf tries to save stack entries
> up to the number specified in sysctl.kernel.perf_event_max_stack
> by default. User can change the number by passing it after comma
> like "--call-graph fp,32".

2024-05-29 19:27:26

by Namhyung Kim

[permalink] [raw]
Subject: Re: [PATCH v1] perf docs: Fix typos

On Tue, 21 May 2024 15:35:55 -0700, Ian Rogers wrote:
> Assorted typo fixes.
>
>

Applied to perf-tools-next, thanks!

Best regards,
--
Namhyung Kim <[email protected]>