summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual/introduction.xml
diff options
context:
space:
mode:
authorScott Rifenbark <srifenbark@gmail.com>2017-07-26 12:04:48 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2017-07-30 16:23:51 +0100
commitf4aa9783bdd1b37aefb51b8cf55c3502bf031a4e (patch)
tree023232a0053a8f3714192cecb76199d432b68978 /documentation/ref-manual/introduction.xml
parent5a402f9d1b6d4b829bdabaa4cb1c57bc7db1684b (diff)
downloadpoky-f4aa9783bdd1b37aefb51b8cf55c3502bf031a4e.tar.gz
yocto-project-qs, ref-manual: Moved YP intro from QS to ref-manual
Fixes [YOCTO #11630] The introductory stuff in the QS is really conceptual information and needs to be in the ref-manual where YP is introduced. Regarding the QS, all we really need to do is point to places where the reader can go to find that stuff out. Part of this move involved getting the diagram of the YP flow for the environment from the QS to the ref-manual. That figure was named "YP-flow-diagram.png". It was named "yocto-environment.png" in the QS but I renamed it when moving it to the ref-manual. This caused some edits to the "Makefile" to clean up the figure lists for tarballs. (From yocto-docs rev: ab108c0959e3a9f36d25080245482f8a790c8c87) 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.xml74
1 files changed, 69 insertions, 5 deletions
diff --git a/documentation/ref-manual/introduction.xml b/documentation/ref-manual/introduction.xml
index 3e89856293..4fd1e95a61 100644
--- a/documentation/ref-manual/introduction.xml
+++ b/documentation/ref-manual/introduction.xml
@@ -25,12 +25,14 @@
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;/ecosystem/yocto-project-backgrounders'>Yocto Project Backgrounders</ulink> 26 <ulink url='&YOCTO_HOME_URL;/ecosystem/yocto-project-backgrounders'>Yocto Project Backgrounders</ulink>
27 on the 27 on the
28 <ulink url='&YOCTO_HOME_URL;'>Yocto Project Website</ulink>. 28 <ulink url='&YOCTO_HOME_URL;'>Yocto Project Website</ulink> and the
29 "<link linkend='yp-intro'>Introducing the Yocto Project Development Environment</link>"
30 section.
29 </para> 31 </para>
30 32
31 <para> 33 <para>
32 You can find an introductory to using the Yocto Project by working 34 If you want to use the Yocto Project to test run building an image
33 through the 35 without having to understand concepts, work through the
34 <ulink url='&YOCTO_DOCS_QS_URL;'>Yocto Project Quick Start</ulink>. 36 <ulink url='&YOCTO_DOCS_QS_URL;'>Yocto Project Quick Start</ulink>.
35 You can find "how-to" information in the 37 You can find "how-to" information in the
36 <ulink url='&YOCTO_DOCS_DEV_URL;'>Yocto Project Development Manual</ulink>. 38 <ulink url='&YOCTO_DOCS_DEV_URL;'>Yocto Project Development Manual</ulink>.
@@ -43,8 +45,8 @@
43 </para> 45 </para>
44</section> 46</section>
45 47
46<section id='ref-yp-intro'> 48<section id='yp-intro'>
47 <title>Yocto Project Introduction</title> 49 <title>Introducing the Yocto Project Development Environment</title>
48 50
49 <para> 51 <para>
50 The Yocto Project is an open-source collaboration project whose 52 The Yocto Project is an open-source collaboration project whose
@@ -69,6 +71,68 @@
69 is optimized for stylus-driven, low-resolution screens. 71 is optimized for stylus-driven, low-resolution screens.
70 </para> 72 </para>
71 73
74 <mediaobject>
75 <imageobject>
76 <imagedata fileref="figures/YP-flow-diagram.png"
77 format="PNG" align='center' width="8in"/>
78 </imageobject>
79 </mediaobject>
80
81 <para>
82 Here are some highlights for the Yocto Project:
83 </para>
84
85 <itemizedlist>
86 <listitem><para>
87 Provides a recent Linux kernel along with a set of system
88 commands and libraries suitable for the embedded
89 environment.
90 </para></listitem>
91 <listitem><para>
92 Makes available system components such as X11, GTK+, Qt,
93 Clutter, and SDL (among others) so you can create a rich user
94 experience on devices that have display hardware.
95 For devices that do not have a display or where you wish to
96 use alternative UI frameworks, these components need not be
97 installed.
98 </para></listitem>
99 <listitem><para>
100 Creates a focused and stable core compatible with the
101 OpenEmbedded project with which you can easily and reliably
102 build and develop.
103 </para></listitem>
104 <listitem><para>
105 Fully supports a wide range of hardware and device emulation
106 through the Quick EMUlator (QEMU).
107 </para></listitem>
108 <listitem><para>
109 Provides a layer mechanism that allows you to easily extend
110 the system, make customizations, and keep them organized.
111 </para></listitem>
112 </itemizedlist>
113
114 <para>
115 You can use the Yocto Project to generate images for many kinds
116 of devices.
117 As mentioned earlier, the Yocto Project supports creation of
118 reference images that you can boot within and emulate using QEMU.
119 The standard example machines target QEMU full-system
120 emulation for 32-bit and 64-bit variants of x86, ARM, MIPS, and
121 PowerPC architectures.
122 Beyond emulation, you can use the layer mechanism to extend
123 support to just about any platform that Linux can run on and that
124 a toolchain can target.
125 </para>
126
127 <para>
128 Another Yocto Project feature is the Sato reference User
129 Interface.
130 This optional UI that is based on GTK+ is intended for devices with
131 restricted screen sizes and is included as part of the
132 OpenEmbedded Core layer so that developers can test parts of the
133 software stack.
134 </para>
135
72 <para> 136 <para>
73 While the Yocto Project does not provide a strict testing framework, 137 While the Yocto Project does not provide a strict testing framework,
74 it does provide or generate for you artifacts that let you perform 138 it does provide or generate for you artifacts that let you perform