summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorNicolas Dechesne <nicolas.dechesne@linaro.org>2020-12-03 22:38:40 +0100
committerRichard Purdie <richard.purdie@linuxfoundation.org>2020-12-09 12:21:27 +0000
commit11c048fbeae7d3eb12c43bd14953cb64b3de53bd (patch)
tree47f6e6e95bc650f15636b388967d7034ac8d8f5c
parenta0afa48859def9f6410ad1d3b1296683e14fc2b7 (diff)
downloadpoky-11c048fbeae7d3eb12c43bd14953cb64b3de53bd.tar.gz
poky-11c048fbeae7d3eb12c43bd14953cb64b3de53bd.tar.bz2
poky-11c048fbeae7d3eb12c43bd14953cb64b3de53bd.zip
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.rst8
-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
:caption: Table of Contents
:numbered:
- profile-manual-intro
- profile-manual-arch
- profile-manual-usage
- profile-manual-examples
+ intro
+ arch
+ usage
+ examples
history
.. 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
----------
For this section, we'll assume you've already performed the basic setup
-outlined in the ":ref:`profile-manual/profile-manual-intro:General Setup`" section.
+outlined in the ":ref:`profile-manual/intro:General Setup`" section.
In particular, you'll get the most mileage out of perf if you profile an
image built with the following in your ``local.conf`` file: ::
@@ -1183,7 +1183,7 @@ ftrace Setup
------------
For this section, we'll assume you've already performed the basic setup
-outlined in the ":ref:`profile-manual/profile-manual-intro:General Setup`" section.
+outlined in the ":ref:`profile-manual/intro:General Setup`" section.
ftrace, trace-cmd, and kernelshark run on the target system, and are
ready to go out-of-the-box - no additional setup is necessary. For the
@@ -1871,7 +1871,7 @@ having done a build: ::
So essentially what you need to
do is build an SDK image or image with 'tools-profile' as detailed in
-the ":ref:`profile-manual/profile-manual-intro:General Setup`" section of this
+the ":ref:`profile-manual/intro:General Setup`" section of this
manual, and boot the resulting target image.
.. note::
@@ -1954,7 +1954,7 @@ Sysprof Setup
-------------
For this section, we'll assume you've already performed the basic setup
-outlined in the ":ref:`profile-manual/profile-manual-intro:General Setup`" section.
+outlined in the ":ref:`profile-manual/intro:General Setup`" section.
Sysprof is a GUI-based application that runs on the target system. For
the rest of this document we assume you've ssh'ed to the host and will
@@ -2025,7 +2025,7 @@ LTTng Setup
-----------
For this section, we'll assume you've already performed the basic setup
-outlined in the ":ref:`profile-manual/profile-manual-intro:General Setup`" section.
+outlined in the ":ref:`profile-manual/intro:General Setup`" section.
LTTng is run on the target system by ssh'ing to it.
Collecting and Viewing Traces
@@ -2033,7 +2033,7 @@ Collecting and Viewing Traces
Once you've applied the above commits and built and booted your image
(you need to build the core-image-sato-sdk image or use one of the other
-methods described in the ":ref:`profile-manual/profile-manual-intro:General Setup`" section), you're ready to start
+methods described in the ":ref:`profile-manual/intro:General Setup`" section), you're ready to start
tracing.
Collecting and viewing a trace on the target (inside a shell)
@@ -2230,14 +2230,14 @@ blktrace Setup
--------------
For this section, we'll assume you've already performed the basic setup
-outlined in the ":ref:`profile-manual/profile-manual-intro:General Setup`"
+outlined in the ":ref:`profile-manual/intro:General Setup`"
section.
blktrace is an application that runs on the target system. You can run
the entire blktrace and blkparse pipeline on the target, or you can run
blktrace in 'listen' mode on the target and have blktrace and blkparse
collect and analyze the data on the host (see the
-":ref:`profile-manual/profile-manual-usage:Using blktrace Remotely`" section
+":ref:`profile-manual/usage:Using blktrace Remotely`" section
below). For the rest of this section we assume you've ssh'ed to the host and
will be running blkrace on the target.
@@ -2512,7 +2512,7 @@ Tracing Block I/O via 'ftrace'
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
It's also possible to trace block I/O using only
-:ref:`profile-manual/profile-manual-usage:The 'trace events' Subsystem`, which
+:ref:`profile-manual/usage:The 'trace events' Subsystem`, which
can be useful for casual tracing if you don't want to bother dealing with the
userspace tools.