diff options
Diffstat (limited to 'documentation/profile-manual/intro.rst')
| -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 9c8fa3dbfa..86310cf318 100644 --- a/documentation/profile-manual/intro.rst +++ b/documentation/profile-manual/intro.rst @@ -7,43 +7,45 @@ Yocto Project Profiling and Tracing Manual 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 -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 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 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 appropriate) to each tool, in the context of a general-purpose 'drill-down' methodology that can be applied to solving a large number -(90%?) of problems. For help with more advanced usages and problems, -please see the documentation and/or websites listed for each tool. +of problems. For help with more advanced usages and problems, +refer to the documentation and/or websites provided for each tool. -The final section of this 'HOWTO' is a collection of real-world examples -which we'll be continually adding to as we solve more problems using the -tools - feel free to add your own examples to the list! +The final section of this manual is a collection of real-world examples +which we'll be continually updating as we solve more problems using the +tools --- feel free to suggest additions to what you read here. General Setup ============= -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 -to access all of the tools described here, please first build and boot -an 'sdk' image e.g. :: +Most of the tools are available only in ``sdk`` images or in images built +after adding ``tools-profile`` to your ``local.conf`` file. So, in order to be able +to access all of the tools described here, you can build and boot +an ``sdk`` image, perhaps one of:: $ bitbake core-image-sato-sdk + $ bitbake core-image-weston-sdk + $ bitbake core-image-rt-sdk -or alternatively by adding 'tools-profile' to the EXTRA_IMAGE_FEATURES line in -your local.conf:: +Alternatively, you can add ``tools-profile`` to the :term:`EXTRA_IMAGE_FEATURES` line in +your ``local.conf`` file:: 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.:: $ 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 packages (xxx-dbg) which you can manually install as needed. -To generate debug info for packages, you can add dbg-pkgs to -EXTRA_IMAGE_FEATURES in local.conf. For example:: +To generate debug info for packages, you can add ``dbg-pkgs`` to +:term:`EXTRA_IMAGE_FEATURES` in ``local.conf``. For example:: 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:: PACKAGE_DEBUG_SPLIT_STYLE = 'debug-file-directory' |