Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

libperf: Fix man page typos

Fix various typos and inconsistent capitalization of CPU in the libperf
man pages.

Signed-off-by: Rob Herring <robh@kernel.org>
Cc: Alexander Shishkin <alexander.shishkin@linux.intel.com>
Cc: Jiri Olsa <jolsa@redhat.com>
Cc: Mark Rutland <mark.rutland@arm.com>
Cc: Namhyung Kim <namhyung@kernel.org>
Cc: Peter Zijlstra <peterz@infradead.org>
Link: http://lore.kernel.org/lkml/20200807193241.3904545-1-robh@kernel.org
Signed-off-by: Arnaldo Carvalho de Melo <acme@redhat.com>

authored by

Rob Herring and committed by
Arnaldo Carvalho de Melo
ce746d43 194cb6b5

+17 -14
+8 -6
tools/lib/perf/Documentation/libperf-counting.txt
··· 7 7 8 8 DESCRIPTION 9 9 ----------- 10 - The counting interface provides API to meassure and get count for specific perf events. 10 + The counting interface provides API to measure and get count for specific perf events. 11 11 12 12 The following test tries to explain count on `counting.c` example. 13 13 14 14 It is by no means complete guide to counting, but shows libperf basic API for counting. 15 15 16 - The `counting.c` comes with libbperf package and can be compiled and run like: 16 + The `counting.c` comes with libperf package and can be compiled and run like: 17 17 18 18 [source,bash] 19 19 -- ··· 26 26 It requires root access, because of the `PERF_COUNT_SW_CPU_CLOCK` event, 27 27 which is available only for root. 28 28 29 - The `counting.c` example monitors two events on the current process and displays their count, in a nutshel it: 29 + The `counting.c` example monitors two events on the current process and displays 30 + their count, in a nutshell it: 30 31 31 32 * creates events 32 33 * adds them to the event list ··· 153 152 -- 154 153 155 154 Both events are created as disabled (note the `disabled = 1` assignment above), 156 - so we need to enable the whole list explicitely (both events). 155 + so we need to enable the whole list explicitly (both events). 157 156 158 157 From this moment events are counting and we can do our workload. 159 158 ··· 168 167 79 perf_evlist__disable(evlist); 169 168 -- 170 169 171 - Now we need to get the counts from events, following code iterates throught the events list and read counts: 170 + Now we need to get the counts from events, following code iterates through the 171 + events list and read counts: 172 172 173 173 [source,c] 174 174 -- ··· 180 178 85 } 181 179 -- 182 180 183 - And finaly cleanup. 181 + And finally cleanup. 184 182 185 183 We close the whole events list (both events) and remove it together with the threads map: 186 184
+7 -6
tools/lib/perf/Documentation/libperf-sampling.txt
··· 8 8 9 9 DESCRIPTION 10 10 ----------- 11 - The sampling interface provides API to meassure and get count for specific perf events. 11 + The sampling interface provides API to measure and get count for specific perf events. 12 12 13 13 The following test tries to explain count on `sampling.c` example. 14 14 15 15 It is by no means complete guide to sampling, but shows libperf basic API for sampling. 16 16 17 - The `sampling.c` comes with libbperf package and can be compiled and run like: 17 + The `sampling.c` comes with libperf package and can be compiled and run like: 18 18 19 19 [source,bash] 20 20 -- ··· 33 33 34 34 It requires root access, because it uses hardware cycles event. 35 35 36 - The `sampling.c` example profiles/samples all CPUs with hardware cycles, in a nutshel it: 36 + The `sampling.c` example profiles/samples all CPUs with hardware cycles, in a 37 + nutshell it: 37 38 38 39 - creates events 39 40 - adds them to the event list ··· 91 90 36 }; 92 91 -- 93 92 94 - Next step is to prepare cpus map. 93 + Next step is to prepare CPUs map. 95 94 96 95 In this case we will monitor all the available CPUs: 97 96 ··· 153 152 -- 154 153 155 154 The event is created as disabled (note the `disabled = 1` assignment above), 156 - so we need to enable the events list explicitely. 155 + so we need to enable the events list explicitly. 157 156 158 157 From this moment the cycles event is sampling. 159 158 ··· 213 212 106 cpu, pid, tid, ip, period); 214 213 -- 215 214 216 - And finaly cleanup. 215 + And finally cleanup. 217 216 218 217 We close the whole events list (both events) and remove it together with the threads map: 219 218
+2 -2
tools/lib/perf/Documentation/libperf.txt
··· 29 29 void libperf_init(libperf_print_fn_t fn); 30 30 -- 31 31 32 - *API to handle cpu maps:* 32 + *API to handle CPU maps:* 33 33 34 34 [source,c] 35 35 -- ··· 217 217 218 218 [horizontal] 219 219 220 - struct perf_cpu_map:: Provides a cpu list abstraction. 220 + struct perf_cpu_map:: Provides a CPU list abstraction. 221 221 222 222 struct perf_thread_map:: Provides a thread list abstraction. 223 223