MIRRORS/poky
1
0
Fork 0
mirror of git://git.yoctoproject.org/poky.git synced 2025-07-19 21:09:03 +02:00
Code Issues Actions Packages Projects Releases Wiki Activity

profile-manual: aesthetic cleanups

Browse Source 
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: 608e93e13a8316a8d40e0675d4335084efa3736a)

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: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
Robert P. J. Day 2023-10-14 06:15:23 -04:00 committed by Richard Purdie
parent 273fbf4e76
commit f81ed4fd61
1 changed files with 21 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
documentation/profile-manual/intro.rst
View File

@ -7,43 +7,45 @@ Yocto Project Profiling and Tracing Manual
Introduction Introduction
============ ============
Yocto bundles a number of tracing and profiling tools --- this 'HOWTO' Yocto Project bundles a number of tracing and profiling tools --- this manual
describes their basic usage and shows by example how to make use of them describes their basic usage and shows by example how to make use of them
to examine application and system behavior. to analyze application and system behavior.
The tools presented are for the most part completely open-ended and have The tools presented are, for the most part, completely open-ended and have
quite good and/or extensive documentation of their own which can be used quite good and/or extensive documentation of their own which can be used
to solve just about any problem you might come across in Linux. Each to solve just about any problem you might come across in Linux. Each
section that describes a particular tool has links to that tool's section that describes a particular tool has links to that tool's
documentation and website. documentation and website.
The purpose of this 'HOWTO' is to present a set of common and generally The purpose of this manual is to present a set of common and generally
useful tracing and profiling idioms along with their application (as useful tracing and profiling idioms along with their application (as
appropriate) to each tool, in the context of a general-purpose appropriate) to each tool, in the context of a general-purpose
'drill-down' methodology that can be applied to solving a large number 'drill-down' methodology that can be applied to solving a large number
(90%?) of problems. For help with more advanced usages and problems, of problems. For help with more advanced usages and problems,
please see the documentation and/or websites listed for each tool. refer to the documentation and/or websites provided for each tool.
The final section of this 'HOWTO' is a collection of real-world examples The final section of this manual is a collection of real-world examples
which we'll be continually adding to as we solve more problems using the which we'll be continually updating as we solve more problems using the
tools --- feel free to add your own examples to the list! tools --- feel free to suggest additions to what you read here.
General Setup General Setup
============= =============
Most of the tools are available only in 'sdk' images or in images built Most of the tools are available only in ``sdk`` images or in images built
after adding 'tools-profile' to your local.conf. So, in order to be able after adding ``tools-profile`` to your ``local.conf`` file. So, in order to be able
to access all of the tools described here, please first build and boot to access all of the tools described here, you can build and boot
an 'sdk' image e.g. :: an ``sdk`` image, perhaps one of::
$ bitbake core-image-sato-sdk $ bitbake core-image-sato-sdk
$ bitbake core-image-weston-sdk
$ bitbake core-image-rt-sdk
or alternatively by adding 'tools-profile' to the :term:`EXTRA_IMAGE_FEATURES` line in Alternatively, you can add ``tools-profile`` to the :term:`EXTRA_IMAGE_FEATURES` line in
your local.conf:: your ``local.conf`` file::
EXTRA_IMAGE_FEATURES = "debug-tweaks tools-profile" EXTRA_IMAGE_FEATURES = "debug-tweaks tools-profile"
If you use the 'tools-profile' method, you don't need to build an sdk image - If you use the ``tools-profile`` method, you don't need to build an sdk image ---
the tracing and profiling tools will be included in non-sdk images as well e.g.:: the tracing and profiling tools will be included in non-sdk images as well e.g.::
$ bitbake core-image-sato $ bitbake core-image-sato
@ -64,12 +66,12 @@ the tracing and profiling tools will be included in non-sdk images as well e.g.:
If you've already built a stripped image, you can generate debug If you've already built a stripped image, you can generate debug
packages (xxx-dbg) which you can manually install as needed. packages (xxx-dbg) which you can manually install as needed.
To generate debug info for packages, you can add dbg-pkgs to To generate debug info for packages, you can add ``dbg-pkgs`` to
:term:`EXTRA_IMAGE_FEATURES` in local.conf. For example:: :term:`EXTRA_IMAGE_FEATURES` in ``local.conf``. For example::
EXTRA_IMAGE_FEATURES = "debug-tweaks tools-profile dbg-pkgs" EXTRA_IMAGE_FEATURES = "debug-tweaks tools-profile dbg-pkgs"
Additionally, in order to generate the right type of debuginfo, we also need to Additionally, in order to generate the right type of debug info, we also need to
set :term:`PACKAGE_DEBUG_SPLIT_STYLE` in the ``local.conf`` file:: set :term:`PACKAGE_DEBUG_SPLIT_STYLE` in the ``local.conf`` file::
PACKAGE_DEBUG_SPLIT_STYLE = 'debug-file-directory' PACKAGE_DEBUG_SPLIT_STYLE = 'debug-file-directory'