path: root/documentation/profile-manual
diff options
authorScott Rifenbark <>2013-01-11 00:26:06 (GMT)
committerRichard Purdie <>2013-01-27 13:54:08 (GMT)
commit0ac8eba57813dc85f8ad70dfaa1bbc381c5e4c9c (patch)
treec4bbd42d074fda349c75726c1dd0e6c85c037a23 /documentation/profile-manual
parent6b7ae329462115ef1d5ec70a212d1728f6c7acc4 (diff)
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 <>
Diffstat (limited to 'documentation/profile-manual')
1 files changed, 71 insertions, 159 deletions
diff --git a/documentation/profile-manual/profile-manual-intro.xml b/documentation/profile-manual/profile-manual-intro.xml
index dca2460..9ed807f 100644
--- a/documentation/profile-manual/profile-manual-intro.xml
+++ b/documentation/profile-manual/profile-manual-intro.xml
@@ -2,186 +2,98 @@
2"" 2""
3[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] > 3[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] >
4 4
5<chapter id='dev-manual-intro'> 5<chapter id='profile-manual-intro'>
6 6
7<title>The Yocto Project Development Manual</title> 7<title>Yocto Project Tracing and Profiling Manual</title>
8 <section id='intro'> 8 <section id='intro'>
9 <title>Introduction</title> 9 <title>Introduction</title>
10 10
11 <para> 11 <para>
12 Welcome to the Yocto Project Development Manual! 12 Yocto bundles a number of tracing and profiling tools - this 'HOWTO'
13 This manual gives you an idea of how to use the Yocto Project to develop embedded Linux 13 describes their basic usage and shows by example how to make use
14 images and user-space applications to run on targeted devices. 14 of them to examine application and system behavior.
15 Reading this manual gives you an overview of image, kernel, and user-space application development
16 using the Yocto Project.
17 Because much of the information in this manual is general, it contains many references to other
18 sources where you can find more detail.
19 For example, detailed information on Git, repositories and open source in general
20 can be found in many places.
21 Another example is how to get set up to use the Yocto Project, which our Yocto Project
22 Quick Start covers.
23 </para> 15 </para>
24 16
25 <para> 17 <para>
26 The Yocto Project Development Manual, however, does provide detailed examples 18 The tools presented are for the most part completely open-ended and
27 on how to change the kernel source code, reconfigure the kernel, and develop 19 have quite good and/or extensive documentation of their own which
28 an application using the popular <trademark class='trade'>Eclipse</trademark> IDE. 20 can be used to solve just about any problem you might come across
21 in Linux.
22 Each section that describes a particular tool has links to that
23 tool's documentation and website.
29 </para> 24 </para>
30 </section>
31 25
32 <section id='what-this-manual-provides'> 26 <para>
33 <title>What this Manual Provides</title> 27 The purpose of this 'HOWTO' is to present a set of common and
28 generally useful tracing and profiling idioms along with their
29 application (as appropriate) to each tool, in the context of a
30 general-purpose 'drill-down' methodology that can be applied
31 to solving a large number (90%?) of problems.
32 For help with more advanced usages and problems, please see
33 the documentation and/or websites listed for each tool.
34 </para>
34 35
35 <para> 36 <para>
36 The following list describes what you can get from this guide: 37 The final section of this 'HOWTO' is a collection of real-world
37 <itemizedlist> 38 examples which we'll be continually adding to as we solve more
38 <listitem><para>Information that lets you get set 39 problems using the tools - feel free to add your own examples
39 up to develop using the Yocto Project.</para></listitem> 40 to the list!
40 <listitem><para>Information to help developers who are new to the open source environment
41 and to the distributed revision control system Git, which the Yocto Project
42 uses.</para></listitem>
43 <listitem><para>An understanding of common end-to-end development models and tasks.</para></listitem>
44 <listitem><para>Development case overviews for both system development and user-space
45 applications.</para></listitem>
46 <listitem><para>An overview and understanding of the emulation environment used with
47 the Yocto Project - the Quick EMUlator (QEMU).</para></listitem>
48 <listitem><para>An understanding of basic kernel architecture and concepts.</para></listitem>
49 <listitem><para>Many references to other sources of related information.</para></listitem>
50 </itemizedlist>
51 </para> 41 </para>
52 </section> 42 </section>
53 43
54 <section id='what-this-manual-does-not-provide'> 44 <section id='profile-manual-general-setup'>
55 <title>What this Manual Does Not Provide</title> 45 <title>General Setup</title>
56 46
57 <para> 47 <para>
58 This manual will not give you the following: 48 Most of the tools are available only in 'sdk' images or in images
59 <itemizedlist> 49 built after adding 'tools-profile' to your local.conf.
60 <listitem><para>Step-by-step instructions if those instructions exist in other Yocto 50 So, in order to be able to access all of the tools described here,
61 Project documentation. 51 please first build and boot an 'sdk' image e.g.
62 For example, the Yocto Project Application Developer's Guide contains detailed 52 <literallayout class='monospaced'>
63 instruction on how to run the 53 $ bitbake core-image-sato-sdk
64 <ulink url='&YOCTO_DOCS_ADT_URL;#installing-the-adt'>Installing the ADT and Toolchains</ulink>, 54 </literallayout>
65 which is used to set up a cross-development environment.</para></listitem> 55 or alternatively by adding 'tools-profile' to the
66 <listitem><para>Reference material. 56 EXTRA_IMAGE_FEATURES line in your local.conf:
67 This type of material resides in an appropriate reference manual. 57 <literallayout class='monospaced'>
68 For example, system variables are documented in the 58 EXTRA_IMAGE_FEATURES = "debug-tweaks tools-profile"
69 <ulink url='&YOCTO_DOCS_REF_URL;'>Yocto Project Reference Manual</ulink>.</para></listitem> 59 </literallayout>
70 <listitem><para>Detailed public information that is not specific to the Yocto Project. 60 If you use the 'tools-profile' method, you don't need to build an
71 For example, exhaustive information on how to use Git is covered better through the 61 sdk image - the tracing and profiling tools will be included in
72 Internet than in this manual.</para></listitem> 62 non-sdk images as well e.g.:
73 </itemizedlist> 63 <literallayout class='monospaced'>
64 $ bitbake core-image-sato
65 </literallayout>
66 <note><para>
67 By default, the Yocto build system strips symbols from the
68 binaries it packages, which makes it difficult to use some
69 of the tools.
70 </para><para>You can prevent that by putting the following
71 in your local.conf when you build the image:
72 </para>
73 </note>
74 <literallayout class='monospaced'>
76 </literallayout>
77 The above setting will noticeably increase the size of your image.
74 </para> 78 </para>
75 </section>
76 79
77 <section id='other-information'> 80 <para>
78 <title>Other Information</title> 81 If you've already build a stripped image, you can generate
82 debug packages (xxx-dbg) which you can manually install as
83 needed.
84 </para>
79 85
80 <para> 86 <para>
81 Because this manual presents overview information for many different topics, you will 87 To generate debug info for packages, you can add dbg-pkgs to
82 need to supplement it with other information. 88 EXTRA_IMAGE_FEATURES in local.conf. For example:
83 The following list presents other sources of information you might find helpful: 89 <literallayout class='monospaced'>
84 <itemizedlist> 90 EXTRA_IMAGE_FEATURES = "debug-tweaks tools-profile dbg-pkgs"
85 <listitem><para><emphasis>The <ulink url='&YOCTO_HOME_URL;'>Yocto Project Website</ulink>: 91 </literallayout>
86 </emphasis> The home page for the Yocto Project provides lots of information on the project 92 Additionally, in order to generate the right type of
87 as well as links to software and documentation.</para></listitem> 93 debuginfo, we also need to add the following to local.conf:
88 <listitem><para><emphasis> 94 <literallayout class='monospaced'>
89 <ulink url='&YOCTO_DOCS_QS_URL;'>Yocto Project Quick Start</ulink>:</emphasis> This short document lets you get started 95 PACKAGE_DEBUG_SPLIT_STYLE = 'debug-file-directory'
90 with the Yocto Project quickly and start building an image.</para></listitem> 96 </literallayout>
91 <listitem><para><emphasis>
92 <ulink url='&YOCTO_DOCS_REF_URL;'>Yocto Project Reference Manual</ulink>:</emphasis> This manual is a reference
93 guide to the OpenEmbedded build system known as "Poky."
94 The manual also contains a reference chapter on Board Support Package (BSP)
95 layout.</para></listitem>
96 <listitem><para><emphasis>
97 <ulink url='&YOCTO_DOCS_ADT_URL;'>Yocto Project Application Developer's Guide</ulink>:</emphasis>
98 This guide provides information that lets you get going with the Application
99 Development Toolkit (ADT) and stand-alone cross-development toolchains to
100 develop projects using the Yocto Project.</para></listitem>
101 <listitem><para><emphasis>
102 <ulink url='&YOCTO_DOCS_BSP_URL;'>Yocto Project Board Support Package (BSP) Developer's Guide</ulink>:</emphasis>
103 This guide defines the structure for BSP components.
104 Having a commonly understood structure encourages standardization.</para></listitem>
105 <listitem><para><emphasis>
106 <ulink url='&YOCTO_DOCS_KERNEL_URL;'>Yocto Project Kernel Architecture and Use Manual</ulink>:</emphasis>
107 This manual describes the architecture of the Yocto Project kernel and provides
108 some work flow examples.</para></listitem>
109 <listitem><para><emphasis>
110 <ulink url=''>
111 Eclipse IDE Yocto Plug-in</ulink>:</emphasis> A step-by-step instructional video that
112 demonstrates how an application developer uses Yocto Plug-in features within
113 the Eclipse IDE.</para></listitem>
114 <listitem><para><emphasis>
115 <ulink url='&YOCTO_WIKI_URL;/wiki/FAQ'>FAQ</ulink>:</emphasis>
116 A list of commonly asked questions and their answers.</para></listitem>
117 <listitem><para><emphasis>
118 <ulink url='&YOCTO_HOME_URL;/download/yocto/yocto-project-&DISTRO;-release-notes-poky-&POKYVERSION;'>
119 Release Notes</ulink>:</emphasis> Features, updates and known issues for the current
120 release of the Yocto Project.</para></listitem>
121 <listitem><para><emphasis>
122 <ulink url='&YOCTO_HOME_URL;/tools-resources/projects/hob'>
123 Hob</ulink>:</emphasis> A graphical user interface for BitBake.
124 Hob's primary goal is to enable a user to perform common tasks more easily.</para></listitem>
125 <listitem><para><emphasis>
126 <ulink url='&YOCTO_HOME_URL;/download/build-appliance-0'>
127 Build Appliance</ulink>:</emphasis> A bootable custom embedded Linux image you can
128 either build using a non-Linux development system (VMware applications) or download
129 from the Yocto Project website.
130 See the <ulink url='&YOCTO_HOME_URL;/documentation/build-appliance-manual'>Build Appliance</ulink>
131 page for more information.</para></listitem>
132 <listitem><para><emphasis>
133 <ulink url='&YOCTO_BUGZILLA_URL;'>Bugzilla</ulink>:</emphasis>
134 The bug tracking application the Yocto Project uses.
135 If you find problems with the Yocto Project, you should report them using this
136 application.</para></listitem>
137 <listitem><para><emphasis>
138 Yocto Project Mailing Lists:</emphasis> To subscribe to the Yocto Project mailing
139 lists, click on the following URLs and follow the instructions:
140 <itemizedlist>
141 <listitem><para><ulink url='&YOCTO_LISTS_URL;/listinfo/yocto'></ulink> for a
142 Yocto Project Discussions mailing list.</para></listitem>
143 <listitem><para><ulink url='&YOCTO_LISTS_URL;/listinfo/poky'></ulink> for a
144 Yocto Project Discussions mailing list about the Poky build system.</para></listitem>
145 <listitem><para><ulink url='&YOCTO_LISTS_URL;/listinfo/yocto-announce'></ulink>
146 for a mailing list to receive official Yocto Project announcements for developments and
147 as well as Yocto Project milestones.</para></listitem>
148 <listitem><para><ulink url='&YOCTO_LISTS_URL;/listinfo'></ulink> for a
149 listing of all public mailing lists on <filename></filename>.
150 </para></listitem>
151 </itemizedlist></para></listitem>
152 <listitem><para><emphasis>Internet Relay Chat (IRC):</emphasis>
153 Two IRC channels on freenode are available
154 for Yocto Project and Poky discussions: <filename>#yocto</filename> and
155 <filename>#poky</filename>, respectively.</para></listitem>
156 <listitem><para><emphasis>
157 <ulink url='&OH_HOME_URL;'>OpenedHand</ulink>:</emphasis>
158 The company that initially developed the Poky project, which is the basis
159 for the OpenEmbedded build system used by the Yocto Project.
160 OpenedHand was acquired by Intel Corporation in 2008.</para></listitem>
161 <listitem><para><emphasis>
162 <ulink url=''>Intel Corporation</ulink>:</emphasis>
163 A multinational semiconductor chip manufacturer company whose Software and
164 Services Group created and supports the Yocto Project.
165 Intel acquired OpenedHand in 2008.</para></listitem>
166 <listitem><para><emphasis>
167 <ulink url='&OE_HOME_URL;'>OpenEmbedded</ulink>:</emphasis>
168 The build system used by the Yocto Project.
169 This project is the upstream, generic, embedded distribution from which the Yocto
170 Project derives its build system (Poky) from and to which it contributes.</para></listitem>
171 <listitem><para><emphasis>
172 <ulink url=''>
173 BitBake</ulink>:</emphasis> The tool used by the OpenEmbedded build system
174 to process project metadata.</para></listitem>
175 <listitem><para><emphasis>
176 BitBake User Manual:</emphasis>
177 A comprehensive guide to the BitBake tool.
178 If you want information on BitBake, see the user manual inculded in the
179 <filename>bitbake/doc/manual</filename> directory of the
180 <link linkend='source-directory'>Source Directory</link>.</para></listitem>
181 <listitem><para><emphasis>
182 <ulink url=''>Quick EMUlator (QEMU)</ulink>:
183 </emphasis> An open-source machine emulator and virtualizer.</para></listitem>
184 </itemizedlist>
185 </para> 97 </para>
186 </section> 98 </section>
187</chapter> 99</chapter>