summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual/introduction.xml
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2012-12-11 12:07:58 -0600
committerRichard Purdie <richard.purdie@linuxfoundation.org>2013-01-07 14:43:25 +0000
commited0a240e1632682ec4c33341f3e24ad71773cdfc (patch)
tree201557f498b77b9f51fad7e12a6009f74aca4c65 /documentation/ref-manual/introduction.xml
parentaf19d889ef320f9625aae42eed6688b5cc739793 (diff)
downloadpoky-ed0a240e1632682ec4c33341f3e24ad71773cdfc.tar.gz
documentation: Rename of poky-ref-manual folder to ref-manual.
Changing the folder that holds the YP Reference Manual to be "ref-manual". This will help with confustion over the manual's intended purpose. (From yocto-docs rev: 1106442964b5080cb0b6b3bd3af32e9407c0f7c1) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/ref-manual/introduction.xml')
-rw-r--r--documentation/ref-manual/introduction.xml322
1 files changed, 322 insertions, 0 deletions
diff --git a/documentation/ref-manual/introduction.xml b/documentation/ref-manual/introduction.xml
new file mode 100644
index 0000000000..38c58da262
--- /dev/null
+++ b/documentation/ref-manual/introduction.xml
@@ -0,0 +1,322 @@
1<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
2"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
3[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] >
4
5<chapter id='intro'>
6<title>Introduction</title>
7
8<section id='intro-welcome'>
9 <title>Introduction</title>
10
11 <para>
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
14 developers.
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.
17 You can find complete introductory and getting started information on the Yocto Project
18 by reading the
19 <ulink url='&YOCTO_DOCS_QS_URL;'>Yocto Project Quick Start</ulink>.
20 For task-based information using the Yocto Project, see the
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
23 <ulink url="&YOCTO_HOME_URL;">Yocto Project website</ulink>.
24 </para>
25</section>
26
27<section id='intro-manualoverview'>
28 <title>Documentation Overview</title>
29 <para>
30 This reference manual consists of the following:
31 <itemizedlist>
32 <listitem><para><emphasis>
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
35 followed by information about debugging images created in the Yocto Project.
36 </para></listitem>
37 <listitem><para><emphasis>
38 <link linkend='technical-details'>Technical Details</link>:</emphasis>
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.
41 </para></listitem>
42 <listitem><para><emphasis>
43 <link linkend='ref-structure'>Directory Structure</link>:</emphasis>
44 This chapter describes the
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,
47 or by cloning the upstream
48 <ulink url='&YOCTO_DOCS_DEV_URL;#poky'>Poky</ulink> Git repository.
49 </para></listitem>
50 <listitem><para><emphasis>
51 <link linkend='ref-bitbake'>BitBake</link>:</emphasis>
52 This chapter provides an overview of the BitBake tool and its role within
53 the Yocto Project.</para></listitem>
54 <listitem><para><emphasis>
55 <link linkend='ref-classes'>Classes</link>:</emphasis>
56 This chapter describes the classes used in the Yocto Project.</para></listitem>
57 <listitem><para><emphasis>
58 <link linkend='ref-images'>Images</link>:</emphasis>
59 This chapter describes the standard images that the Yocto Project supports.
60 </para></listitem>
61 <listitem><para><emphasis>
62 <link linkend='ref-features'>Features</link>:</emphasis>
63 This chapter describes mechanisms for creating distribution, machine, and image
64 features during the build process using the OpenEmbedded build system.</para></listitem>
65 <listitem><para><emphasis>
66 <link linkend='ref-variables-glos'>Variables Glossary</link>:</emphasis>
67 This chapter presents most variables used by the OpenEmbedded build system, which
68 using BitBake.
69 Entries describe the function of the variable and how to apply them.
70 </para></listitem>
71 <listitem><para><emphasis>
72 <link linkend='ref-varlocality'>Variable Context</link>:</emphasis>
73 This chapter provides variable locality or context.</para></listitem>
74 <listitem><para><emphasis>
75 <link linkend='faq'>FAQ</link>:</emphasis>
76 This chapter provides answers for commonly asked questions in the Yocto Project
77 development environment.</para></listitem>
78 <listitem><para><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
81 Project.</para></listitem>
82 </itemizedlist>
83 </para>
84</section>
85
86
87<section id='intro-requirements'>
88<title>System Requirements</title>
89 <para>
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
92 in the Yocto Project Quick Start.
93 The remainder of this section provides details on system requirements
94 not covered in the Yocto Project Quick Start.
95 </para>
96
97 <section id='detailed-supported-distros'>
98 <title>Supported Linux Distributions</title>
99
100 <para>
101 Currently, the Yocto Project is supported on the following distributions:
102 <itemizedlist>
103 <listitem><para>Ubuntu 10.04.4 LTS</para></listitem>
104 <listitem><para>Ubuntu 11.10</para></listitem>
105 <listitem><para>Ubuntu 12.04.1 LTS</para></listitem>
106 <listitem><para>Ubuntu 12.04.1 LTS</para></listitem>
107 <listitem><para>Ubuntu 12.10</para></listitem>
108 <listitem><para>Fedora release 16 (Verne)</para></listitem>
109 <listitem><para>Fedora release 17 (Beefy Miracle)</para></listitem>
110 <listitem><para>Fedora release 18 (Spherical Cow)</para></listitem>
111 <listitem><para>CentOS release 5.6 (Final)</para></listitem>
112 <listitem><para>CentOS release 5.7 (Final)</para></listitem>
113 <listitem><para>CentOS release 5.8 (Final)</para></listitem>
114 <listitem><para>CentOS release 6.3 (Final)</para></listitem>
115 <listitem><para>Debian GNU/Linux 6.0.6 (squeeze)</para></listitem>
116 <listitem><para>openSUSE 11.4</para></listitem>
117 <listitem><para>openSUSE 12.1</para></listitem>
118 <listitem><para>openSUSE 12.2</para></listitem>
119 </itemizedlist>
120 </para>
121
122 <note>
123 For additional information on distributions that support the
124 Yocto Project, see the
125 <ulink url='&YOCTO_WIKI_URL;/wiki/Distribution_Support'>Distribution Support</ulink> wiki page.
126 </note>
127 </section>
128
129 <section id='required-packages-for-the-host-development-system'>
130 <title>Required Packages for the Host Development System</title>
131
132 <para>
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.
135 This section provides required packages by Linux distribution and
136 further categorized by function.
137 </para>
138
139 <section id='ubuntu-packages'>
140 <title>Ubuntu</title>
141
142 <para>
143 The following list shows the required packages by function
144 given a supported Ubuntu Linux distribution:
145 <itemizedlist>
146 <listitem><para><emphasis>Essentials:</emphasis>
147 Packages needed to build an image on a headless
148 system:
149 <literallayout class='monospaced'>
150 $ sudo apt-get install &UBUNTU_HOST_PACKAGES_ESSENTIAL;
151 </literallayout></para></listitem>
152 <listitem><para><emphasis>Graphical Extras:</emphasis>
153 Packages recommended if the host system has graphics support:
154 <literallayout class='monospaced'>
155 $ sudo apt-get install libsdl1.2-dev xterm
156 </literallayout></para></listitem>
157 <listitem><para><emphasis>Documentation:</emphasis>
158 Packages needed if you are going to build out the
159 Yocto Project documentation manuals:
160 <literallayout class='monospaced'>
161 $ sudo apt-get install make xsltproc docbook-utils fop
162 </literallayout></para></listitem>
163 <listitem><para><emphasis>ADT Installer Extras:</emphasis>
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>:
166 <literallayout class='monospaced'>
167 $ sudo apt-get install autoconf automake libtool libglib2.0-dev
168 </literallayout></para></listitem>
169 </itemizedlist>
170 </para>
171 </section>
172
173 <section id='fedora-packages'>
174 <title>Fedora Packages</title>
175
176 <para>
177 The following list shows the required packages by function
178 given a supported Fedora Linux distribution:
179 <itemizedlist>
180 <listitem><para><emphasis>Essentials:</emphasis>
181 Packages needed to build an image for a headless
182 system:
183 <literallayout class='monospaced'>
184 $ sudo yum install &FEDORA_HOST_PACKAGES_ESSENTIAL;
185 </literallayout></para></listitem>
186 <listitem><para><emphasis>Graphical Extras:</emphasis>
187 Packages recommended if the host system has graphics support:
188 <literallayout class='monospaced'>
189 $ sudo yum install SDL-devel xterm
190 </literallayout></para></listitem>
191 <listitem><para><emphasis>Documentation:</emphasis>
192 Packages needed if you are going to build out the
193 Yocto Project documentation manuals:
194 <literallayout class='monospaced'>
195 $ sudo yum install make docbook-style-dsssl docbook-style-xsl \
196 docbook-dtds docbook-utils fop libxslt
197 </literallayout></para></listitem>
198 <listitem><para><emphasis>ADT Installer Extras:</emphasis>
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>:
201 <literallayout class='monospaced'>
202 $ sudo yum install autoconf automake libtool glib2-devel
203 </literallayout></para></listitem>
204 </itemizedlist>
205 </para>
206 </section>
207
208 <section id='opensuse-packages'>
209 <title>OpenSUSE Packages</title>
210
211 <para>
212 The following list shows the required packages by function
213 given a supported OpenSUSE Linux distribution:
214 <itemizedlist>
215 <listitem><para><emphasis>Essentials:</emphasis>
216 Packages needed to build an image for a headless
217 system:
218 <literallayout class='monospaced'>
219 $ sudo zypper install &OPENSUSE_HOST_PACKAGES_ESSENTIAL;
220 </literallayout></para></listitem>
221 <listitem><para><emphasis>Graphical Extras:</emphasis>
222 Packages recommended if the host system has graphics support:
223 <literallayout class='monospaced'>
224 $ sudo zypper install libSDL-devel xterm
225 </literallayout></para></listitem>
226 <listitem><para><emphasis>Documentation:</emphasis>
227 Packages needed if you are going to build out the
228 Yocto Project documentation manuals:
229 <literallayout class='monospaced'>
230 $ sudo zypper install make fop xsltproc
231 </literallayout></para></listitem>
232 <listitem><para><emphasis>ADT Installer Extras:</emphasis>
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>:
235 <literallayout class='monospaced'>
236 $ sudo zypper install autoconf automake libtool glib2-devel
237 </literallayout></para></listitem>
238 </itemizedlist>
239 </para>
240 </section>
241
242 <section id='centos-packages'>
243 <title>CentOS Packages</title>
244
245 <para>
246 The following list shows the required packages by function
247 given a supported CentOS Linux distribution:
248 <itemizedlist>
249 <listitem><para><emphasis>Essentials:</emphasis>
250 Packages needed to build an image for a headless
251 system:
252 <literallayout class='monospaced'>
253 $ sudo yum -y install &CENTOS_HOST_PACKAGES_ESSENTIAL;
254 </literallayout></para></listitem>
255 <listitem><para><emphasis>Graphical Extras:</emphasis>
256 Packages recommended if the host system has graphics support:
257 <literallayout class='monospaced'>
258 $ sudo yum -y install SDL-devel xterm
259 </literallayout></para></listitem>
260 <listitem><para><emphasis>Documentation:</emphasis>
261 Packages needed if you are going to build out the
262 Yocto Project documentation manuals:
263 <literallayout class='monospaced'>
264 $ sudo yum -y install make docbook-style-dsssl docbook-style-xsl \
265 docbook-dtds docbook-utils fop libxslt
266 </literallayout></para></listitem>
267 <listitem><para><emphasis>ADT Installer Extras:</emphasis>
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>:
270 <literallayout class='monospaced'>
271 $ sudo yum -y install autoconf automake libtool glib2-devel
272 </literallayout></para></listitem>
273 </itemizedlist>
274 <note>Depending on the CentOS version you are using, other requirements
275 and dependencies might exist.
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>
278 wiki page.</note>
279 </para>
280 </section>
281 </section>
282</section>
283
284<section id='intro-getit'>
285 <title>Obtaining the Yocto Project</title>
286 <para>
287 The Yocto Project development team makes the Yocto Project available through a number
288 of methods:
289 <itemizedlist>
290 <listitem><para><emphasis>Releases:</emphasis> Stable, tested releases are available through
291 <ulink url='&YOCTO_DL_URL;/releases/yocto/'/>.</para></listitem>
292 <listitem><para><emphasis>Nightly Builds:</emphasis> These releases are available at
293 <ulink url='http://autobuilder.yoctoproject.org/nightly'/>.
294 These builds include Yocto Project releases, meta-toolchain tarball installation scripts, and
295 experimental builds.</para></listitem>
296 <listitem><para><emphasis>Yocto Project Website:</emphasis> You can find releases
297 of the Yocto Project and supported BSPs at the
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.
300 </para></listitem>
301 </itemizedlist>
302 </para>
303</section>
304
305<section id='intro-getit-dev'>
306 <title>Development Checkouts</title>
307 <para>
308 Development using the Yocto Project requires a local
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,
311 or by cloning a copy of the upstream
312 <ulink url='&YOCTO_DOCS_DEV_URL;#poky'>Poky</ulink> Git repository.
313 For information on both these methods, see the
314 "<ulink url='&YOCTO_DOCS_DEV_URL;#getting-setup'>Getting Setup</ulink>"
315 section in the Yocto Project Development Manual.
316 </para>
317</section>
318
319</chapter>
320<!--
321vim: expandtab tw=80 ts=4
322-->
generated by cgit v1.2.3-54-g00ecf (git 2.39.0) at 2024-04-28 09:34:22 +0000