summaryrefslogtreecommitdiffstats
path: root/documentation/profile-manual/profile-manual-intro.rst
diff options
context:
space:
mode:
Diffstat (limited to 'documentation/profile-manual/profile-manual-intro.rst')
-rw-r--r--documentation/profile-manual/profile-manual-intro.rst40
1 files changed, 25 insertions, 15 deletions
diff --git a/documentation/profile-manual/profile-manual-intro.rst b/documentation/profile-manual/profile-manual-intro.rst
index 5d51df74dc..994b1c5086 100644
--- a/documentation/profile-manual/profile-manual-intro.rst
+++ b/documentation/profile-manual/profile-manual-intro.rst
@@ -38,12 +38,19 @@ General Setup
38Most of the tools are available only in 'sdk' images or in images built 38Most of the tools are available only in 'sdk' images or in images built
39after adding 'tools-profile' to your local.conf. So, in order to be able 39after adding 'tools-profile' to your local.conf. So, in order to be able
40to access all of the tools described here, please first build and boot 40to access all of the tools described here, please first build and boot
41an 'sdk' image e.g. $ bitbake core-image-sato-sdk or alternatively by 41an 'sdk' image e.g. ::
42adding 'tools-profile' to the EXTRA_IMAGE_FEATURES line in your 42
43local.conf: EXTRA_IMAGE_FEATURES = "debug-tweaks tools-profile" If you 43 $ bitbake core-image-sato-sdk
44use the 'tools-profile' method, you don't need to build an sdk image - 44
45the tracing and profiling tools will be included in non-sdk images as 45or alternatively by adding 'tools-profile' to the EXTRA_IMAGE_FEATURES line in
46well e.g.: $ bitbake core-image-sato 46your local.conf: ::
47
48 EXTRA_IMAGE_FEATURES = "debug-tweaks tools-profile"
49
50If you use the 'tools-profile' method, you don't need to build an sdk image -
51the tracing and profiling tools will be included in non-sdk images as well e.g.: ::
52
53 $ bitbake core-image-sato
47 54
48.. note:: 55.. note::
49 56
@@ -52,18 +59,21 @@ well e.g.: $ bitbake core-image-sato
52 59
53 You can prevent that by setting the 60 You can prevent that by setting the
54 :term:`INHIBIT_PACKAGE_STRIP` 61 :term:`INHIBIT_PACKAGE_STRIP`
55 variable to "1" in your ``local.conf`` when you build the image: 62 variable to "1" in your ``local.conf`` when you build the image: ::
56 63
57INHIBIT_PACKAGE_STRIP = "1" The above setting will noticeably increase 64 INHIBIT_PACKAGE_STRIP = "1"
58the size of your image. 65
66 The above setting will noticeably increase the size of your image.
59 67
60If you've already built a stripped image, you can generate debug 68If you've already built a stripped image, you can generate debug
61packages (xxx-dbg) which you can manually install as needed. 69packages (xxx-dbg) which you can manually install as needed.
62 70
63To generate debug info for packages, you can add dbg-pkgs to 71To generate debug info for packages, you can add dbg-pkgs to
64EXTRA_IMAGE_FEATURES in local.conf. For example: EXTRA_IMAGE_FEATURES = 72EXTRA_IMAGE_FEATURES in local.conf. For example: ::
65"debug-tweaks tools-profile dbg-pkgs" Additionally, in order to generate 73
66the right type of debuginfo, we also need to set 74 EXTRA_IMAGE_FEATURES = "debug-tweaks tools-profile dbg-pkgs"
67:term:`PACKAGE_DEBUG_SPLIT_STYLE` 75
68in the ``local.conf`` file: PACKAGE_DEBUG_SPLIT_STYLE = 76Additionally, in order to generate the right type of debuginfo, we also need to
69'debug-file-directory' 77set :term:`PACKAGE_DEBUG_SPLIT_STYLE` in the ``local.conf`` file: ::
78
79 PACKAGE_DEBUG_SPLIT_STYLE = 'debug-file-directory'