summaryrefslogtreecommitdiffstats
path: root/documentation/poky-ref-manual/introduction.xml
diff options
context:
space:
mode:
Diffstat (limited to 'documentation/poky-ref-manual/introduction.xml')
-rw-r--r--documentation/poky-ref-manual/introduction.xml100
1 files changed, 50 insertions, 50 deletions
diff --git a/documentation/poky-ref-manual/introduction.xml b/documentation/poky-ref-manual/introduction.xml
index ab2e7d0f31..38c58da262 100644
--- a/documentation/poky-ref-manual/introduction.xml
+++ b/documentation/poky-ref-manual/introduction.xml
@@ -12,14 +12,14 @@
12 This manual provides reference information for the current release of the Yocto Project. 12 This manual provides reference information for the current release of the Yocto Project.
13 The Yocto Project is an open-source collaboration project focused on embedded Linux 13 The Yocto Project is an open-source collaboration project focused on embedded Linux
14 developers. 14 developers.
15 Amongst other things, the Yocto Project uses the OpenEmbedded build system, which 15 Amongst other things, the Yocto Project uses the OpenEmbedded build system, which
16 is based on the Poky project, to construct complete Linux images. 16 is based on the Poky project, to construct complete Linux images.
17 You can find complete introductory and getting started information on the Yocto Project 17 You can find complete introductory and getting started information on the Yocto Project
18 by reading the 18 by reading the
19 <ulink url='&YOCTO_DOCS_QS_URL;'>Yocto Project Quick Start</ulink>. 19 <ulink url='&YOCTO_DOCS_QS_URL;'>Yocto Project Quick Start</ulink>.
20 For task-based information using the Yocto Project, see the 20 For task-based information using the Yocto Project, see the
21 <ulink url='&YOCTO_DOCS_DEV_URL;'>Yocto Project Development Manual</ulink>. 21 <ulink url='&YOCTO_DOCS_DEV_URL;'>Yocto Project Development Manual</ulink>.
22 You can also find lots of information on the Yocto Project on the 22 You can also find lots of information on the Yocto Project on the
23 <ulink url="&YOCTO_HOME_URL;">Yocto Project website</ulink>. 23 <ulink url="&YOCTO_HOME_URL;">Yocto Project website</ulink>.
24 </para> 24 </para>
25</section> 25</section>
@@ -31,53 +31,53 @@
31 <itemizedlist> 31 <itemizedlist>
32 <listitem><para><emphasis> 32 <listitem><para><emphasis>
33 <link linkend='usingpoky'>Using the Yocto Project</link>:</emphasis> This chapter 33 <link linkend='usingpoky'>Using the Yocto Project</link>:</emphasis> This chapter
34 provides an overview of the components that make up the Yocto Project 34 provides an overview of the components that make up the Yocto Project
35 followed by information about debugging images created in the Yocto Project. 35 followed by information about debugging images created in the Yocto Project.
36 </para></listitem> 36 </para></listitem>
37 <listitem><para><emphasis> 37 <listitem><para><emphasis>
38 <link linkend='technical-details'>Technical Details</link>:</emphasis> 38 <link linkend='technical-details'>Technical Details</link>:</emphasis>
39 This chapter describes fundamental Yocto Project components as well as an explanation 39 This chapter describes fundamental Yocto Project components as well as an explanation
40 behind how the Yocto Project uses shared state (sstate) cache to speed build time. 40 behind how the Yocto Project uses shared state (sstate) cache to speed build time.
41 </para></listitem> 41 </para></listitem>
42 <listitem><para><emphasis> 42 <listitem><para><emphasis>
43 <link linkend='ref-structure'>Directory Structure</link>:</emphasis> 43 <link linkend='ref-structure'>Directory Structure</link>:</emphasis>
44 This chapter describes the 44 This chapter describes the
45 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>source directory</ulink> created 45 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>source directory</ulink> created
46 either by unpacking a released Yocto Project tarball on your host development system, 46 either by unpacking a released Yocto Project tarball on your host development system,
47 or by cloning the upstream 47 or by cloning the upstream
48 <ulink url='&YOCTO_DOCS_DEV_URL;#poky'>Poky</ulink> Git repository. 48 <ulink url='&YOCTO_DOCS_DEV_URL;#poky'>Poky</ulink> Git repository.
49 </para></listitem> 49 </para></listitem>
50 <listitem><para><emphasis> 50 <listitem><para><emphasis>
51 <link linkend='ref-bitbake'>BitBake</link>:</emphasis> 51 <link linkend='ref-bitbake'>BitBake</link>:</emphasis>
52 This chapter provides an overview of the BitBake tool and its role within 52 This chapter provides an overview of the BitBake tool and its role within
53 the Yocto Project.</para></listitem> 53 the Yocto Project.</para></listitem>
54 <listitem><para><emphasis> 54 <listitem><para><emphasis>
55 <link linkend='ref-classes'>Classes</link>:</emphasis> 55 <link linkend='ref-classes'>Classes</link>:</emphasis>
56 This chapter describes the classes used in the Yocto Project.</para></listitem> 56 This chapter describes the classes used in the Yocto Project.</para></listitem>
57 <listitem><para><emphasis> 57 <listitem><para><emphasis>
58 <link linkend='ref-images'>Images</link>:</emphasis> 58 <link linkend='ref-images'>Images</link>:</emphasis>
59 This chapter describes the standard images that the Yocto Project supports. 59 This chapter describes the standard images that the Yocto Project supports.
60 </para></listitem> 60 </para></listitem>
61 <listitem><para><emphasis> 61 <listitem><para><emphasis>
62 <link linkend='ref-features'>Features</link>:</emphasis> 62 <link linkend='ref-features'>Features</link>:</emphasis>
63 This chapter describes mechanisms for creating distribution, machine, and image 63 This chapter describes mechanisms for creating distribution, machine, and image
64 features during the build process using the OpenEmbedded build system.</para></listitem> 64 features during the build process using the OpenEmbedded build system.</para></listitem>
65 <listitem><para><emphasis> 65 <listitem><para><emphasis>
66 <link linkend='ref-variables-glos'>Variables Glossary</link>:</emphasis> 66 <link linkend='ref-variables-glos'>Variables Glossary</link>:</emphasis>
67 This chapter presents most variables used by the OpenEmbedded build system, which 67 This chapter presents most variables used by the OpenEmbedded build system, which
68 using BitBake. 68 using BitBake.
69 Entries describe the function of the variable and how to apply them. 69 Entries describe the function of the variable and how to apply them.
70 </para></listitem> 70 </para></listitem>
71 <listitem><para><emphasis> 71 <listitem><para><emphasis>
72 <link linkend='ref-varlocality'>Variable Context</link>:</emphasis> 72 <link linkend='ref-varlocality'>Variable Context</link>:</emphasis>
73 This chapter provides variable locality or context.</para></listitem> 73 This chapter provides variable locality or context.</para></listitem>
74 <listitem><para><emphasis> 74 <listitem><para><emphasis>
75 <link linkend='faq'>FAQ</link>:</emphasis> 75 <link linkend='faq'>FAQ</link>:</emphasis>
76 This chapter provides answers for commonly asked questions in the Yocto Project 76 This chapter provides answers for commonly asked questions in the Yocto Project
77 development environment.</para></listitem> 77 development environment.</para></listitem>
78 <listitem><para><emphasis> 78 <listitem><para><emphasis>
79 <link linkend='resources'>Contributing to the Yocto Project</link>:</emphasis> 79 <link linkend='resources'>Contributing to the Yocto Project</link>:</emphasis>
80 This chapter provides guidance on how you can contribute back to the Yocto 80 This chapter provides guidance on how you can contribute back to the Yocto
81 Project.</para></listitem> 81 Project.</para></listitem>
82 </itemizedlist> 82 </itemizedlist>
83 </para> 83 </para>
@@ -88,7 +88,7 @@
88<title>System Requirements</title> 88<title>System Requirements</title>
89 <para> 89 <para>
90 For general Yocto Project system requirements, see the 90 For general Yocto Project system requirements, see the
91 "<ulink url='&YOCTO_DOCS_QS_URL;#yp-resources'>What You Need and How You Get It</ulink>" section 91 "<ulink url='&YOCTO_DOCS_QS_URL;#yp-resources'>What You Need and How You Get It</ulink>" section
92 in the Yocto Project Quick Start. 92 in the Yocto Project Quick Start.
93 The remainder of this section provides details on system requirements 93 The remainder of this section provides details on system requirements
94 not covered in the Yocto Project Quick Start. 94 not covered in the Yocto Project Quick Start.
@@ -120,8 +120,8 @@
120 </para> 120 </para>
121 121
122 <note> 122 <note>
123 For additional information on distributions that support the 123 For additional information on distributions that support the
124 Yocto Project, see the 124 Yocto Project, see the
125 <ulink url='&YOCTO_WIKI_URL;/wiki/Distribution_Support'>Distribution Support</ulink> wiki page. 125 <ulink url='&YOCTO_WIKI_URL;/wiki/Distribution_Support'>Distribution Support</ulink> wiki page.
126 </note> 126 </note>
127 </section> 127 </section>
@@ -130,9 +130,9 @@
130 <title>Required Packages for the Host Development System</title> 130 <title>Required Packages for the Host Development System</title>
131 131
132 <para> 132 <para>
133 The list of packages you need on the host development system can 133 The list of packages you need on the host development system can
134 be large when covering all build scenarios using the Yocto Project. 134 be large when covering all build scenarios using the Yocto Project.
135 This section provides required packages by Linux distribution and 135 This section provides required packages by Linux distribution and
136 further categorized by function. 136 further categorized by function.
137 </para> 137 </para>
138 138
@@ -144,7 +144,7 @@
144 given a supported Ubuntu Linux distribution: 144 given a supported Ubuntu Linux distribution:
145 <itemizedlist> 145 <itemizedlist>
146 <listitem><para><emphasis>Essentials:</emphasis> 146 <listitem><para><emphasis>Essentials:</emphasis>
147 Packages needed to build an image on a headless 147 Packages needed to build an image on a headless
148 system: 148 system:
149 <literallayout class='monospaced'> 149 <literallayout class='monospaced'>
150 $ sudo apt-get install &UBUNTU_HOST_PACKAGES_ESSENTIAL; 150 $ sudo apt-get install &UBUNTU_HOST_PACKAGES_ESSENTIAL;
@@ -155,13 +155,13 @@
155 $ sudo apt-get install libsdl1.2-dev xterm 155 $ sudo apt-get install libsdl1.2-dev xterm
156 </literallayout></para></listitem> 156 </literallayout></para></listitem>
157 <listitem><para><emphasis>Documentation:</emphasis> 157 <listitem><para><emphasis>Documentation:</emphasis>
158 Packages needed if you are going to build out the 158 Packages needed if you are going to build out the
159 Yocto Project documentation manuals: 159 Yocto Project documentation manuals:
160 <literallayout class='monospaced'> 160 <literallayout class='monospaced'>
161 $ sudo apt-get install make xsltproc docbook-utils fop 161 $ sudo apt-get install make xsltproc docbook-utils fop
162 </literallayout></para></listitem> 162 </literallayout></para></listitem>
163 <listitem><para><emphasis>ADT Installer Extras:</emphasis> 163 <listitem><para><emphasis>ADT Installer Extras:</emphasis>
164 Packages needed if you are going to be using the 164 Packages needed if you are going to be using the
165 <ulink url='&YOCTO_DOCS_ADT_URL;#using-the-adt-installer'>Application Development Toolkit (ADT) Installer</ulink>: 165 <ulink url='&YOCTO_DOCS_ADT_URL;#using-the-adt-installer'>Application Development Toolkit (ADT) Installer</ulink>:
166 <literallayout class='monospaced'> 166 <literallayout class='monospaced'>
167 $ sudo apt-get install autoconf automake libtool libglib2.0-dev 167 $ sudo apt-get install autoconf automake libtool libglib2.0-dev
@@ -178,7 +178,7 @@
178 given a supported Fedora Linux distribution: 178 given a supported Fedora Linux distribution:
179 <itemizedlist> 179 <itemizedlist>
180 <listitem><para><emphasis>Essentials:</emphasis> 180 <listitem><para><emphasis>Essentials:</emphasis>
181 Packages needed to build an image for a headless 181 Packages needed to build an image for a headless
182 system: 182 system:
183 <literallayout class='monospaced'> 183 <literallayout class='monospaced'>
184 $ sudo yum install &FEDORA_HOST_PACKAGES_ESSENTIAL; 184 $ sudo yum install &FEDORA_HOST_PACKAGES_ESSENTIAL;
@@ -189,14 +189,14 @@
189 $ sudo yum install SDL-devel xterm 189 $ sudo yum install SDL-devel xterm
190 </literallayout></para></listitem> 190 </literallayout></para></listitem>
191 <listitem><para><emphasis>Documentation:</emphasis> 191 <listitem><para><emphasis>Documentation:</emphasis>
192 Packages needed if you are going to build out the 192 Packages needed if you are going to build out the
193 Yocto Project documentation manuals: 193 Yocto Project documentation manuals:
194 <literallayout class='monospaced'> 194 <literallayout class='monospaced'>
195 $ sudo yum install make docbook-style-dsssl docbook-style-xsl \ 195 $ sudo yum install make docbook-style-dsssl docbook-style-xsl \
196 docbook-dtds docbook-utils fop libxslt 196 docbook-dtds docbook-utils fop libxslt
197 </literallayout></para></listitem> 197 </literallayout></para></listitem>
198 <listitem><para><emphasis>ADT Installer Extras:</emphasis> 198 <listitem><para><emphasis>ADT Installer Extras:</emphasis>
199 Packages needed if you are going to be using the 199 Packages needed if you are going to be using the
200 <ulink url='&YOCTO_DOCS_ADT_URL;#using-the-adt-installer'>Application Development Toolkit (ADT) Installer</ulink>: 200 <ulink url='&YOCTO_DOCS_ADT_URL;#using-the-adt-installer'>Application Development Toolkit (ADT) Installer</ulink>:
201 <literallayout class='monospaced'> 201 <literallayout class='monospaced'>
202 $ sudo yum install autoconf automake libtool glib2-devel 202 $ sudo yum install autoconf automake libtool glib2-devel
@@ -213,7 +213,7 @@
213 given a supported OpenSUSE Linux distribution: 213 given a supported OpenSUSE Linux distribution:
214 <itemizedlist> 214 <itemizedlist>
215 <listitem><para><emphasis>Essentials:</emphasis> 215 <listitem><para><emphasis>Essentials:</emphasis>
216 Packages needed to build an image for a headless 216 Packages needed to build an image for a headless
217 system: 217 system:
218 <literallayout class='monospaced'> 218 <literallayout class='monospaced'>
219 $ sudo zypper install &OPENSUSE_HOST_PACKAGES_ESSENTIAL; 219 $ sudo zypper install &OPENSUSE_HOST_PACKAGES_ESSENTIAL;
@@ -224,13 +224,13 @@
224 $ sudo zypper install libSDL-devel xterm 224 $ sudo zypper install libSDL-devel xterm
225 </literallayout></para></listitem> 225 </literallayout></para></listitem>
226 <listitem><para><emphasis>Documentation:</emphasis> 226 <listitem><para><emphasis>Documentation:</emphasis>
227 Packages needed if you are going to build out the 227 Packages needed if you are going to build out the
228 Yocto Project documentation manuals: 228 Yocto Project documentation manuals:
229 <literallayout class='monospaced'> 229 <literallayout class='monospaced'>
230 $ sudo zypper install make fop xsltproc 230 $ sudo zypper install make fop xsltproc
231 </literallayout></para></listitem> 231 </literallayout></para></listitem>
232 <listitem><para><emphasis>ADT Installer Extras:</emphasis> 232 <listitem><para><emphasis>ADT Installer Extras:</emphasis>
233 Packages needed if you are going to be using the 233 Packages needed if you are going to be using the
234 <ulink url='&YOCTO_DOCS_ADT_URL;#using-the-adt-installer'>Application Development Toolkit (ADT) Installer</ulink>: 234 <ulink url='&YOCTO_DOCS_ADT_URL;#using-the-adt-installer'>Application Development Toolkit (ADT) Installer</ulink>:
235 <literallayout class='monospaced'> 235 <literallayout class='monospaced'>
236 $ sudo zypper install autoconf automake libtool glib2-devel 236 $ sudo zypper install autoconf automake libtool glib2-devel
@@ -247,7 +247,7 @@
247 given a supported CentOS Linux distribution: 247 given a supported CentOS Linux distribution:
248 <itemizedlist> 248 <itemizedlist>
249 <listitem><para><emphasis>Essentials:</emphasis> 249 <listitem><para><emphasis>Essentials:</emphasis>
250 Packages needed to build an image for a headless 250 Packages needed to build an image for a headless
251 system: 251 system:
252 <literallayout class='monospaced'> 252 <literallayout class='monospaced'>
253 $ sudo yum -y install &CENTOS_HOST_PACKAGES_ESSENTIAL; 253 $ sudo yum -y install &CENTOS_HOST_PACKAGES_ESSENTIAL;
@@ -258,22 +258,22 @@
258 $ sudo yum -y install SDL-devel xterm 258 $ sudo yum -y install SDL-devel xterm
259 </literallayout></para></listitem> 259 </literallayout></para></listitem>
260 <listitem><para><emphasis>Documentation:</emphasis> 260 <listitem><para><emphasis>Documentation:</emphasis>
261 Packages needed if you are going to build out the 261 Packages needed if you are going to build out the
262 Yocto Project documentation manuals: 262 Yocto Project documentation manuals:
263 <literallayout class='monospaced'> 263 <literallayout class='monospaced'>
264 $ sudo yum -y install make docbook-style-dsssl docbook-style-xsl \ 264 $ sudo yum -y install make docbook-style-dsssl docbook-style-xsl \
265 docbook-dtds docbook-utils fop libxslt 265 docbook-dtds docbook-utils fop libxslt
266 </literallayout></para></listitem> 266 </literallayout></para></listitem>
267 <listitem><para><emphasis>ADT Installer Extras:</emphasis> 267 <listitem><para><emphasis>ADT Installer Extras:</emphasis>
268 Packages needed if you are going to be using the 268 Packages needed if you are going to be using the
269 <ulink url='&YOCTO_DOCS_ADT_URL;#using-the-adt-installer'>Application Development Toolkit (ADT) Installer</ulink>: 269 <ulink url='&YOCTO_DOCS_ADT_URL;#using-the-adt-installer'>Application Development Toolkit (ADT) Installer</ulink>:
270 <literallayout class='monospaced'> 270 <literallayout class='monospaced'>
271 $ sudo yum -y install autoconf automake libtool glib2-devel 271 $ sudo yum -y install autoconf automake libtool glib2-devel
272 </literallayout></para></listitem> 272 </literallayout></para></listitem>
273 </itemizedlist> 273 </itemizedlist>
274 <note>Depending on the CentOS version you are using, other requirements 274 <note>Depending on the CentOS version you are using, other requirements
275 and dependencies might exist. 275 and dependencies might exist.
276 For details, you should look at the CentOS sections on the 276 For details, you should look at the CentOS sections on the
277 <ulink url='https://wiki.yoctoproject.org/wiki/Poky/GettingStarted/Dependencies'>Poky/GettingStarted/Dependencies</ulink> 277 <ulink url='https://wiki.yoctoproject.org/wiki/Poky/GettingStarted/Dependencies'>Poky/GettingStarted/Dependencies</ulink>
278 wiki page.</note> 278 wiki page.</note>
279 </para> 279 </para>
@@ -284,19 +284,19 @@
284<section id='intro-getit'> 284<section id='intro-getit'>
285 <title>Obtaining the Yocto Project</title> 285 <title>Obtaining the Yocto Project</title>
286 <para> 286 <para>
287 The Yocto Project development team makes the Yocto Project available through a number 287 The Yocto Project development team makes the Yocto Project available through a number
288 of methods: 288 of methods:
289 <itemizedlist> 289 <itemizedlist>
290 <listitem><para><emphasis>Releases:</emphasis> Stable, tested releases are available through 290 <listitem><para><emphasis>Releases:</emphasis> Stable, tested releases are available through
291 <ulink url='&YOCTO_DL_URL;/releases/yocto/'/>.</para></listitem> 291 <ulink url='&YOCTO_DL_URL;/releases/yocto/'/>.</para></listitem>
292 <listitem><para><emphasis>Nightly Builds:</emphasis> These releases are available at 292 <listitem><para><emphasis>Nightly Builds:</emphasis> These releases are available at
293 <ulink url='http://autobuilder.yoctoproject.org/nightly'/>. 293 <ulink url='http://autobuilder.yoctoproject.org/nightly'/>.
294 These builds include Yocto Project releases, meta-toolchain tarball installation scripts, and 294 These builds include Yocto Project releases, meta-toolchain tarball installation scripts, and
295 experimental builds.</para></listitem> 295 experimental builds.</para></listitem>
296 <listitem><para><emphasis>Yocto Project Website:</emphasis> You can find releases 296 <listitem><para><emphasis>Yocto Project Website:</emphasis> You can find releases
297 of the Yocto Project and supported BSPs at the 297 of the Yocto Project and supported BSPs at the
298 <ulink url='&YOCTO_HOME_URL;'>Yocto Project website</ulink>. 298 <ulink url='&YOCTO_HOME_URL;'>Yocto Project website</ulink>.
299 Along with these downloads, you can find lots of other information at this site. 299 Along with these downloads, you can find lots of other information at this site.
300 </para></listitem> 300 </para></listitem>
301 </itemizedlist> 301 </itemizedlist>
302 </para> 302 </para>
@@ -305,13 +305,13 @@
305<section id='intro-getit-dev'> 305<section id='intro-getit-dev'>
306 <title>Development Checkouts</title> 306 <title>Development Checkouts</title>
307 <para> 307 <para>
308 Development using the Yocto Project requires a local 308 Development using the Yocto Project requires a local
309 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>. 309 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>.
310 You can set up the source directory by downloading a Yocto Project release tarball and unpacking it, 310 You can set up the source directory by downloading a Yocto Project release tarball and unpacking it,
311 or by cloning a copy of the upstream 311 or by cloning a copy of the upstream
312 <ulink url='&YOCTO_DOCS_DEV_URL;#poky'>Poky</ulink> Git repository. 312 <ulink url='&YOCTO_DOCS_DEV_URL;#poky'>Poky</ulink> Git repository.
313 For information on both these methods, see the 313 For information on both these methods, see the
314 "<ulink url='&YOCTO_DOCS_DEV_URL;#getting-setup'>Getting Setup</ulink>" 314 "<ulink url='&YOCTO_DOCS_DEV_URL;#getting-setup'>Getting Setup</ulink>"
315 section in the Yocto Project Development Manual. 315 section in the Yocto Project Development Manual.
316 </para> 316 </para>
317</section> 317</section>