summaryrefslogtreecommitdiffstats
path: root/documentation
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
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')
-rw-r--r--documentation/Makefile6
-rw-r--r--documentation/mega-manual/figures/YP-flow-diagram.png (renamed from documentation/mega-manual/figures/yocto-environment.png)bin185562 -> 185562 bytes
-rw-r--r--documentation/ref-manual/figures/YP-flow-diagram.pngbin0 -> 190715 bytes
-rw-r--r--documentation/ref-manual/introduction.xml74
-rw-r--r--documentation/yocto-project-qs/figures/yocto-environment.pngbin185562 -> 0 bytes
-rw-r--r--documentation/yocto-project-qs/yocto-project-qs.xml76
6 files changed, 72 insertions, 84 deletions
diff --git a/documentation/Makefile b/documentation/Makefile
index e32b83a685..f4497ccc6b 100644
--- a/documentation/Makefile
+++ b/documentation/Makefile
@@ -143,7 +143,7 @@ endif
143ifeq ($(DOC),yocto-project-qs) 143ifeq ($(DOC),yocto-project-qs)
144XSLTOPTS = --xinclude 144XSLTOPTS = --xinclude
145ALLPREQ = html eclipse tarball 145ALLPREQ = html eclipse tarball
146TARFILES = yocto-project-qs.html qs-style.css figures/yocto-environment.png \ 146TARFILES = yocto-project-qs.html qs-style.css \
147 figures/yocto-project-transp.png \ 147 figures/yocto-project-transp.png \
148 eclipse 148 eclipse
149MANUALS = $(DOC)/$(DOC).html $(DOC)/eclipse 149MANUALS = $(DOC)/$(DOC).html $(DOC)/eclipse
@@ -191,7 +191,7 @@ TARFILES = mega-manual.html mega-style.css figures/yocto-environment.png \
191 figures/wip.png 191 figures/wip.png
192 else 192 else
193TARFILES = mega-manual.html mega-style.css figures/yocto-environment.png \ 193TARFILES = mega-manual.html mega-style.css figures/yocto-environment.png \
194 figures/building-an-image.png \ 194 figures/building-an-image.png figures/YP-flow-diagram.png \
195 figures/using-a-pre-built-image.png \ 195 figures/using-a-pre-built-image.png \
196 figures/poky-title.png figures/buildhistory.png \ 196 figures/poky-title.png figures/buildhistory.png \
197 figures/buildhistory-web.png \ 197 figures/buildhistory-web.png \
@@ -256,7 +256,7 @@ endif
256ifeq ($(DOC),ref-manual) 256ifeq ($(DOC),ref-manual)
257XSLTOPTS = --xinclude 257XSLTOPTS = --xinclude
258ALLPREQ = html eclipse tarball 258ALLPREQ = html eclipse tarball
259TARFILES = ref-manual.html ref-style.css figures/poky-title.png \ 259TARFILES = ref-manual.html ref-style.css figures/poky-title.png figures/YP-flow-diagram.png \
260 figures/buildhistory.png figures/buildhistory-web.png eclipse \ 260 figures/buildhistory.png figures/buildhistory-web.png eclipse \
261 figures/cross-development-toolchains.png figures/layer-input.png \ 261 figures/cross-development-toolchains.png figures/layer-input.png \
262 figures/package-feeds.png figures/source-input.png \ 262 figures/package-feeds.png figures/source-input.png \
diff --git a/documentation/mega-manual/figures/yocto-environment.png b/documentation/mega-manual/figures/YP-flow-diagram.png
index 35969038c9..35969038c9 100644
--- a/documentation/mega-manual/figures/yocto-environment.png
+++ b/documentation/mega-manual/figures/YP-flow-diagram.png
Binary files differ
diff --git a/documentation/ref-manual/figures/YP-flow-diagram.png b/documentation/ref-manual/figures/YP-flow-diagram.png
new file mode 100644
index 0000000000..8264410504
--- /dev/null
+++ b/documentation/ref-manual/figures/YP-flow-diagram.png
Binary files differ
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
diff --git a/documentation/yocto-project-qs/figures/yocto-environment.png b/documentation/yocto-project-qs/figures/yocto-environment.png
deleted file mode 100644
index 35969038c9..0000000000
--- a/documentation/yocto-project-qs/figures/yocto-environment.png
+++ /dev/null
Binary files differ
diff --git a/documentation/yocto-project-qs/yocto-project-qs.xml b/documentation/yocto-project-qs/yocto-project-qs.xml
index 9a4a14731f..f1b6728bd0 100644
--- a/documentation/yocto-project-qs/yocto-project-qs.xml
+++ b/documentation/yocto-project-qs/yocto-project-qs.xml
@@ -161,82 +161,6 @@
161 </para> 161 </para>
162 </section> 162 </section>
163 163
164 <section id='yp-intro'>
165 <title>Introducing the Yocto Project Development Environment</title>
166
167 <para>
168 The Yocto Project through the OpenEmbedded build system provides an
169 open source development environment targeting the ARM, MIPS,
170 PowerPC, and x86 architectures for a variety of platforms
171 including x86-64 and emulated ones.
172 You can use components from the Yocto Project to design, develop,
173 build, debug, simulate, and test the complete software stack using
174 Linux, the X Window System, GTK+ frameworks, and Qt frameworks.
175 </para>
176
177 <mediaobject>
178 <imageobject>
179 <imagedata fileref="figures/yocto-environment.png"
180 format="PNG" align='center' width="8in"/>
181 </imageobject>
182 </mediaobject>
183
184 <para>
185 Here are some highlights for the Yocto Project:
186 </para>
187
188 <itemizedlist>
189 <listitem><para>
190 Provides a recent Linux kernel along with a set of system
191 commands and libraries suitable for the embedded
192 environment.
193 </para></listitem>
194 <listitem><para>
195 Makes available system components such as X11, GTK+, Qt,
196 Clutter, and SDL (among others) so you can create a rich user
197 experience on devices that have display hardware.
198 For devices that do not have a display or where you wish to
199 use alternative UI frameworks, these components need not be
200 installed.
201 </para></listitem>
202 <listitem><para>
203 Creates a focused and stable core compatible with the
204 OpenEmbedded project with which you can easily and reliably
205 build and develop.
206 </para></listitem>
207 <listitem><para>
208 Fully supports a wide range of hardware and device emulation
209 through the Quick EMUlator (QEMU).
210 </para></listitem>
211 <listitem><para>
212 Provides a layer mechanism that allows you to easily extend
213 the system, make customizations, and keep them organized.
214 </para></listitem>
215 </itemizedlist>
216
217 <para>
218 You can use the Yocto Project to generate images for many kinds
219 of devices.
220 As mentioned earlier, the Yocto Project supports creation of
221 reference images that you can boot within and emulate using QEMU.
222 The standard example machines target QEMU full-system
223 emulation for 32-bit and 64-bit variants of x86, ARM, MIPS, and
224 PowerPC architectures.
225 Beyond emulation, you can use the layer mechanism to extend
226 support to just about any platform that Linux can run on and that
227 a toolchain can target.
228 </para>
229
230 <para>
231 Another Yocto Project feature is the Sato reference User
232 Interface.
233 This optional UI that is based on GTK+ is intended for devices with
234 restricted screen sizes and is included as part of the
235 OpenEmbedded Core layer so that developers can test parts of the
236 software stack.
237 </para>
238 </section>
239
240 <section id='yp-resources'> 164 <section id='yp-resources'>
241 <title>Setting Up to Use the Yocto Project</title> 165 <title>Setting Up to Use the Yocto Project</title>
242 166