From 0ac8eba57813dc85f8ad70dfaa1bbc381c5e4c9c Mon Sep 17 00:00:00 2001 From: Scott Rifenbark Date: Thu, 10 Jan 2013 18:26:06 -0600 Subject: profile-manual: Raw text for introduction chapter. this text is straight from Tom's wiki. no formatting no nuthin' (From yocto-docs rev: 95f5341169c3e8d3bd7a97740320d0d27cbee020) Signed-off-by: Scott Rifenbark Signed-off-by: Richard Purdie --- .../profile-manual/profile-manual-intro.xml | 230 +++++++-------------- 1 file changed, 71 insertions(+), 159 deletions(-) (limited to 'documentation/profile-manual') diff --git a/documentation/profile-manual/profile-manual-intro.xml b/documentation/profile-manual/profile-manual-intro.xml index dca24602ed..9ed807f356 100644 --- a/documentation/profile-manual/profile-manual-intro.xml +++ b/documentation/profile-manual/profile-manual-intro.xml @@ -2,186 +2,98 @@ "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ %poky; ] > - + -The Yocto Project Development Manual +Yocto Project Tracing and Profiling Manual
Introduction - Welcome to the Yocto Project Development Manual! - This manual gives you an idea of how to use the Yocto Project to develop embedded Linux - images and user-space applications to run on targeted devices. - Reading this manual gives you an overview of image, kernel, and user-space application development - using the Yocto Project. - Because much of the information in this manual is general, it contains many references to other - sources where you can find more detail. - For example, detailed information on Git, repositories and open source in general - can be found in many places. - Another example is how to get set up to use the Yocto Project, which our Yocto Project - Quick Start covers. + Yocto bundles a number of tracing and profiling tools - this 'HOWTO' + describes their basic usage and shows by example how to make use + of them to examine application and system behavior. - The Yocto Project Development Manual, however, does provide detailed examples - on how to change the kernel source code, reconfigure the kernel, and develop - an application using the popular Eclipse IDE. + 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. -
-
- What this Manual Provides + + The purpose of this 'HOWTO' 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. + - The following list describes what you can get from this guide: - - Information that lets you get set - up to develop using the Yocto Project. - Information to help developers who are new to the open source environment - and to the distributed revision control system Git, which the Yocto Project - uses. - An understanding of common end-to-end development models and tasks. - Development case overviews for both system development and user-space - applications. - An overview and understanding of the emulation environment used with - the Yocto Project - the Quick EMUlator (QEMU). - An understanding of basic kernel architecture and concepts. - Many references to other sources of related information. - + 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!
-
- What this Manual Does Not Provide +
+ General Setup - This manual will not give you the following: - - Step-by-step instructions if those instructions exist in other Yocto - Project documentation. - For example, the Yocto Project Application Developer's Guide contains detailed - instruction on how to run the - Installing the ADT and Toolchains, - which is used to set up a cross-development environment. - Reference material. - This type of material resides in an appropriate reference manual. - For example, system variables are documented in the - Yocto Project Reference Manual. - Detailed public information that is not specific to the Yocto Project. - For example, exhaustive information on how to use Git is covered better through the - Internet than in this manual. - + 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. + + $ bitbake core-image-sato-sdk + + or alternatively by adding 'tools-profile' to the + EXTRA_IMAGE_FEATURES line in your local.conf: + + EXTRA_IMAGE_FEATURES = "debug-tweaks tools-profile" + + 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 + + + By default, the Yocto build system strips symbols from the + binaries it packages, which makes it difficult to use some + of the tools. + You can prevent that by putting the following + in your local.conf when you build the image: + + + + INHIBIT_PACKAGE_STRIP = "1" + + The above setting will noticeably increase the size of your image. -
-
- Other Information + + If you've already build a stripped image, you can generate + debug packages (xxx-dbg) which you can manually install as + needed. + - Because this manual presents overview information for many different topics, you will - need to supplement it with other information. - The following list presents other sources of information you might find helpful: - - The Yocto Project Website: - The home page for the Yocto Project provides lots of information on the project - as well as links to software and documentation. - - Yocto Project Quick Start: This short document lets you get started - with the Yocto Project quickly and start building an image. - - Yocto Project Reference Manual: This manual is a reference - guide to the OpenEmbedded build system known as "Poky." - The manual also contains a reference chapter on Board Support Package (BSP) - layout. - - Yocto Project Application Developer's Guide: - This guide provides information that lets you get going with the Application - Development Toolkit (ADT) and stand-alone cross-development toolchains to - develop projects using the Yocto Project. - - Yocto Project Board Support Package (BSP) Developer's Guide: - This guide defines the structure for BSP components. - Having a commonly understood structure encourages standardization. - - Yocto Project Kernel Architecture and Use Manual: - This manual describes the architecture of the Yocto Project kernel and provides - some work flow examples. - - - Eclipse IDE Yocto Plug-in: A step-by-step instructional video that - demonstrates how an application developer uses Yocto Plug-in features within - the Eclipse IDE. - - FAQ: - A list of commonly asked questions and their answers. - - - Release Notes: Features, updates and known issues for the current - release of the Yocto Project. - - - Hob: A graphical user interface for BitBake. - Hob's primary goal is to enable a user to perform common tasks more easily. - - - Build Appliance: A bootable custom embedded Linux image you can - either build using a non-Linux development system (VMware applications) or download - from the Yocto Project website. - See the Build Appliance - page for more information. - - Bugzilla: - The bug tracking application the Yocto Project uses. - If you find problems with the Yocto Project, you should report them using this - application. - - Yocto Project Mailing Lists: To subscribe to the Yocto Project mailing - lists, click on the following URLs and follow the instructions: - - for a - Yocto Project Discussions mailing list. - for a - Yocto Project Discussions mailing list about the Poky build system. - - for a mailing list to receive official Yocto Project announcements for developments and - as well as Yocto Project milestones. - for a - listing of all public mailing lists on lists.yoctoproject.org. - - - Internet Relay Chat (IRC): - Two IRC channels on freenode are available - for Yocto Project and Poky discussions: #yocto and - #poky, respectively. - - OpenedHand: - The company that initially developed the Poky project, which is the basis - for the OpenEmbedded build system used by the Yocto Project. - OpenedHand was acquired by Intel Corporation in 2008. - - Intel Corporation: - A multinational semiconductor chip manufacturer company whose Software and - Services Group created and supports the Yocto Project. - Intel acquired OpenedHand in 2008. - - OpenEmbedded: - The build system used by the Yocto Project. - This project is the upstream, generic, embedded distribution from which the Yocto - Project derives its build system (Poky) from and to which it contributes. - - - BitBake: The tool used by the OpenEmbedded build system - to process project metadata. - - BitBake User Manual: - A comprehensive guide to the BitBake tool. - If you want information on BitBake, see the user manual inculded in the - bitbake/doc/manual directory of the - Source Directory. - - Quick EMUlator (QEMU): - An open-source machine emulator and virtualizer. - + To generate debug info for packages, you can add dbg-pkgs to + 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 add the following to local.conf: + + PACKAGE_DEBUG_SPLIT_STYLE = 'debug-file-directory' +
-- cgit v1.2.3-54-g00ecf