summaryrefslogtreecommitdiffstats
path: root/documentation/profile-manual
diff options
context:
space:
mode:
authorMichael Opdenacker <michael.opdenacker@bootlin.com>2022-03-29 08:46:15 +0200
committerRichard Purdie <richard.purdie@linuxfoundation.org>2022-06-27 14:55:08 +0100
commitd9adf28c10d4a28538e2f90b97dd8949f28815a6 (patch)
tree7f1958f696697e52fc848cd398fb53f3c650b3a9 /documentation/profile-manual
parent0d1d3afa8a09e08b65db8eaa2813bc5621d34806 (diff)
downloadpoky-d9adf28c10d4a28538e2f90b97dd8949f28815a6.tar.gz
manuals: replace hyphens with em dashes
Fix some hyphens being improperly used as em dashes. See https://www.grammarly.com/blog/hyphens-and-dashes/ Using em dashes may also allow Sphinx to hyphenate and break lines in the best way. Note that the first character after an em dash not supposed to be capitalized, unless a specific rule applies, typically when what follows is a proper noun. Fix a few misuses of parentheses in following text. (From yocto-docs rev: 5918f019f63f6e820b1168f4cc001faa1d1cdc6f) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/profile-manual')
-rw-r--r--documentation/profile-manual/intro.rst4
-rw-r--r--documentation/profile-manual/usage.rst24
2 files changed, 14 insertions, 14 deletions
diff --git a/documentation/profile-manual/intro.rst b/documentation/profile-manual/intro.rst
index 9c8fa3dbfa..e9208dfde8 100644
--- a/documentation/profile-manual/intro.rst
+++ b/documentation/profile-manual/intro.rst
@@ -7,7 +7,7 @@ Yocto Project Profiling and Tracing Manual
7Introduction 7Introduction
8============ 8============
9 9
10Yocto bundles a number of tracing and profiling tools - this 'HOWTO' 10Yocto bundles a number of tracing and profiling tools --- this 'HOWTO'
11describes their basic usage and shows by example how to make use of them 11describes their basic usage and shows by example how to make use of them
12to examine application and system behavior. 12to examine application and system behavior.
13 13
@@ -26,7 +26,7 @@ please see the documentation and/or websites listed for each tool.
26 26
27The final section of this 'HOWTO' is a collection of real-world examples 27The final section of this 'HOWTO' is a collection of real-world examples
28which we'll be continually adding to as we solve more problems using the 28which we'll be continually adding to as we solve more problems using the
29tools - feel free to add your own examples to the list! 29tools --- feel free to add your own examples to the list!
30 30
31General Setup 31General Setup
32============= 32=============
diff --git a/documentation/profile-manual/usage.rst b/documentation/profile-manual/usage.rst
index 0ff9d921fd..49f8af4a74 100644
--- a/documentation/profile-manual/usage.rst
+++ b/documentation/profile-manual/usage.rst
@@ -17,7 +17,7 @@ The 'perf' tool is the profiling and tracing tool that comes bundled
17with the Linux kernel. 17with the Linux kernel.
18 18
19Don't let the fact that it's part of the kernel fool you into thinking 19Don't let the fact that it's part of the kernel fool you into thinking
20that it's only for tracing and profiling the kernel - you can indeed use 20that it's only for tracing and profiling the kernel --- you can indeed use
21it to trace and profile just the kernel, but you can also use it to 21it to trace and profile just the kernel, but you can also use it to
22profile specific applications separately (with or without kernel 22profile specific applications separately (with or without kernel
23context), and you can also use it to trace and profile the kernel and 23context), and you can also use it to trace and profile the kernel and
@@ -176,7 +176,7 @@ interactive text-based UI (or simply as text if we specify ``--stdio`` to
176 176
177As our first attempt at profiling this workload, we'll simply run 'perf 177As our first attempt at profiling this workload, we'll simply run 'perf
178record', handing it the workload we want to profile (everything after 178record', handing it the workload we want to profile (everything after
179'perf record' and any perf options we hand it - here none - will be 179'perf record' and any perf options we hand it --- here none, will be
180executed in a new shell). perf collects samples until the process exits 180executed in a new shell). perf collects samples until the process exits
181and records them in a file named 'perf.data' in the current working 181and records them in a file named 'perf.data' in the current working
182directory. :: 182directory. ::
@@ -203,7 +203,7 @@ The above screenshot displays a 'flat' profile, one entry for each
203'bucket' corresponding to the functions that were profiled during the 203'bucket' corresponding to the functions that were profiled during the
204profiling run, ordered from the most popular to the least (perf has 204profiling run, ordered from the most popular to the least (perf has
205options to sort in various orders and keys as well as display entries 205options to sort in various orders and keys as well as display entries
206only above a certain threshold and so on - see the perf documentation 206only above a certain threshold and so on --- see the perf documentation
207for details). Note that this includes both userspace functions (entries 207for details). Note that this includes both userspace functions (entries
208containing a [.]) and kernel functions accounted to the process (entries 208containing a [.]) and kernel functions accounted to the process (entries
209containing a [k]). (perf has command-line modifiers that can be used to 209containing a [k]). (perf has command-line modifiers that can be used to
@@ -608,7 +608,7 @@ and tell perf to do a profile using it as the sampling event::
608The screenshot above shows the results of running a profile using 608The screenshot above shows the results of running a profile using
609sched:sched_switch tracepoint, which shows the relative costs of various 609sched:sched_switch tracepoint, which shows the relative costs of various
610paths to sched_wakeup (note that sched_wakeup is the name of the 610paths to sched_wakeup (note that sched_wakeup is the name of the
611tracepoint - it's actually defined just inside ttwu_do_wakeup(), which 611tracepoint --- it's actually defined just inside ttwu_do_wakeup(), which
612accounts for the function name actually displayed in the profile: 612accounts for the function name actually displayed in the profile:
613 613
614.. code-block:: c 614.. code-block:: c
@@ -877,7 +877,7 @@ System-Wide Tracing and Profiling
877~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 877~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
878 878
879The examples so far have focused on tracing a particular program or 879The examples so far have focused on tracing a particular program or
880workload - in other words, every profiling run has specified the program 880workload --- in other words, every profiling run has specified the program
881to profile in the command-line e.g. 'perf record wget ...'. 881to profile in the command-line e.g. 'perf record wget ...'.
882 882
883It's also possible, and more interesting in many cases, to run a 883It's also possible, and more interesting in many cases, to run a
@@ -964,7 +964,7 @@ Filtering
964Notice that there are a lot of events that don't really have anything to 964Notice that there are a lot of events that don't really have anything to
965do with what we're interested in, namely events that schedule 'perf' 965do with what we're interested in, namely events that schedule 'perf'
966itself in and out or that wake perf up. We can get rid of those by using 966itself in and out or that wake perf up. We can get rid of those by using
967the '--filter' option - for each event we specify using -e, we can add a 967the '--filter' option --- for each event we specify using -e, we can add a
968--filter after that to filter out trace events that contain fields with 968--filter after that to filter out trace events that contain fields with
969specific values:: 969specific values::
970 970
@@ -1135,7 +1135,7 @@ callgraphs from starting a few programs during those 30 seconds:
1135.. admonition:: Tying it Together 1135.. admonition:: Tying it Together
1136 1136
1137 The trace events subsystem accommodate static and dynamic tracepoints 1137 The trace events subsystem accommodate static and dynamic tracepoints
1138 in exactly the same way - there's no difference as far as the 1138 in exactly the same way --- there's no difference as far as the
1139 infrastructure is concerned. See the ftrace section for more details 1139 infrastructure is concerned. See the ftrace section for more details
1140 on the trace event subsystem. 1140 on the trace event subsystem.
1141 1141
@@ -1201,7 +1201,7 @@ For this section, we'll assume you've already performed the basic setup
1201outlined in the ":ref:`profile-manual/intro:General Setup`" section. 1201outlined in the ":ref:`profile-manual/intro:General Setup`" section.
1202 1202
1203ftrace, trace-cmd, and kernelshark run on the target system, and are 1203ftrace, trace-cmd, and kernelshark run on the target system, and are
1204ready to go out-of-the-box - no additional setup is necessary. For the 1204ready to go out-of-the-box --- no additional setup is necessary. For the
1205rest of this section we assume you've ssh'ed to the host and will be 1205rest of this section we assume you've ssh'ed to the host and will be
1206running ftrace on the target. kernelshark is a GUI application and if 1206running ftrace on the target. kernelshark is a GUI application and if
1207you use the '-X' option to ssh you can have the kernelshark GUI run on 1207you use the '-X' option to ssh you can have the kernelshark GUI run on
@@ -1321,7 +1321,7 @@ great way to learn about how the kernel code works in a dynamic sense.
1321 ftrace:function tracepoint. 1321 ftrace:function tracepoint.
1322 1322
1323It is a little more difficult to follow the call chains than it needs to 1323It is a little more difficult to follow the call chains than it needs to
1324be - luckily there's a variant of the function tracer that displays the 1324be --- luckily there's a variant of the function tracer that displays the
1325callchains explicitly, called the 'function_graph' tracer:: 1325callchains explicitly, called the 'function_graph' tracer::
1326 1326
1327 root@sugarbay:/sys/kernel/debug/tracing# echo function_graph > current_tracer 1327 root@sugarbay:/sys/kernel/debug/tracing# echo function_graph > current_tracer
@@ -2138,7 +2138,7 @@ You can now view the trace in text form on the target::
2138 . 2138 .
2139 2139
2140You can now safely destroy the trace 2140You can now safely destroy the trace
2141session (note that this doesn't delete the trace - it's still there in 2141session (note that this doesn't delete the trace --- it's still there in
2142~/lttng-traces):: 2142~/lttng-traces)::
2143 2143
2144 root@crownbay:~# lttng destroy 2144 root@crownbay:~# lttng destroy
@@ -2222,7 +2222,7 @@ You can now view the trace in text form on the target::
2222 . 2222 .
2223 2223
2224You can now safely destroy the trace session (note that this doesn't delete the 2224You can now safely destroy the trace session (note that this doesn't delete the
2225trace - it's still there in ~/lttng-traces):: 2225trace --- it's still there in ~/lttng-traces)::
2226 2226
2227 root@crownbay:~# lttng destroy 2227 root@crownbay:~# lttng destroy
2228 Session auto-20190303-021943 destroyed at /home/root 2228 Session auto-20190303-021943 destroyed at /home/root
@@ -2557,7 +2557,7 @@ Execute the workload you're interested in::
2557 root@crownbay:/sys/kernel/debug/tracing# cat /media/sdc/testfile.txt 2557 root@crownbay:/sys/kernel/debug/tracing# cat /media/sdc/testfile.txt
2558 2558
2559And look at the output (note here that we're using 'trace_pipe' instead of 2559And look at the output (note here that we're using 'trace_pipe' instead of
2560trace to capture this trace - this allows us to wait around on the pipe 2560trace to capture this trace --- this allows us to wait around on the pipe
2561for data to appear):: 2561for data to appear)::
2562 2562
2563 root@crownbay:/sys/kernel/debug/tracing# cat trace_pipe 2563 root@crownbay:/sys/kernel/debug/tracing# cat trace_pipe