summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual/introduction.xml
diff options
context:
space:
mode:
authorScott Rifenbark <srifenbark@gmail.com>2018-01-05 14:03:53 -0800
committerRichard Purdie <richard.purdie@linuxfoundation.org>2018-02-14 15:25:27 +0000
commitc06a654c1d14f20b31256298543e2e3504acc0a9 (patch)
treef60ffd3eccf4b4434da4bd71e2357850e83ee1eb /documentation/ref-manual/introduction.xml
parent160b202d6222ed896475979afc074e6a9ad815d4 (diff)
downloadpoky-c06a654c1d14f20b31256298543e2e3504acc0a9.tar.gz
overview-manual, ref-manual: Moved introductory material to overview manual
Fixes [YOCTO #12370] Moved an introductory section for YP that was in the ref-manual to the beginning of the YP environment chapter of the overview-manual. Had to move a figure and update the makefile as well as adjust some links. (From yocto-docs rev: 8ec45f945a21b1f64e7529b95df6b5fb21e87449) Signed-off-by: Scott Rifenbark <srifenbark@gmail.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.xml120
1 files changed, 2 insertions, 118 deletions
diff --git a/documentation/ref-manual/introduction.xml b/documentation/ref-manual/introduction.xml
index 588d392f8e..098dbc8a22 100644
--- a/documentation/ref-manual/introduction.xml
+++ b/documentation/ref-manual/introduction.xml
@@ -24,8 +24,8 @@
24 <para> 24 <para>
25 For introductory information on the Yocto Project, see the 25 For introductory information on the Yocto Project, see the
26 <ulink url='&YOCTO_HOME_URL;'>Yocto Project Website</ulink> and the 26 <ulink url='&YOCTO_HOME_URL;'>Yocto Project Website</ulink> and the
27 "<link linkend='yp-intro'>Introducing the Yocto Project Development Environment</link>" 27 "<ulink url='&YOCTO_DOCS_OVERVIEW_URL;#overview-development-environment'>Yocto Project Development Environment</ulink>"
28 section. 28 chapter in the Yocto Project Overview Manual.
29 </para> 29 </para>
30 30
31 <para> 31 <para>
@@ -43,122 +43,6 @@
43 </para> 43 </para>
44</section> 44</section>
45 45
46<section id='yp-intro'>
47 <title>Introducing the Yocto Project Development Environment</title>
48
49 <para>
50 The Yocto Project is an open-source collaboration project whose
51 focus is for developers of embedded Linux systems.
52 Among other things, the Yocto Project uses an
53 <link linkend='build-system-term'>OpenEmbedded build system</link>.
54 The build system, which is based on the OpenEmbedded (OE) project and
55 uses the
56 <link linkend='bitbake-term'>BitBake</link> tool, constructs complete
57 Linux images for architectures based on ARM, MIPS, PowerPC, x86 and
58 x86-64.
59 <note>
60 Historically, the OpenEmbedded build system, which is the
61 combination of BitBake and OE components, formed a reference
62 build host that was known as
63 "<link linkend='poky'>Poky</link>" (<emphasis>Pah</emphasis>-kee).
64 The term "Poky", as used throughout the Yocto Project Documentation
65 set, can have different meanings.
66 </note>
67 The Yocto Project provides various ancillary tools for the embedded
68 developer and also features the Sato reference User Interface, which
69 is optimized for stylus-driven, low-resolution screens.
70 </para>
71
72 <mediaobject>
73 <imageobject>
74 <imagedata fileref="figures/YP-flow-diagram.png"
75 format="PNG" align='center' width="8in"/>
76 </imageobject>
77 </mediaobject>
78
79 <para>
80 Here are some highlights for the Yocto Project:
81 </para>
82
83 <itemizedlist>
84 <listitem><para>
85 Provides a recent Linux kernel along with a set of system
86 commands and libraries suitable for the embedded
87 environment.
88 </para></listitem>
89 <listitem><para>
90 Makes available system components such as X11, GTK+, Qt,
91 Clutter, and SDL (among others) so you can create a rich user
92 experience on devices that have display hardware.
93 For devices that do not have a display or where you wish to
94 use alternative UI frameworks, these components need not be
95 installed.
96 </para></listitem>
97 <listitem><para>
98 Creates a focused and stable core compatible with the
99 OpenEmbedded project with which you can easily and reliably
100 build and develop.
101 </para></listitem>
102 <listitem><para>
103 Fully supports a wide range of hardware and device emulation
104 through the Quick EMUlator (QEMU).
105 </para></listitem>
106 <listitem><para>
107 Provides a layer mechanism that allows you to easily extend
108 the system, make customizations, and keep them organized.
109 </para></listitem>
110 </itemizedlist>
111
112 <para>
113 You can use the Yocto Project to generate images for many kinds
114 of devices.
115 As mentioned earlier, the Yocto Project supports creation of
116 reference images that you can boot within and emulate using QEMU.
117 The standard example machines target QEMU full-system
118 emulation for 32-bit and 64-bit variants of x86, ARM, MIPS, and
119 PowerPC architectures.
120 Beyond emulation, you can use the layer mechanism to extend
121 support to just about any platform that Linux can run on and that
122 a toolchain can target.
123 </para>
124
125 <para>
126 Another Yocto Project feature is the Sato reference User
127 Interface.
128 This optional UI that is based on GTK+ is intended for devices with
129 restricted screen sizes and is included as part of the
130 OpenEmbedded Core layer so that developers can test parts of the
131 software stack.
132 </para>
133
134 <para>
135 While the Yocto Project does not provide a strict testing framework,
136 it does provide or generate for you artifacts that let you perform
137 target-level and emulated testing and debugging.
138 Additionally, if you are an
139 <trademark class='trade'>Eclipse</trademark> IDE user, you can
140 install an Eclipse Yocto Plug-in to allow you to develop within that
141 familiar environment.
142 </para>
143
144 <para>
145 By default, using the Yocto Project to build an image creates a Poky
146 distribution.
147 However, you can create your own distribution by providing key
148 <link link='metadata'>Metadata</link>.
149 A good example is Angstrom, which has had a distribution
150 based on the Yocto Project since its inception.
151 Other examples include commercial distributions like
152 <ulink url='https://www.yoctoproject.org/organization/wind-river-systems'>Wind River Linux</ulink>,
153 <ulink url='https://www.yoctoproject.org/organization/mentor-graphics'>Mentor Embedded Linux</ulink>,
154 <ulink url='https://www.yoctoproject.org/organization/enea-ab'>ENEA Linux</ulink>
155 and <ulink url='https://www.yoctoproject.org/ecosystem/member-organizations'>others</ulink>.
156 See the "<ulink url='&YOCTO_DOCS_DEV_URL;#creating-your-own-distribution'>Creating Your Own Distribution</ulink>"
157 section in the Yocto Project Development Tasks Manual for more
158 information.
159 </para>
160</section>
161
162<section id='intro-requirements'> 46<section id='intro-requirements'>
163<title>System Requirements</title> 47<title>System Requirements</title>
164 <para> 48 <para>