diff options
author | Nicolas Dechesne <nicolas.dechesne@linaro.org> | 2020-12-03 22:38:40 +0100 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2020-12-09 12:21:27 +0000 |
commit | 11c048fbeae7d3eb12c43bd14953cb64b3de53bd (patch) | |
tree | 47f6e6e95bc650f15636b388967d7034ac8d8f5c | |
parent | a0afa48859def9f6410ad1d3b1296683e14fc2b7 (diff) | |
download | poky-11c048fbeae7d3eb12c43bd14953cb64b3de53bd.tar.gz |
profile-manual: remove 'profile-manual' from filenames
All filenames duplicate the 'manual name', which is not needed, and
make all references longer than they should. Rename all files to be as
consise as possible, and fix all references
(From yocto-docs rev: 44405490888960208058d016e387507e21c9f478)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
-rw-r--r-- | documentation/profile-manual/arch.rst (renamed from documentation/profile-manual/profile-manual-arch.rst) | 0 | ||||
-rw-r--r-- | documentation/profile-manual/examples.rst (renamed from documentation/profile-manual/profile-manual-examples.rst) | 0 | ||||
-rw-r--r-- | documentation/profile-manual/index.rst | 8 | ||||
-rw-r--r-- | documentation/profile-manual/intro.rst (renamed from documentation/profile-manual/profile-manual-intro.rst) | 0 | ||||
-rw-r--r-- | documentation/profile-manual/usage.rst (renamed from documentation/profile-manual/profile-manual-usage.rst) | 18 |
5 files changed, 13 insertions, 13 deletions
diff --git a/documentation/profile-manual/profile-manual-arch.rst b/documentation/profile-manual/arch.rst index 73cd0c29e5..73cd0c29e5 100644 --- a/documentation/profile-manual/profile-manual-arch.rst +++ b/documentation/profile-manual/arch.rst | |||
diff --git a/documentation/profile-manual/profile-manual-examples.rst b/documentation/profile-manual/examples.rst index 97a9e9e21a..97a9e9e21a 100644 --- a/documentation/profile-manual/profile-manual-examples.rst +++ b/documentation/profile-manual/examples.rst | |||
diff --git a/documentation/profile-manual/index.rst b/documentation/profile-manual/index.rst index 5ec5b9e759..6e54133e0a 100644 --- a/documentation/profile-manual/index.rst +++ b/documentation/profile-manual/index.rst | |||
@@ -10,10 +10,10 @@ Yocto Project Profiling and Tracing Manual | |||
10 | :caption: Table of Contents | 10 | :caption: Table of Contents |
11 | :numbered: | 11 | :numbered: |
12 | 12 | ||
13 | profile-manual-intro | 13 | intro |
14 | profile-manual-arch | 14 | arch |
15 | profile-manual-usage | 15 | usage |
16 | profile-manual-examples | 16 | examples |
17 | history | 17 | history |
18 | 18 | ||
19 | .. include:: /boilerplate.rst | 19 | .. include:: /boilerplate.rst |
diff --git a/documentation/profile-manual/profile-manual-intro.rst b/documentation/profile-manual/intro.rst index 4e1008b05e..4e1008b05e 100644 --- a/documentation/profile-manual/profile-manual-intro.rst +++ b/documentation/profile-manual/intro.rst | |||
diff --git a/documentation/profile-manual/profile-manual-usage.rst b/documentation/profile-manual/usage.rst index cc403a5540..418f4e9937 100644 --- a/documentation/profile-manual/profile-manual-usage.rst +++ b/documentation/profile-manual/usage.rst | |||
@@ -45,7 +45,7 @@ Perf Setup | |||
45 | ---------- | 45 | ---------- |
46 | 46 | ||
47 | For this section, we'll assume you've already performed the basic setup | 47 | For this section, we'll assume you've already performed the basic setup |
48 | outlined in the ":ref:`profile-manual/profile-manual-intro:General Setup`" section. | 48 | outlined in the ":ref:`profile-manual/intro:General Setup`" section. |
49 | 49 | ||
50 | In particular, you'll get the most mileage out of perf if you profile an | 50 | In particular, you'll get the most mileage out of perf if you profile an |
51 | image built with the following in your ``local.conf`` file: :: | 51 | image built with the following in your ``local.conf`` file: :: |
@@ -1183,7 +1183,7 @@ ftrace Setup | |||
1183 | ------------ | 1183 | ------------ |
1184 | 1184 | ||
1185 | For this section, we'll assume you've already performed the basic setup | 1185 | For this section, we'll assume you've already performed the basic setup |
1186 | outlined in the ":ref:`profile-manual/profile-manual-intro:General Setup`" section. | 1186 | outlined in the ":ref:`profile-manual/intro:General Setup`" section. |
1187 | 1187 | ||
1188 | ftrace, trace-cmd, and kernelshark run on the target system, and are | 1188 | ftrace, trace-cmd, and kernelshark run on the target system, and are |
1189 | ready to go out-of-the-box - no additional setup is necessary. For the | 1189 | ready to go out-of-the-box - no additional setup is necessary. For the |
@@ -1871,7 +1871,7 @@ having done a build: :: | |||
1871 | 1871 | ||
1872 | So essentially what you need to | 1872 | So essentially what you need to |
1873 | do is build an SDK image or image with 'tools-profile' as detailed in | 1873 | do is build an SDK image or image with 'tools-profile' as detailed in |
1874 | the ":ref:`profile-manual/profile-manual-intro:General Setup`" section of this | 1874 | the ":ref:`profile-manual/intro:General Setup`" section of this |
1875 | manual, and boot the resulting target image. | 1875 | manual, and boot the resulting target image. |
1876 | 1876 | ||
1877 | .. note:: | 1877 | .. note:: |
@@ -1954,7 +1954,7 @@ Sysprof Setup | |||
1954 | ------------- | 1954 | ------------- |
1955 | 1955 | ||
1956 | For this section, we'll assume you've already performed the basic setup | 1956 | For this section, we'll assume you've already performed the basic setup |
1957 | outlined in the ":ref:`profile-manual/profile-manual-intro:General Setup`" section. | 1957 | outlined in the ":ref:`profile-manual/intro:General Setup`" section. |
1958 | 1958 | ||
1959 | Sysprof is a GUI-based application that runs on the target system. For | 1959 | Sysprof is a GUI-based application that runs on the target system. For |
1960 | the rest of this document we assume you've ssh'ed to the host and will | 1960 | the rest of this document we assume you've ssh'ed to the host and will |
@@ -2025,7 +2025,7 @@ LTTng Setup | |||
2025 | ----------- | 2025 | ----------- |
2026 | 2026 | ||
2027 | For this section, we'll assume you've already performed the basic setup | 2027 | For this section, we'll assume you've already performed the basic setup |
2028 | outlined in the ":ref:`profile-manual/profile-manual-intro:General Setup`" section. | 2028 | outlined in the ":ref:`profile-manual/intro:General Setup`" section. |
2029 | LTTng is run on the target system by ssh'ing to it. | 2029 | LTTng is run on the target system by ssh'ing to it. |
2030 | 2030 | ||
2031 | Collecting and Viewing Traces | 2031 | Collecting and Viewing Traces |
@@ -2033,7 +2033,7 @@ Collecting and Viewing Traces | |||
2033 | 2033 | ||
2034 | Once you've applied the above commits and built and booted your image | 2034 | Once you've applied the above commits and built and booted your image |
2035 | (you need to build the core-image-sato-sdk image or use one of the other | 2035 | (you need to build the core-image-sato-sdk image or use one of the other |
2036 | methods described in the ":ref:`profile-manual/profile-manual-intro:General Setup`" section), you're ready to start | 2036 | methods described in the ":ref:`profile-manual/intro:General Setup`" section), you're ready to start |
2037 | tracing. | 2037 | tracing. |
2038 | 2038 | ||
2039 | Collecting and viewing a trace on the target (inside a shell) | 2039 | Collecting and viewing a trace on the target (inside a shell) |
@@ -2230,14 +2230,14 @@ blktrace Setup | |||
2230 | -------------- | 2230 | -------------- |
2231 | 2231 | ||
2232 | For this section, we'll assume you've already performed the basic setup | 2232 | For this section, we'll assume you've already performed the basic setup |
2233 | outlined in the ":ref:`profile-manual/profile-manual-intro:General Setup`" | 2233 | outlined in the ":ref:`profile-manual/intro:General Setup`" |
2234 | section. | 2234 | section. |
2235 | 2235 | ||
2236 | blktrace is an application that runs on the target system. You can run | 2236 | blktrace is an application that runs on the target system. You can run |
2237 | the entire blktrace and blkparse pipeline on the target, or you can run | 2237 | the entire blktrace and blkparse pipeline on the target, or you can run |
2238 | blktrace in 'listen' mode on the target and have blktrace and blkparse | 2238 | blktrace in 'listen' mode on the target and have blktrace and blkparse |
2239 | collect and analyze the data on the host (see the | 2239 | collect and analyze the data on the host (see the |
2240 | ":ref:`profile-manual/profile-manual-usage:Using blktrace Remotely`" section | 2240 | ":ref:`profile-manual/usage:Using blktrace Remotely`" section |
2241 | 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 |
2242 | will be running blkrace on the target. | 2242 | will be running blkrace on the target. |
2243 | 2243 | ||
@@ -2512,7 +2512,7 @@ Tracing Block I/O via 'ftrace' | |||
2512 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | 2512 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
2513 | 2513 | ||
2514 | It's also possible to trace block I/O using only | 2514 | It's also possible to trace block I/O using only |
2515 | :ref:`profile-manual/profile-manual-usage:The 'trace events' Subsystem`, which | 2515 | :ref:`profile-manual/usage:The 'trace events' Subsystem`, which |
2516 | can be useful for casual tracing if you don't want to bother dealing with the | 2516 | can be useful for casual tracing if you don't want to bother dealing with the |
2517 | userspace tools. | 2517 | userspace tools. |
2518 | 2518 | ||