summaryrefslogtreecommitdiffstats
path: root/documentation/dev-manual
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2011-09-19 08:59:34 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2011-09-25 17:59:58 +0100
commit90ed20051c4e6381ab0a138a4bb54436b82960d7 (patch)
tree7d2f890ad9b7de8559838f351ac7d8be6445d9cc /documentation/dev-manual
parentf00ad2924fd6992128f1ee2c78d886f72cc7f66d (diff)
downloadpoky-90ed20051c4e6381ab0a138a4bb54436b82960d7.tar.gz
documentation/dev-manual/dev-manual-intro.xml: minor edits.
Some indentations applied. Also, a few minor changes to some wordings. (From yocto-docs rev: a166f41a5bbf3590d8a2fabbee267bdd190f19dd) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/dev-manual')
-rw-r--r--documentation/dev-manual/dev-manual-intro.xml332
1 files changed, 163 insertions, 169 deletions
diff --git a/documentation/dev-manual/dev-manual-intro.xml b/documentation/dev-manual/dev-manual-intro.xml
index fabc2dedbe..82c85d3f19 100644
--- a/documentation/dev-manual/dev-manual-intro.xml
+++ b/documentation/dev-manual/dev-manual-intro.xml
@@ -4,183 +4,177 @@
4<chapter id='dev-manual-intro'> 4<chapter id='dev-manual-intro'>
5 5
6<title>The Yocto Project Development Manual</title> 6<title>The Yocto Project Development Manual</title>
7 <section id='intro'>
8 <title>Introduction</title>
7 9
8 <para> 10 <para>
9 Welcome to the Yocto Project Development Manual! 11 Welcome to the Yocto Project Development Manual!
10 This manual gives you an idea of how to use the Yocto Project to develop embedded Linux 12 This manual gives you an idea of how to use the Yocto Project to develop embedded Linux
11 images and user-space applications to run on targeted devices. 13 images and user-space applications to run on targeted devices.
12 Reading this manual gives you an overview of image, kernel, and user-space application development 14 Reading this manual gives you an overview of image, kernel, and user-space application development
13 using the Yocto Project. 15 using the Yocto Project.
14 Because much of the information in this manual is general, it contains many references to other 16 Because much of the information in this manual is general, it contains many references to other
15 sources where you can find more detail. 17 sources where you can find more detail.
16 For example, detailed information on Git, repositories and open-source in general can be found in many places. 18 For example, detailed information on Git, repositories and open-source in general
17 Another example is how to get set up to use the Yocto Project, which our Yocto Project Quick Start covers. 19 can be found in many places.
18 </para> 20 Another example is how to get set up to use the Yocto Project, which our Yocto Project Quick Start covers.
21 </para>
19 22
20 <para> 23 <para>
21 The Yocto Project Development Manual, however, does provide detailed examples on how to create a 24 The Yocto Project Development Manual, however, does provide detailed examples on how to create a
22 Board Support Package (BSP), change the kernel source code, and re-configure the kernel. 25 Board Support Package (BSP), change the kernel source code, and re-configure the kernel.
23 You can find this information in the appendices of the manual. 26 You can find this information in the appendices of the manual.
24 </para> 27 </para>
28 </section>
25 29
26<section id='intro'> 30 <section id='what-this-manual-provides'>
27 <title>Introduction</title> 31 <title>What this Manual Provides</title>
28 32
29 <para> 33 <para>
30 Welcome to the Yocto Project Development Guide! 34 The following list describes what you can get from this guide:
31 This guide provides a general view of the development process using the Yocto Project. 35 <itemizedlist>
32 This guide is just that – a guide. 36 <listitem><para>Information that lets you get set
33 It helps you understand the bigger picture involving development using the Yocto Project. 37 up to develop using the Yocto Project.</para></listitem>
34 </para> 38 <listitem><para>Information to help developers that are new to the open source environment
35</section> 39 and to the distributed revision control system Git, which the Yocto Project
40 uses.</para></listitem>
41 <listitem><para>An understanding of common end-to-end development models.</para></listitem>
42 <listitem><para>Development case overviews for both system development and user-space
43 applications.</para></listitem>
44 <listitem><para>An overview and understanding of the emulation environment used with
45 the Yocto Project (QEMU).</para></listitem>
46<!-- <listitem><para>A discussion of target-level analysis techniques, tools, tips,
47 and tricks.</para></listitem>
48 <listitem><para>Considerations for deploying your final product.</para></listitem> -->
49 <listitem><para>An understanding of basic kernel architecture and
50 concepts.</para></listitem>
51<!-- <listitem><para>Information that will help you migrate an existing project to the
52 Yocto Project development environment.</para></listitem> -->
53 <listitem><para>Many references to other sources of related information.</para></listitem>
54 </itemizedlist>
55 </para>
56 </section>
36 57
37<section id='what-this-manual-provides'> 58 <section id='what-this-manual-does-not-provide'>
38 <title>What this Manual Provides</title> 59 <title>What this Manual Does Not Provide</title>
39 60
40 <para> 61 <para>
41 The following list describes what you can get from this guide: 62 This manual will not give you the following:
42 <itemizedlist> 63 <itemizedlist>
43 <listitem><para>Information that lets you get set 64 <listitem><para>Step-by-step instructions if those instructions exist in other Yocto
44 up to develop using the Yocto Project.</para></listitem> 65 Project documentation.
45 <listitem><para>Information to help developers that are new to the open source environment 66 For example, The Application Development Toolkit (ADT) User’s Guide contains detailed
46 and to the distributed revision control system Git, which the Yocto Project 67 instruction on how to obtain and configure the Eclipse Yocto Plug-in.</para></listitem>
47 uses.</para></listitem> 68 <listitem><para>Reference material.
48 <listitem><para>An understanding of common end-to-end development models.</para></listitem> 69 This type of material resides in an appropriate reference manual.
49 <listitem><para>Development case overviews for both system development and user-space 70 For example, system variables are documented in the
50 applications.</para></listitem> 71 <ulink url='http://www.yoctoproject.org/docs/1.1/poky-ref-manual/poky-ref-manual.html'>
51 <listitem><para>An overview and understanding of the emulation environment used with 72 Yocto Project Reference Manual</ulink>.</para></listitem>
52 the Yocto Project (QEMU).</para></listitem> 73 <listitem><para>Detailed public information that is not specific to the Yocto Project.
53 <listitem><para>A discussion of target-level analysis techniques, tools, tips, 74 For example, exhaustive information on how to use Git is covered better through the
54 and tricks.</para></listitem> 75 Internet than in this manual.</para></listitem>
55 <listitem><para>Considerations for deploying your final product.</para></listitem> 76 </itemizedlist>
56 <listitem><para>An understanding of basic kernel architecture and 77 </para>
57 concepts.</para></listitem> 78 </section>
58 <listitem><para>Information that will help you migrate an existing project to the
59 Yocto Project development environment.</para></listitem>
60 <listitem><para>Many references to other sources of related information.</para></listitem>
61 </itemizedlist>
62 </para>
63</section>
64 79
65<section id='what-this-manual-does-not-provide'> 80 <section id='other-information'>
66 <title>What this Manual Does Not Provide</title> 81 <title>Other Information</title>
67
68 <para>
69 This manual will not give you the following:
70 <itemizedlist>
71 <listitem><para>Step-by-step instructions if those instructions exist in other Yocto
72 Project documentation.
73 For example, The Application Development Toolkit (ADT) User’s Guide contains detailed
74 instruction on how to obtain and configure the Eclipse Yocto Plug-in.</para></listitem>
75 <listitem><para>Reference material.
76 This type of material resides in an appropriate reference manual.
77 For example, system variables are documented in the Poky Reference Manual.</para></listitem>
78 <listitem><para>Detailed public information that is not specific to the Yocto Project.
79 For example, exhaustive information on how to use Git is covered better through the
80 Internet than in this manual.</para></listitem>
81 </itemizedlist>
82 </para>
83</section>
84
85<section id='other-information'>
86 <title>Other Information</title>
87 82
88 <para> 83 <para>
89 Because this manual presents overview information for many different topics, you will 84 Because this manual presents overview information for many different topics, you will
90 need to supplement it with other information. 85 need to supplement it with other information.
91 The following list presents other sources of information you might find helpful: 86 The following list presents other sources of information you might find helpful:
92 <itemizedlist> 87 <itemizedlist>
93 <listitem><para><emphasis>The <ulink url='http://www.yoctoproject.org'>Yocto Project Website</ulink>: 88 <listitem><para><emphasis>The <ulink url='http://www.yoctoproject.org'>Yocto Project Website</ulink>:
94 </emphasis> The home page for the Yocto Project provides lots of information on the project 89 </emphasis> The home page for the Yocto Project provides lots of information on the project
95 as well as links to software and documentation.</para></listitem> 90 as well as links to software and documentation.</para></listitem>
96 <listitem><para><emphasis> 91 <listitem><para><emphasis>
97 <ulink url='http://www.yoctoproject.org/docs/1.1/yocto-project-qs/yocto-project-qs.html'> 92 <ulink url='http://www.yoctoproject.org/docs/1.1/yocto-project-qs/yocto-project-qs.html'>
98 The Yocto Project Quick Start</ulink>:</emphasis> This short document lets you get started 93 The Yocto Project Quick Start</ulink>:</emphasis> This short document lets you get started
99 with the Yocto Project quickly and start building an image.</para></listitem> 94 with the Yocto Project quickly and start building an image.</para></listitem>
100 <listitem><para><emphasis> 95 <listitem><para><emphasis>
101 <ulink url='http://www.yoctoproject.org/docs/1.1/poky-ref-manual/poky-ref-manual.html'> 96 <ulink url='http://www.yoctoproject.org/docs/1.1/poky-ref-manual/poky-ref-manual.html'>
102 The Yocto Project Reference Manual</ulink>:</emphasis> This manual is a reference 97 The Yocto Project Reference Manual</ulink>:</emphasis> This manual is a reference
103 guide to the Yocto Project build component known as "Poky." 98 guide to the Yocto Project build component known as "Poky."
104 The manual also contains a reference chapter on Board Support Package (BSP) 99 The manual also contains a reference chapter on Board Support Package (BSP)
105 layout.</para></listitem> 100 layout.</para></listitem>
106 <listitem><para><emphasis> 101 <listitem><para><emphasis>
107 <ulink url='http://www.yoctoproject.org/docs/1.1/adt-manual/adt-manual.html'> 102 <ulink url='http://www.yoctoproject.org/docs/1.1/adt-manual/adt-manual.html'>
108 The Yocto Project Application Development Toolkit (ADT) User's Guide</ulink>:</emphasis> 103 The Yocto Project Application Development Toolkit (ADT) User's Guide</ulink>:</emphasis>
109 This guide provides information that lets you get going with the ADT to 104 This guide provides information that lets you get going with the ADT to
110 develop projects using the Yocto Project.</para></listitem> 105 develop projects using the Yocto Project.</para></listitem>
111 <listitem><para><emphasis> 106 <listitem><para><emphasis>
112 <ulink url='http://www.yoctoproject.org/docs/1.1/bsp-guide/bsp-guide.html'> 107 <ulink url='http://www.yoctoproject.org/docs/1.1/bsp-guide/bsp-guide.html'>
113 The Yocto Project Board Support Package (BSP) Developer's Guide</ulink>:</emphasis> 108 The Yocto Project Board Support Package (BSP) Developer's Guide</ulink>:</emphasis>
114 This guide defines the structure for BSP components. 109 This guide defines the structure for BSP components.
115 Having a commonly understood structure encourages standardization.</para></listitem> 110 Having a commonly understood structure encourages standardization.</para></listitem>
116 <listitem><para><emphasis> 111 <listitem><para><emphasis>
117 <ulink url='http://www.yoctoproject.org/docs/1.1/kernel-manual/kernel-manual.html'> 112 <ulink url='http://www.yoctoproject.org/docs/1.1/kernel-manual/kernel-manual.html'>
118 The Yocto Project Kernel Architecture and Use Manual</ulink>:</emphasis> 113 The Yocto Project Kernel Architecture and Use Manual</ulink>:</emphasis>
119 This manual describes the architecture of the Yocto Project kernel and provides 114 This manual describes the architecture of the Yocto Project kernel and provides
120 some work flow examples.</para></listitem> 115 some work flow examples.</para></listitem>
121 <listitem><para><emphasis> 116 <listitem><para><emphasis>
122 <ulink url='http://www.youtube.com/watch?v=3ZlOu-gLsh0'> 117 <ulink url='http://www.youtube.com/watch?v=3ZlOu-gLsh0'>
123 Yocto Eclipse Plug-in</ulink>:</emphasis> A step-by-step instructional video that 118 Yocto Eclipse Plug-in</ulink>:</emphasis> A step-by-step instructional video that
124 demonstrates how an application developer uses Yocto Plug-in features within 119 demonstrates how an application developer uses Yocto Plug-in features within
125 the Eclipse IDE.</para></listitem> 120 the Eclipse IDE.</para></listitem>
126 <listitem><para><emphasis> 121 <listitem><para><emphasis>
127 <ulink url='http://wiki.yoctoproject.org/wiki/FAQ'>FAQ</ulink>:</emphasis> 122 <ulink url='http://wiki.yoctoproject.org/wiki/FAQ'>FAQ</ulink>:</emphasis>
128 A list of commonly asked questions and their answers.</para></listitem> 123 A list of commonly asked questions and their answers.</para></listitem>
129 <listitem><para><emphasis> 124 <listitem><para><emphasis>
130 <ulink url='http://www.yoctoproject.org/download/yocto/yocto-project-1.0-release-notes-poky-5.0'> 125 <ulink url='http://www.yoctoproject.org/download/yocto/yocto-project-1.0-release-notes-poky-5.0'>
131 Release Notes</ulink>:</emphasis> Features, updates and known issues for the current 126 Release Notes</ulink>:</emphasis> Features, updates and known issues for the current
132 release of the Yocto Project.</para></listitem> 127 release of the Yocto Project.</para></listitem>
133 <listitem><para><emphasis> 128 <listitem><para><emphasis>
134 <ulink url='http://bugzilla.yoctoproject.org/'>Bugzilla</ulink>:</emphasis> 129 <ulink url='http://bugzilla.yoctoproject.org/'>Bugzilla</ulink>:</emphasis>
135 The bug tracking application the Yocto Project uses. 130 The bug tracking application the Yocto Project uses.
136 If you find problems with the Yocto Project, you should report them using this 131 If you find problems with the Yocto Project, you should report them using this
137 application.</para></listitem> 132 application.</para></listitem>
138 <listitem><para><emphasis> 133 <listitem><para><emphasis>
139 Yocto Project Mailing Lists:</emphasis> To subscribe to the Yocto Project mailing 134 Yocto Project Mailing Lists:</emphasis> To subscribe to the Yocto Project mailing
140 lists, click on the following URLs and follow the instructions: 135 lists, click on the following URLs and follow the instructions:
141 <itemizedlist> 136 <itemizedlist>
142 <listitem><para><ulink url='http://lists.yoctoproject.org/listinfo/yocto'></ulink> for a 137 <listitem><para><ulink url='http://lists.yoctoproject.org/listinfo/yocto'></ulink> for a
143 Yocto Discussions mailing list.</para></listitem> 138 Yocto Project Discussions mailing list.</para></listitem>
144 <listitem><para><ulink url='http://lists.yoctoproject.org/listinfo/poky'></ulink> for a 139 <listitem><para><ulink url='http://lists.yoctoproject.org/listinfo/poky'></ulink> for a
145 Yocto Project Discussions mailing list.</para></listitem> 140 Yocto Project Discussions mailing list about the Poky build system.</para></listitem>
146 <listitem><para><ulink url='http://lists.yoctoproject.org/listinfo/yocto-announce'></ulink> 141 <listitem><para><ulink url='http://lists.yoctoproject.org/listinfo/yocto-announce'></ulink>
147 for a mailing list to receive offical Yocto Project announcements for developments and 142 for a mailing list to receive offical Yocto Project announcements for developments and
148 as well as Yocto Project milestones.</para></listitem> 143 as well as Yocto Project milestones.</para></listitem>
149 </itemizedlist></para></listitem> 144 </itemizedlist></para></listitem>
150 <listitem><para><emphasis>Internet Relay Chat (IRC):</emphasis> 145 <listitem><para><emphasis>Internet Relay Chat (IRC):</emphasis>
151 Two IRC channels on freenode are available 146 Two IRC channels on freenode are available
152 for Yocto Project and Poky discussions: <filename>#yocto</filename> and 147 for Yocto Project and Poky discussions: <filename>#yocto</filename> and
153 <filename>#poky</filename>.</para></listitem> 148 <filename>#poky</filename>.</para></listitem>
154 <listitem><para><emphasis> 149 <listitem><para><emphasis>
155 <ulink url='http://www.openedhand.com/'>OpenedHand</ulink>:</emphasis> 150 <ulink url='http://www.openedhand.com/'>OpenedHand</ulink>:</emphasis>
156 The company where the Yocto Project build system Poky was first developed. 151 The company where the Yocto Project build system Poky was first developed.
157 OpenedHand has since been acquired by Intel Corporation.</para></listitem> 152 OpenedHand has since been acquired by Intel Corporation.</para></listitem>
158 <listitem><para><emphasis> 153 <listitem><para><emphasis>
159 <ulink url='http://www.intel.com/'>Intel Corporation</ulink>:</emphasis> 154 <ulink url='http://www.intel.com/'>Intel Corporation</ulink>:</emphasis>
160 The company who acquired OpenedHand in 2008 and continues development on the 155 The company who acquired OpenedHand in 2008 and continues development on the
161 Yocto Project.</para></listitem> 156 Yocto Project.</para></listitem>
162 <listitem><para><emphasis> 157 <listitem><para><emphasis>
163 <ulink url='http://www.openembedded.org/'>OpenEmbedded</ulink>:</emphasis> 158 <ulink url='http://www.openembedded.org/'>OpenEmbedded</ulink>:</emphasis>
164 The upstream, generic, embedded distribution the Yocto Project build system (Poky) derives 159 The upstream, generic, embedded distribution the Yocto Project build system (Poky) derives
165 from and to which it contributes.</para></listitem> 160 from and to which it contributes.</para></listitem>
166 <listitem><para><emphasis> 161 <listitem><para><emphasis>
167 <ulink url='http://developer.berlios.de/projects/bitbake/'> 162 <ulink url='http://developer.berlios.de/projects/bitbake/'>
168 Bitbake</ulink>:</emphasis> The tool used to process Yocto Project metadata.</para></listitem> 163 Bitbake</ulink>:</emphasis> The tool used to process Yocto Project metadata.</para></listitem>
169 <listitem><para><emphasis> 164 <listitem><para><emphasis>
170 <ulink url='http://bitbake.berlios.de/manual/'> 165 <ulink url='http://bitbake.berlios.de/manual/'>
171 BitBake User Manual</ulink>:</emphasis> A comprehensive guide to the BitBake tool. 166 BitBake User Manual</ulink>:</emphasis> A comprehensive guide to the BitBake tool.
172 </para></listitem> 167 </para></listitem>
173 <listitem><para><emphasis> 168 <listitem><para><emphasis>
174 <ulink url='http://pimlico-project.org/'>Pimlico</ulink>:</emphasis> 169 <ulink url='http://pimlico-project.org/'>Pimlico</ulink>:</emphasis>
175 A suite of lightweight Personal Information Management (PIM) applications designed 170 A suite of lightweight Personal Information Management (PIM) applications designed
176 primarily for handheld and mobile devices.</para></listitem> 171 primarily for handheld and mobile devices.</para></listitem>
177 <listitem><para><emphasis> 172 <listitem><para><emphasis>
178 <ulink url='http://wiki.qemu.org/Index.html'>QEMU</ulink>: 173 <ulink url='http://wiki.qemu.org/Index.html'>QEMU</ulink>:
179 </emphasis> An open source machine emulator and virtualizer.</para></listitem> 174 </emphasis> An open-source machine emulator and virtualizer.</para></listitem>
180 </itemizedlist> 175 </itemizedlist>
181 </para> 176 </para>
182</section> 177 </section>
183
184</chapter> 178</chapter>
185<!-- 179<!--
186vim: expandtab tw=80 ts=4 180vim: expandtab tw=80 ts=4
generated by cgit v1.2.3-54-g00ecf (git 2.39.0) at 2024-11-14 21:27:46 +0000