* [PATCH] perf doc: Fix typos all over the place
@ 2021-09-24 8:19 Like Xu
2021-09-24 14:59 ` Ian Rogers
0 siblings, 1 reply; 2+ messages in thread
From: Like Xu @ 2021-09-24 8:19 UTC (permalink / raw)
To: Arnaldo Carvalho de Melo, Jonathan Corbet
Cc: linux-perf-users, Peter Zijlstra, Ingo Molnar, Mark Rutland,
Stephane Eranian, Alexander Shishkin, Jiri Olsa, Namhyung Kim,
linux-kernel
From: Like Xu <likexu@tencent.com>
Considering that perf and its subcommands have so many parameters,
the documentation is always the first stop for perf beginners. Fixing
some spelling errors will relax the eyes of some readers a little bit.
s/specicfication/specification/
s/caheline/cacheline/
s/tranasaction/transaction/
s/complan/complain/
s/sched_wakep/sched_wakeup/
s/possble/possible/
s/methology/methodology/
Signed-off-by: Like Xu <likexu@tencent.com>
---
tools/perf/Documentation/jitdump-specification.txt | 2 +-
tools/perf/Documentation/perf-c2c.txt | 2 +-
tools/perf/Documentation/perf-intel-pt.txt | 2 +-
tools/perf/Documentation/perf-lock.txt | 2 +-
tools/perf/Documentation/perf-script-perl.txt | 2 +-
tools/perf/Documentation/perf-script-python.txt | 2 +-
tools/perf/Documentation/perf-stat.txt | 2 +-
tools/perf/Documentation/topdown.txt | 2 +-
8 files changed, 8 insertions(+), 8 deletions(-)
diff --git a/tools/perf/Documentation/jitdump-specification.txt b/tools/perf/Documentation/jitdump-specification.txt
index 52152d156ad9..79936355d819 100644
--- a/tools/perf/Documentation/jitdump-specification.txt
+++ b/tools/perf/Documentation/jitdump-specification.txt
@@ -164,7 +164,7 @@ const char unwinding_data[n]: an array of unwinding data, consisting of the EH F
The EH Frame header follows the Linux Standard Base (LSB) specification as described in the document at https://refspecs.linuxfoundation.org/LSB_1.3.0/gLSB/gLSB/ehframehdr.html
-The EH Frame follows the LSB specicfication as described in the document at https://refspecs.linuxbase.org/LSB_3.0.0/LSB-PDA/LSB-PDA/ehframechpt.html
+The EH Frame follows the LSB specification as described in the document at https://refspecs.linuxbase.org/LSB_3.0.0/LSB-PDA/LSB-PDA/ehframechpt.html
NOTE: The mapped_size is generally either the same as unwind_data_size (if the unwinding data was mapped in memory by the running process) or zero (if the unwinding data is not mapped by the process). If the unwinding data was not mapped, then only the EH Frame Header will be read, which can be used to specify FP based unwinding for a function which does not have unwinding information.
diff --git a/tools/perf/Documentation/perf-c2c.txt b/tools/perf/Documentation/perf-c2c.txt
index de6beedb7283..3b6a2c84ea02 100644
--- a/tools/perf/Documentation/perf-c2c.txt
+++ b/tools/perf/Documentation/perf-c2c.txt
@@ -261,7 +261,7 @@ COALESCE
User can specify how to sort offsets for cacheline.
Following fields are available and governs the final
-output fields set for caheline offsets output:
+output fields set for cacheline offsets output:
tid - coalesced by process TIDs
pid - coalesced by process PIDs
diff --git a/tools/perf/Documentation/perf-intel-pt.txt b/tools/perf/Documentation/perf-intel-pt.txt
index 184ba62420f0..db465fa7ee91 100644
--- a/tools/perf/Documentation/perf-intel-pt.txt
+++ b/tools/perf/Documentation/perf-intel-pt.txt
@@ -883,7 +883,7 @@ and "r" can be combined to get calls and returns.
"Transactions" events correspond to the start or end of transactions. The
'flags' field can be used in perf script to determine whether the event is a
-tranasaction start, commit or abort.
+transaction start, commit or abort.
Note that "instructions", "branches" and "transactions" events depend on code
flow packets which can be disabled by using the config term "branch=0". Refer
diff --git a/tools/perf/Documentation/perf-lock.txt b/tools/perf/Documentation/perf-lock.txt
index 74d774592196..1b4d452923d7 100644
--- a/tools/perf/Documentation/perf-lock.txt
+++ b/tools/perf/Documentation/perf-lock.txt
@@ -44,7 +44,7 @@ COMMON OPTIONS
-f::
--force::
- Don't complan, do it.
+ Don't complain, do it.
REPORT OPTIONS
--------------
diff --git a/tools/perf/Documentation/perf-script-perl.txt b/tools/perf/Documentation/perf-script-perl.txt
index 5a1f68122f50..fa4f39d305a7 100644
--- a/tools/perf/Documentation/perf-script-perl.txt
+++ b/tools/perf/Documentation/perf-script-perl.txt
@@ -54,7 +54,7 @@ all sched_wakeup events in the system:
Traces meant to be processed using a script should be recorded with
the above option: -a to enable system-wide collection.
-The format file for the sched_wakep event defines the following fields
+The format file for the sched_wakeup event defines the following fields
(see /sys/kernel/debug/tracing/events/sched/sched_wakeup/format):
----
diff --git a/tools/perf/Documentation/perf-script-python.txt b/tools/perf/Documentation/perf-script-python.txt
index 0250dc61cf98..cf4b7f4b625a 100644
--- a/tools/perf/Documentation/perf-script-python.txt
+++ b/tools/perf/Documentation/perf-script-python.txt
@@ -448,7 +448,7 @@ all sched_wakeup events in the system:
Traces meant to be processed using a script should be recorded with
the above option: -a to enable system-wide collection.
-The format file for the sched_wakep event defines the following fields
+The format file for the sched_wakeup event defines the following fields
(see /sys/kernel/debug/tracing/events/sched/sched_wakeup/format):
----
diff --git a/tools/perf/Documentation/perf-stat.txt b/tools/perf/Documentation/perf-stat.txt
index 4c9310be6acc..7e6fb7cbc0f4 100644
--- a/tools/perf/Documentation/perf-stat.txt
+++ b/tools/perf/Documentation/perf-stat.txt
@@ -385,7 +385,7 @@ Aggregate counts per physical processor for system-wide mode measurements.
Print metrics or metricgroups specified in a comma separated list.
For a group all metrics from the group are added.
The events from the metrics are automatically measured.
-See perf list output for the possble metrics and metricgroups.
+See perf list output for the possible metrics and metricgroups.
-A::
--no-aggr::
diff --git a/tools/perf/Documentation/topdown.txt b/tools/perf/Documentation/topdown.txt
index c6302df4cf29..a15b93fdcf50 100644
--- a/tools/perf/Documentation/topdown.txt
+++ b/tools/perf/Documentation/topdown.txt
@@ -2,7 +2,7 @@ Using TopDown metrics in user space
-----------------------------------
Intel CPUs (since Sandy Bridge and Silvermont) support a TopDown
-methology to break down CPU pipeline execution into 4 bottlenecks:
+methodology to break down CPU pipeline execution into 4 bottlenecks:
frontend bound, backend bound, bad speculation, retiring.
For more details on Topdown see [1][5]
--
2.32.0
^ permalink raw reply related [flat|nested] 2+ messages in thread
* Re: [PATCH] perf doc: Fix typos all over the place
2021-09-24 8:19 [PATCH] perf doc: Fix typos all over the place Like Xu
@ 2021-09-24 14:59 ` Ian Rogers
0 siblings, 0 replies; 2+ messages in thread
From: Ian Rogers @ 2021-09-24 14:59 UTC (permalink / raw)
To: Like Xu
Cc: Arnaldo Carvalho de Melo, Jonathan Corbet, linux-perf-users,
Peter Zijlstra, Ingo Molnar, Mark Rutland, Stephane Eranian,
Alexander Shishkin, Jiri Olsa, Namhyung Kim, linux-kernel
On Fri, Sep 24, 2021 at 1:20 AM Like Xu <like.xu.linux@gmail.com> wrote:
>
> From: Like Xu <likexu@tencent.com>
>
> Considering that perf and its subcommands have so many parameters,
> the documentation is always the first stop for perf beginners. Fixing
> some spelling errors will relax the eyes of some readers a little bit.
>
> s/specicfication/specification/
> s/caheline/cacheline/
> s/tranasaction/transaction/
> s/complan/complain/
> s/sched_wakep/sched_wakeup/
> s/possble/possible/
> s/methology/methodology/
>
> Signed-off-by: Like Xu <likexu@tencent.com>
Acked-by: Ian Rogers <irogers@google.com>
Thanks,
Ian
> ---
> tools/perf/Documentation/jitdump-specification.txt | 2 +-
> tools/perf/Documentation/perf-c2c.txt | 2 +-
> tools/perf/Documentation/perf-intel-pt.txt | 2 +-
> tools/perf/Documentation/perf-lock.txt | 2 +-
> tools/perf/Documentation/perf-script-perl.txt | 2 +-
> tools/perf/Documentation/perf-script-python.txt | 2 +-
> tools/perf/Documentation/perf-stat.txt | 2 +-
> tools/perf/Documentation/topdown.txt | 2 +-
> 8 files changed, 8 insertions(+), 8 deletions(-)
>
> diff --git a/tools/perf/Documentation/jitdump-specification.txt b/tools/perf/Documentation/jitdump-specification.txt
> index 52152d156ad9..79936355d819 100644
> --- a/tools/perf/Documentation/jitdump-specification.txt
> +++ b/tools/perf/Documentation/jitdump-specification.txt
> @@ -164,7 +164,7 @@ const char unwinding_data[n]: an array of unwinding data, consisting of the EH F
> The EH Frame header follows the Linux Standard Base (LSB) specification as described in the document at https://refspecs.linuxfoundation.org/LSB_1.3.0/gLSB/gLSB/ehframehdr.html
>
>
> -The EH Frame follows the LSB specicfication as described in the document at https://refspecs.linuxbase.org/LSB_3.0.0/LSB-PDA/LSB-PDA/ehframechpt.html
> +The EH Frame follows the LSB specification as described in the document at https://refspecs.linuxbase.org/LSB_3.0.0/LSB-PDA/LSB-PDA/ehframechpt.html
>
>
> NOTE: The mapped_size is generally either the same as unwind_data_size (if the unwinding data was mapped in memory by the running process) or zero (if the unwinding data is not mapped by the process). If the unwinding data was not mapped, then only the EH Frame Header will be read, which can be used to specify FP based unwinding for a function which does not have unwinding information.
> diff --git a/tools/perf/Documentation/perf-c2c.txt b/tools/perf/Documentation/perf-c2c.txt
> index de6beedb7283..3b6a2c84ea02 100644
> --- a/tools/perf/Documentation/perf-c2c.txt
> +++ b/tools/perf/Documentation/perf-c2c.txt
> @@ -261,7 +261,7 @@ COALESCE
> User can specify how to sort offsets for cacheline.
>
> Following fields are available and governs the final
> -output fields set for caheline offsets output:
> +output fields set for cacheline offsets output:
>
> tid - coalesced by process TIDs
> pid - coalesced by process PIDs
> diff --git a/tools/perf/Documentation/perf-intel-pt.txt b/tools/perf/Documentation/perf-intel-pt.txt
> index 184ba62420f0..db465fa7ee91 100644
> --- a/tools/perf/Documentation/perf-intel-pt.txt
> +++ b/tools/perf/Documentation/perf-intel-pt.txt
> @@ -883,7 +883,7 @@ and "r" can be combined to get calls and returns.
>
> "Transactions" events correspond to the start or end of transactions. The
> 'flags' field can be used in perf script to determine whether the event is a
> -tranasaction start, commit or abort.
> +transaction start, commit or abort.
>
> Note that "instructions", "branches" and "transactions" events depend on code
> flow packets which can be disabled by using the config term "branch=0". Refer
> diff --git a/tools/perf/Documentation/perf-lock.txt b/tools/perf/Documentation/perf-lock.txt
> index 74d774592196..1b4d452923d7 100644
> --- a/tools/perf/Documentation/perf-lock.txt
> +++ b/tools/perf/Documentation/perf-lock.txt
> @@ -44,7 +44,7 @@ COMMON OPTIONS
>
> -f::
> --force::
> - Don't complan, do it.
> + Don't complain, do it.
>
> REPORT OPTIONS
> --------------
> diff --git a/tools/perf/Documentation/perf-script-perl.txt b/tools/perf/Documentation/perf-script-perl.txt
> index 5a1f68122f50..fa4f39d305a7 100644
> --- a/tools/perf/Documentation/perf-script-perl.txt
> +++ b/tools/perf/Documentation/perf-script-perl.txt
> @@ -54,7 +54,7 @@ all sched_wakeup events in the system:
> Traces meant to be processed using a script should be recorded with
> the above option: -a to enable system-wide collection.
>
> -The format file for the sched_wakep event defines the following fields
> +The format file for the sched_wakeup event defines the following fields
> (see /sys/kernel/debug/tracing/events/sched/sched_wakeup/format):
>
> ----
> diff --git a/tools/perf/Documentation/perf-script-python.txt b/tools/perf/Documentation/perf-script-python.txt
> index 0250dc61cf98..cf4b7f4b625a 100644
> --- a/tools/perf/Documentation/perf-script-python.txt
> +++ b/tools/perf/Documentation/perf-script-python.txt
> @@ -448,7 +448,7 @@ all sched_wakeup events in the system:
> Traces meant to be processed using a script should be recorded with
> the above option: -a to enable system-wide collection.
>
> -The format file for the sched_wakep event defines the following fields
> +The format file for the sched_wakeup event defines the following fields
> (see /sys/kernel/debug/tracing/events/sched/sched_wakeup/format):
>
> ----
> diff --git a/tools/perf/Documentation/perf-stat.txt b/tools/perf/Documentation/perf-stat.txt
> index 4c9310be6acc..7e6fb7cbc0f4 100644
> --- a/tools/perf/Documentation/perf-stat.txt
> +++ b/tools/perf/Documentation/perf-stat.txt
> @@ -385,7 +385,7 @@ Aggregate counts per physical processor for system-wide mode measurements.
> Print metrics or metricgroups specified in a comma separated list.
> For a group all metrics from the group are added.
> The events from the metrics are automatically measured.
> -See perf list output for the possble metrics and metricgroups.
> +See perf list output for the possible metrics and metricgroups.
>
> -A::
> --no-aggr::
> diff --git a/tools/perf/Documentation/topdown.txt b/tools/perf/Documentation/topdown.txt
> index c6302df4cf29..a15b93fdcf50 100644
> --- a/tools/perf/Documentation/topdown.txt
> +++ b/tools/perf/Documentation/topdown.txt
> @@ -2,7 +2,7 @@ Using TopDown metrics in user space
> -----------------------------------
>
> Intel CPUs (since Sandy Bridge and Silvermont) support a TopDown
> -methology to break down CPU pipeline execution into 4 bottlenecks:
> +methodology to break down CPU pipeline execution into 4 bottlenecks:
> frontend bound, backend bound, bad speculation, retiring.
>
> For more details on Topdown see [1][5]
> --
> 2.32.0
>
^ permalink raw reply [flat|nested] 2+ messages in thread
end of thread, other threads:[~2021-09-24 14:59 UTC | newest]
Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-09-24 8:19 [PATCH] perf doc: Fix typos all over the place Like Xu
2021-09-24 14:59 ` Ian Rogers
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).