diff options
| author | Nicolas Dechesne <nicolas.dechesne@linaro.org> | 2020-11-19 10:58:32 +0100 |
|---|---|---|
| committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2020-11-20 14:32:25 +0000 |
| commit | b3b5d2e0e0571f47dff35bf279ecc482b361ac27 (patch) | |
| tree | b09c2d8f8837eba15c788023aabd55f33028c67b /documentation | |
| parent | d54b7f2e00dffd64445149c81ed6d26e40723320 (diff) | |
| download | poky-b3b5d2e0e0571f47dff35bf279ecc482b361ac27.tar.gz | |
profile-manual: remove unused labels
(From yocto-docs rev: 4ee8a38f23f600fb9dac5d25bd884a195f7d72c0)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
| -rw-r--r-- | documentation/profile-manual/profile-manual-intro.rst | 4 | ||||
| -rw-r--r-- | documentation/profile-manual/profile-manual-usage.rst | 46 |
2 files changed, 0 insertions, 50 deletions
diff --git a/documentation/profile-manual/profile-manual-intro.rst b/documentation/profile-manual/profile-manual-intro.rst index 0d435e0c0c..4e1008b05e 100644 --- a/documentation/profile-manual/profile-manual-intro.rst +++ b/documentation/profile-manual/profile-manual-intro.rst | |||
| @@ -4,8 +4,6 @@ | |||
| 4 | Yocto Project Profiling and Tracing Manual | 4 | Yocto Project Profiling and Tracing Manual |
| 5 | ****************************************** | 5 | ****************************************** |
| 6 | 6 | ||
| 7 | .. _profile-intro: | ||
| 8 | |||
| 9 | Introduction | 7 | Introduction |
| 10 | ============ | 8 | ============ |
| 11 | 9 | ||
| @@ -30,8 +28,6 @@ The final section of this 'HOWTO' is a collection of real-world examples | |||
| 30 | which we'll be continually adding to as we solve more problems using the | 28 | which we'll be continually adding to as we solve more problems using the |
| 31 | tools - feel free to add your own examples to the list! | 29 | tools - feel free to add your own examples to the list! |
| 32 | 30 | ||
| 33 | .. _profile-manual-general-setup: | ||
| 34 | |||
| 35 | General Setup | 31 | General Setup |
| 36 | ============= | 32 | ============= |
| 37 | 33 | ||
diff --git a/documentation/profile-manual/profile-manual-usage.rst b/documentation/profile-manual/profile-manual-usage.rst index d3c020a1cf..cc403a5540 100644 --- a/documentation/profile-manual/profile-manual-usage.rst +++ b/documentation/profile-manual/profile-manual-usage.rst | |||
| @@ -10,8 +10,6 @@ Basic Usage (with examples) for each of the Yocto Tracing Tools | |||
| 10 | This chapter presents basic usage examples for each of the tracing | 10 | This chapter presents basic usage examples for each of the tracing |
| 11 | tools. | 11 | tools. |
| 12 | 12 | ||
| 13 | .. _profile-manual-perf: | ||
| 14 | |||
| 15 | perf | 13 | perf |
| 16 | ==== | 14 | ==== |
| 17 | 15 | ||
| @@ -43,8 +41,6 @@ want to apply the tool; full documentation can be found either within | |||
| 43 | the tool itself or in the man pages at | 41 | the tool itself or in the man pages at |
| 44 | `perf(1) <http://linux.die.net/man/1/perf>`__. | 42 | `perf(1) <http://linux.die.net/man/1/perf>`__. |
| 45 | 43 | ||
| 46 | .. _perf-setup: | ||
| 47 | |||
| 48 | Perf Setup | 44 | Perf Setup |
| 49 | ---------- | 45 | ---------- |
| 50 | 46 | ||
| @@ -61,8 +57,6 @@ profile data and copy it to the host for analysis, but for the rest of | |||
| 61 | this document we assume you've ssh'ed to the host and will be running | 57 | this document we assume you've ssh'ed to the host and will be running |
| 62 | the perf commands on the target. | 58 | the perf commands on the target. |
| 63 | 59 | ||
| 64 | .. _perf-basic-usage: | ||
| 65 | |||
| 66 | Basic Perf Usage | 60 | Basic Perf Usage |
| 67 | ---------------- | 61 | ---------------- |
| 68 | 62 | ||
| @@ -950,8 +944,6 @@ We can look at the raw output using 'perf script' with no arguments: :: | |||
| 950 | kworker/1:1 21 [001] 6171.470082: sched_switch: prev_comm=kworker/1:1 prev_pid=21 prev_prio=120 prev_state=S ==> next_comm=perf next_pid=1383 next_prio=120 | 944 | kworker/1:1 21 [001] 6171.470082: sched_switch: prev_comm=kworker/1:1 prev_pid=21 prev_prio=120 prev_state=S ==> next_comm=perf next_pid=1383 next_prio=120 |
| 951 | perf 1383 [001] 6171.480035: sched_wakeup: comm=kworker/1:1 pid=21 prio=120 success=1 target_cpu=001 | 945 | perf 1383 [001] 6171.480035: sched_wakeup: comm=kworker/1:1 pid=21 prio=120 success=1 target_cpu=001 |
| 952 | 946 | ||
| 953 | .. _perf-filtering: | ||
| 954 | |||
| 955 | Filtering | 947 | Filtering |
| 956 | ^^^^^^^^^ | 948 | ^^^^^^^^^ |
| 957 | 949 | ||
| @@ -1138,8 +1130,6 @@ callgraphs from starting a few programs during those 30 seconds: | |||
| 1138 | uprobes. kprobes and uprobes are also used by and in fact are the | 1130 | uprobes. kprobes and uprobes are also used by and in fact are the |
| 1139 | main focus of SystemTap. | 1131 | main focus of SystemTap. |
| 1140 | 1132 | ||
| 1141 | .. _perf-documentation: | ||
| 1142 | |||
| 1143 | Perf Documentation | 1133 | Perf Documentation |
| 1144 | ------------------ | 1134 | ------------------ |
| 1145 | 1135 | ||
| @@ -1182,8 +1172,6 @@ There's also a nice perf tutorial on the perf | |||
| 1182 | wiki that goes into more detail than we do here in certain areas: `Perf | 1172 | wiki that goes into more detail than we do here in certain areas: `Perf |
| 1183 | Tutorial <https://perf.wiki.kernel.org/index.php/Tutorial>`__ | 1173 | Tutorial <https://perf.wiki.kernel.org/index.php/Tutorial>`__ |
| 1184 | 1174 | ||
| 1185 | .. _profile-manual-ftrace: | ||
| 1186 | |||
| 1187 | ftrace | 1175 | ftrace |
| 1188 | ====== | 1176 | ====== |
| 1189 | 1177 | ||
| @@ -1191,8 +1179,6 @@ ftrace | |||
| 1191 | this encompasses a number of related tracers along with the | 1179 | this encompasses a number of related tracers along with the |
| 1192 | infrastructure that they all make use of. | 1180 | infrastructure that they all make use of. |
| 1193 | 1181 | ||
| 1194 | .. _ftrace-setup: | ||
| 1195 | |||
| 1196 | ftrace Setup | 1182 | ftrace Setup |
| 1197 | ------------ | 1183 | ------------ |
| 1198 | 1184 | ||
| @@ -1668,8 +1654,6 @@ trace-cmd and kernelshark in the next section. | |||
| 1668 | /sys/kernel/debug/tracing will be removed and replaced with | 1654 | /sys/kernel/debug/tracing will be removed and replaced with |
| 1669 | equivalent tracers based on the 'trace events' subsystem. | 1655 | equivalent tracers based on the 'trace events' subsystem. |
| 1670 | 1656 | ||
| 1671 | .. _trace-cmd-kernelshark: | ||
| 1672 | |||
| 1673 | trace-cmd/kernelshark | 1657 | trace-cmd/kernelshark |
| 1674 | --------------------- | 1658 | --------------------- |
| 1675 | 1659 | ||
| @@ -1737,8 +1721,6 @@ The tool is pretty self-explanatory, but for more detailed information | |||
| 1737 | on navigating through the data, see the `kernelshark | 1721 | on navigating through the data, see the `kernelshark |
| 1738 | website <http://rostedt.homelinux.com/kernelshark/>`__. | 1722 | website <http://rostedt.homelinux.com/kernelshark/>`__. |
| 1739 | 1723 | ||
| 1740 | .. _ftrace-documentation: | ||
| 1741 | |||
| 1742 | ftrace Documentation | 1724 | ftrace Documentation |
| 1743 | -------------------- | 1725 | -------------------- |
| 1744 | 1726 | ||
| @@ -1772,8 +1754,6 @@ There's more detailed documentation kernelshark usage here: | |||
| 1772 | An amusing yet useful README (a tracing mini-HOWTO) can be found in | 1754 | An amusing yet useful README (a tracing mini-HOWTO) can be found in |
| 1773 | ``/sys/kernel/debug/tracing/README``. | 1755 | ``/sys/kernel/debug/tracing/README``. |
| 1774 | 1756 | ||
| 1775 | .. _profile-manual-systemtap: | ||
| 1776 | |||
| 1777 | systemtap | 1757 | systemtap |
| 1778 | ========= | 1758 | ========= |
| 1779 | 1759 | ||
| @@ -1835,8 +1815,6 @@ target system and 3) insert the module into the target kernel, which | |||
| 1835 | arms it, and 4) collect the data generated by the probe and display it | 1815 | arms it, and 4) collect the data generated by the probe and display it |
| 1836 | to the user. | 1816 | to the user. |
| 1837 | 1817 | ||
| 1838 | .. _systemtap-setup: | ||
| 1839 | |||
| 1840 | systemtap Setup | 1818 | systemtap Setup |
| 1841 | --------------- | 1819 | --------------- |
| 1842 | 1820 | ||
| @@ -1955,8 +1933,6 @@ no password): | |||
| 1955 | matchbox-termin(1036) open ("/tmp/vte3FS2LW", O_RDWR|O_CREAT|O_EXCL|O_LARGEFILE, 0600) | 1933 | matchbox-termin(1036) open ("/tmp/vte3FS2LW", O_RDWR|O_CREAT|O_EXCL|O_LARGEFILE, 0600) |
| 1956 | matchbox-termin(1036) open ("/tmp/vteJMC7LW", O_RDWR|O_CREAT|O_EXCL|O_LARGEFILE, 0600) | 1934 | matchbox-termin(1036) open ("/tmp/vteJMC7LW", O_RDWR|O_CREAT|O_EXCL|O_LARGEFILE, 0600) |
| 1957 | 1935 | ||
| 1958 | .. _systemtap-documentation: | ||
| 1959 | |||
| 1960 | systemtap Documentation | 1936 | systemtap Documentation |
| 1961 | ----------------------- | 1937 | ----------------------- |
| 1962 | 1938 | ||
| @@ -1967,8 +1943,6 @@ Links to other SystemTap documents, tutorials, and examples can be found | |||
| 1967 | here: `SystemTap documentation | 1943 | here: `SystemTap documentation |
| 1968 | page <http://sourceware.org/systemtap/documentation.html>`__ | 1944 | page <http://sourceware.org/systemtap/documentation.html>`__ |
| 1969 | 1945 | ||
| 1970 | .. _profile-manual-sysprof: | ||
| 1971 | |||
| 1972 | Sysprof | 1946 | Sysprof |
| 1973 | ======= | 1947 | ======= |
| 1974 | 1948 | ||
| @@ -1976,8 +1950,6 @@ Sysprof is a very easy to use system-wide profiler that consists of a | |||
| 1976 | single window with three panes and a few buttons which allow you to | 1950 | single window with three panes and a few buttons which allow you to |
| 1977 | start, stop, and view the profile from one place. | 1951 | start, stop, and view the profile from one place. |
| 1978 | 1952 | ||
| 1979 | .. _sysprof-setup: | ||
| 1980 | |||
| 1981 | Sysprof Setup | 1953 | Sysprof Setup |
| 1982 | ------------- | 1954 | ------------- |
| 1983 | 1955 | ||
| @@ -1990,8 +1962,6 @@ be running Sysprof on the target (you can use the '-X' option to ssh and | |||
| 1990 | have the Sysprof GUI run on the target but display remotely on the host | 1962 | have the Sysprof GUI run on the target but display remotely on the host |
| 1991 | if you want). | 1963 | if you want). |
| 1992 | 1964 | ||
| 1993 | .. _sysprof-basic-usage: | ||
| 1994 | |||
| 1995 | Basic Sysprof Usage | 1965 | Basic Sysprof Usage |
| 1996 | ------------------- | 1966 | ------------------- |
| 1997 | 1967 | ||
| @@ -2040,8 +2010,6 @@ to the selected function, and so on. | |||
| 2040 | the -g (--call-graph) option that you can experiment with; one of the | 2010 | the -g (--call-graph) option that you can experiment with; one of the |
| 2041 | options is 'caller' for an inverted caller-based callgraph display. | 2011 | options is 'caller' for an inverted caller-based callgraph display. |
| 2042 | 2012 | ||
| 2043 | .. _sysprof-documentation: | ||
| 2044 | |||
| 2045 | Sysprof Documentation | 2013 | Sysprof Documentation |
| 2046 | --------------------- | 2014 | --------------------- |
| 2047 | 2015 | ||
| @@ -2053,8 +2021,6 @@ Linux <http://sysprof.com/>`__ | |||
| 2053 | LTTng (Linux Trace Toolkit, next generation) | 2021 | LTTng (Linux Trace Toolkit, next generation) |
| 2054 | ============================================ | 2022 | ============================================ |
| 2055 | 2023 | ||
| 2056 | .. _lttng-setup: | ||
| 2057 | |||
| 2058 | LTTng Setup | 2024 | LTTng Setup |
| 2059 | ----------- | 2025 | ----------- |
| 2060 | 2026 | ||
| @@ -2239,8 +2205,6 @@ trace - it's still there in ~/lttng-traces): :: | |||
| 2239 | root@crownbay:~# lttng destroy | 2205 | root@crownbay:~# lttng destroy |
| 2240 | Session auto-20190303-021943 destroyed at /home/root | 2206 | Session auto-20190303-021943 destroyed at /home/root |
| 2241 | 2207 | ||
| 2242 | .. _lltng-documentation: | ||
| 2243 | |||
| 2244 | LTTng Documentation | 2208 | LTTng Documentation |
| 2245 | ------------------- | 2209 | ------------------- |
| 2246 | 2210 | ||
| @@ -2254,8 +2218,6 @@ For information on LTTng in general, visit the `LTTng | |||
| 2254 | Project <http://lttng.org/lttng2.0>`__ site. You can find a "Getting | 2218 | Project <http://lttng.org/lttng2.0>`__ site. You can find a "Getting |
| 2255 | Started" link on this site that takes you to an LTTng Quick Start. | 2219 | Started" link on this site that takes you to an LTTng Quick Start. |
| 2256 | 2220 | ||
| 2257 | .. _profile-manual-blktrace: | ||
| 2258 | |||
| 2259 | blktrace | 2221 | blktrace |
| 2260 | ======== | 2222 | ======== |
| 2261 | 2223 | ||
| @@ -2264,8 +2226,6 @@ blktrace provides the tracing half of the equation; its output can be | |||
| 2264 | piped into the blkparse program, which renders the data in a | 2226 | piped into the blkparse program, which renders the data in a |
| 2265 | human-readable form and does some basic analysis: | 2227 | human-readable form and does some basic analysis: |
| 2266 | 2228 | ||
| 2267 | .. _blktrace-setup: | ||
| 2268 | |||
| 2269 | blktrace Setup | 2229 | blktrace Setup |
| 2270 | -------------- | 2230 | -------------- |
| 2271 | 2231 | ||
| @@ -2281,8 +2241,6 @@ collect and analyze the data on the host (see the | |||
| 2281 | below). For the rest of this section we assume you've ssh'ed to the host and | 2241 | below). For the rest of this section we assume you've ssh'ed to the host and |
| 2282 | will be running blkrace on the target. | 2242 | will be running blkrace on the target. |
| 2283 | 2243 | ||
| 2284 | .. _blktrace-basic-usage: | ||
| 2285 | |||
| 2286 | Basic blktrace Usage | 2244 | Basic blktrace Usage |
| 2287 | -------------------- | 2245 | -------------------- |
| 2288 | 2246 | ||
| @@ -2411,8 +2369,6 @@ I/O traffic during the run. You can look at the | |||
| 2411 | `blkparse <http://linux.die.net/man/1/blkparse>`__ manpage to learn the | 2369 | `blkparse <http://linux.die.net/man/1/blkparse>`__ manpage to learn the |
| 2412 | meaning of each field displayed in the trace listing. | 2370 | meaning of each field displayed in the trace listing. |
| 2413 | 2371 | ||
| 2414 | .. _blktrace-live-mode: | ||
| 2415 | |||
| 2416 | Live Mode | 2372 | Live Mode |
| 2417 | ~~~~~~~~~ | 2373 | ~~~~~~~~~ |
| 2418 | 2374 | ||
| @@ -2603,8 +2559,6 @@ And this turns off tracing for the specified device: :: | |||
| 2603 | 2559 | ||
| 2604 | root@crownbay:/sys/kernel/debug/tracing# echo 0 > /sys/block/sdc/trace/enable | 2560 | root@crownbay:/sys/kernel/debug/tracing# echo 0 > /sys/block/sdc/trace/enable |
| 2605 | 2561 | ||
| 2606 | .. _blktrace-documentation: | ||
| 2607 | |||
| 2608 | blktrace Documentation | 2562 | blktrace Documentation |
| 2609 | ---------------------- | 2563 | ---------------------- |
| 2610 | 2564 | ||
