diff options
author | Robert P. J. Day <rpjday@crashcourse.ca> | 2023-10-14 06:15:23 -0400 |
---|---|---|
committer | Steve Sakoman <steve@sakoman.com> | 2023-10-25 04:51:01 -1000 |
commit | 4d79b36d461de8bfd37654eb7eb73b0d0ff0169f (patch) | |
tree | 065b9fc1e3add83e793c6c453ca35d371d771d23 | |
parent | 8de77fdcbb6e80f6722cb01efe53da0724f148ec (diff) | |
download | poky-4d79b36d461de8bfd37654eb7eb73b0d0ff0169f.tar.gz |
profile-manual: aesthetic cleanups
Various aesthetic cleanups of section 1 of that manual, including:
* replace 'HOWTO' with manual
* add more examples of sdk-related images
* font fixes
(From yocto-docs rev: 55ce55247ab3238d69c165a01da1689158d8967a)
Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
-rw-r--r-- | documentation/profile-manual/intro.rst | 40 |
1 files changed, 21 insertions, 19 deletions
diff --git a/documentation/profile-manual/intro.rst b/documentation/profile-manual/intro.rst index 93f8429ee3..86310cf318 100644 --- a/documentation/profile-manual/intro.rst +++ b/documentation/profile-manual/intro.rst | |||
@@ -7,43 +7,45 @@ Yocto Project Profiling and Tracing Manual | |||
7 | Introduction | 7 | Introduction |
8 | ============ | 8 | ============ |
9 | 9 | ||
10 | Yocto bundles a number of tracing and profiling tools --- this 'HOWTO' | 10 | Yocto Project bundles a number of tracing and profiling tools --- this manual |
11 | describes their basic usage and shows by example how to make use of them | 11 | describes their basic usage and shows by example how to make use of them |
12 | to examine application and system behavior. | 12 | to analyze application and system behavior. |
13 | 13 | ||
14 | The tools presented are for the most part completely open-ended and have | 14 | The tools presented are, for the most part, completely open-ended and have |
15 | quite good and/or extensive documentation of their own which can be used | 15 | quite good and/or extensive documentation of their own which can be used |
16 | to solve just about any problem you might come across in Linux. Each | 16 | to solve just about any problem you might come across in Linux. Each |
17 | section that describes a particular tool has links to that tool's | 17 | section that describes a particular tool has links to that tool's |
18 | documentation and website. | 18 | documentation and website. |
19 | 19 | ||
20 | The purpose of this 'HOWTO' is to present a set of common and generally | 20 | The purpose of this manual is to present a set of common and generally |
21 | useful tracing and profiling idioms along with their application (as | 21 | useful tracing and profiling idioms along with their application (as |
22 | appropriate) to each tool, in the context of a general-purpose | 22 | appropriate) to each tool, in the context of a general-purpose |
23 | 'drill-down' methodology that can be applied to solving a large number | 23 | 'drill-down' methodology that can be applied to solving a large number |
24 | (90%?) of problems. For help with more advanced usages and problems, | 24 | of problems. For help with more advanced usages and problems, |
25 | please see the documentation and/or websites listed for each tool. | 25 | refer to the documentation and/or websites provided for each tool. |
26 | 26 | ||
27 | The final section of this 'HOWTO' is a collection of real-world examples | 27 | The final section of this manual is a collection of real-world examples |
28 | which we'll be continually adding to as we solve more problems using the | 28 | which we'll be continually updating as we solve more problems using the |
29 | tools --- feel free to add your own examples to the list! | 29 | tools --- feel free to suggest additions to what you read here. |
30 | 30 | ||
31 | General Setup | 31 | General Setup |
32 | ============= | 32 | ============= |
33 | 33 | ||
34 | Most of the tools are available only in 'sdk' images or in images built | 34 | Most of the tools are available only in ``sdk`` images or in images built |
35 | after adding 'tools-profile' to your local.conf. So, in order to be able | 35 | after adding ``tools-profile`` to your ``local.conf`` file. So, in order to be able |
36 | to access all of the tools described here, please first build and boot | 36 | to access all of the tools described here, you can build and boot |
37 | an 'sdk' image e.g. :: | 37 | an ``sdk`` image, perhaps one of:: |
38 | 38 | ||
39 | $ bitbake core-image-sato-sdk | 39 | $ bitbake core-image-sato-sdk |
40 | $ bitbake core-image-weston-sdk | ||
41 | $ bitbake core-image-rt-sdk | ||
40 | 42 | ||
41 | or alternatively by adding 'tools-profile' to the :term:`EXTRA_IMAGE_FEATURES` line in | 43 | Alternatively, you can add ``tools-profile`` to the :term:`EXTRA_IMAGE_FEATURES` line in |
42 | your local.conf:: | 44 | your ``local.conf`` file:: |
43 | 45 | ||
44 | EXTRA_IMAGE_FEATURES = "debug-tweaks tools-profile" | 46 | EXTRA_IMAGE_FEATURES = "debug-tweaks tools-profile" |
45 | 47 | ||
46 | If you use the 'tools-profile' method, you don't need to build an sdk image - | 48 | If you use the ``tools-profile`` method, you don't need to build an sdk image --- |
47 | the tracing and profiling tools will be included in non-sdk images as well e.g.:: | 49 | the tracing and profiling tools will be included in non-sdk images as well e.g.:: |
48 | 50 | ||
49 | $ bitbake core-image-sato | 51 | $ bitbake core-image-sato |
@@ -64,12 +66,12 @@ the tracing and profiling tools will be included in non-sdk images as well e.g.: | |||
64 | If you've already built a stripped image, you can generate debug | 66 | If you've already built a stripped image, you can generate debug |
65 | packages (xxx-dbg) which you can manually install as needed. | 67 | packages (xxx-dbg) which you can manually install as needed. |
66 | 68 | ||
67 | To generate debug info for packages, you can add dbg-pkgs to | 69 | To generate debug info for packages, you can add ``dbg-pkgs`` to |
68 | :term:`EXTRA_IMAGE_FEATURES` in local.conf. For example:: | 70 | :term:`EXTRA_IMAGE_FEATURES` in ``local.conf``. For example:: |
69 | 71 | ||
70 | EXTRA_IMAGE_FEATURES = "debug-tweaks tools-profile dbg-pkgs" | 72 | EXTRA_IMAGE_FEATURES = "debug-tweaks tools-profile dbg-pkgs" |
71 | 73 | ||
72 | Additionally, in order to generate the right type of debuginfo, we also need to | 74 | Additionally, in order to generate the right type of debug info, we also need to |
73 | set :term:`PACKAGE_DEBUG_SPLIT_STYLE` in the ``local.conf`` file:: | 75 | set :term:`PACKAGE_DEBUG_SPLIT_STYLE` in the ``local.conf`` file:: |
74 | 76 | ||
75 | PACKAGE_DEBUG_SPLIT_STYLE = 'debug-file-directory' | 77 | PACKAGE_DEBUG_SPLIT_STYLE = 'debug-file-directory' |