MIRRORS/poky
1
0
Fork 0
mirror of git://git.yoctoproject.org/poky.git synced 2025-07-19 21:09:03 +02:00
Code Issues Actions Packages Projects Releases Wiki Activity

yocto-project-qs, ref-manual: Moved YP intro from QS to ref-manual

Browse Source 
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>
This commit is contained in:
Scott Rifenbark 2017-07-26 12:04:48 -07:00 committed by Richard Purdie
parent 5a402f9d1b
commit f4aa9783bd
6 changed files with 72 additions and 84 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
documentation/Makefile
View File

@ -143,7 +143,7 @@ endif
ifeq ($(DOC),yocto-project-qs)
XSLTOPTS = --xinclude
ALLPREQ = html eclipse tarball
TARFILES = yocto-project-qs.html qs-style.css figures/yocto-environment.png \
TARFILES = yocto-project-qs.html qs-style.css \
figures/yocto-project-transp.png \
eclipse
MANUALS = $(DOC)/$(DOC).html $(DOC)/eclipse
@ -191,7 +191,7 @@ TARFILES = mega-manual.html mega-style.css figures/yocto-environment.png \
figures/wip.png
else
TARFILES = mega-manual.html mega-style.css figures/yocto-environment.png \
figures/building-an-image.png \
figures/building-an-image.png figures/YP-flow-diagram.png \
figures/using-a-pre-built-image.png \
figures/poky-title.png figures/buildhistory.png \
figures/buildhistory-web.png \
@ -256,7 +256,7 @@ endif
ifeq ($(DOC),ref-manual)
XSLTOPTS = --xinclude
ALLPREQ = html eclipse tarball
TARFILES = ref-manual.html ref-style.css figures/poky-title.png \
TARFILES = ref-manual.html ref-style.css figures/poky-title.png figures/YP-flow-diagram.png \
figures/buildhistory.png figures/buildhistory-web.png eclipse \
figures/cross-development-toolchains.png figures/layer-input.png \
figures/package-feeds.png figures/source-input.png \

0
documentation/mega-manual/figures/yocto-environment.png → documentation/mega-manual/figures/YP-flow-diagram.png
View File

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 181 KiB

After

Width:  |  Height:  |  Size: 181 KiB

BIN
documentation/ref-manual/figures/YP-flow-diagram.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 186 KiB

74
documentation/ref-manual/introduction.xml
View File

@ -25,12 +25,14 @@
For introductory information on the Yocto Project, see the
<ulink url='&YOCTO_HOME_URL;/ecosystem/yocto-project-backgrounders'>Yocto Project Backgrounders</ulink>
on the
<ulink url='&YOCTO_HOME_URL;'>Yocto Project Website</ulink>.
<ulink url='&YOCTO_HOME_URL;'>Yocto Project Website</ulink> and the
"<link linkend='yp-intro'>Introducing the Yocto Project Development Environment</link>"
section.
</para>
<para>
You can find an introductory to using the Yocto Project by working
through the
If you want to use the Yocto Project to test run building an image
without having to understand concepts, work through the
<ulink url='&YOCTO_DOCS_QS_URL;'>Yocto Project Quick Start</ulink>.
You can find "how-to" information in the
<ulink url='&YOCTO_DOCS_DEV_URL;'>Yocto Project Development Manual</ulink>.
@ -43,8 +45,8 @@
</para>
</section>
<section id='ref-yp-intro'>
<title>Yocto Project Introduction</title>
<section id='yp-intro'>
<title>Introducing the Yocto Project Development Environment</title>
<para>
The Yocto Project is an open-source collaboration project whose
@ -69,6 +71,68 @@
is optimized for stylus-driven, low-resolution screens.
</para>
<mediaobject>
<imageobject>
<imagedata fileref="figures/YP-flow-diagram.png"
format="PNG" align='center' width="8in"/>
</imageobject>
</mediaobject>
<para>
Here are some highlights for the Yocto Project:
</para>
<itemizedlist>
<listitem><para>
Provides a recent Linux kernel along with a set of system
commands and libraries suitable for the embedded
environment.
</para></listitem>
<listitem><para>
Makes available system components such as X11, GTK+, Qt,
Clutter, and SDL (among others) so you can create a rich user
experience on devices that have display hardware.
For devices that do not have a display or where you wish to
use alternative UI frameworks, these components need not be
installed.
</para></listitem>
<listitem><para>
Creates a focused and stable core compatible with the
OpenEmbedded project with which you can easily and reliably
build and develop.
</para></listitem>
<listitem><para>
Fully supports a wide range of hardware and device emulation
through the Quick EMUlator (QEMU).
</para></listitem>
<listitem><para>
Provides a layer mechanism that allows you to easily extend
the system, make customizations, and keep them organized.
</para></listitem>
</itemizedlist>
<para>
You can use the Yocto Project to generate images for many kinds
of devices.
As mentioned earlier, the Yocto Project supports creation of
reference images that you can boot within and emulate using QEMU.
The standard example machines target QEMU full-system
emulation for 32-bit and 64-bit variants of x86, ARM, MIPS, and
PowerPC architectures.
Beyond emulation, you can use the layer mechanism to extend
support to just about any platform that Linux can run on and that
a toolchain can target.
</para>
<para>
Another Yocto Project feature is the Sato reference User
Interface.
This optional UI that is based on GTK+ is intended for devices with
restricted screen sizes and is included as part of the
OpenEmbedded Core layer so that developers can test parts of the
software stack.
</para>
<para>
While the Yocto Project does not provide a strict testing framework,
it does provide or generate for you artifacts that let you perform

BIN
documentation/yocto-project-qs/figures/yocto-environment.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 181 KiB

76
documentation/yocto-project-qs/yocto-project-qs.xml
View File

@ -161,82 +161,6 @@
</para>
</section>
<section id='yp-intro'>
<title>Introducing the Yocto Project Development Environment</title>
<para>
The Yocto Project through the OpenEmbedded build system provides an
open source development environment targeting the ARM, MIPS,
PowerPC, and x86 architectures for a variety of platforms
including x86-64 and emulated ones.
You can use components from the Yocto Project to design, develop,
build, debug, simulate, and test the complete software stack using
Linux, the X Window System, GTK+ frameworks, and Qt frameworks.
</para>
<mediaobject>
<imageobject>
<imagedata fileref="figures/yocto-environment.png"
format="PNG" align='center' width="8in"/>
</imageobject>
</mediaobject>
<para>
Here are some highlights for the Yocto Project:
</para>
<itemizedlist>
<listitem><para>
Provides a recent Linux kernel along with a set of system
commands and libraries suitable for the embedded
environment.
</para></listitem>
<listitem><para>
Makes available system components such as X11, GTK+, Qt,
Clutter, and SDL (among others) so you can create a rich user
experience on devices that have display hardware.
For devices that do not have a display or where you wish to
use alternative UI frameworks, these components need not be
installed.
</para></listitem>
<listitem><para>
Creates a focused and stable core compatible with the
OpenEmbedded project with which you can easily and reliably
build and develop.
</para></listitem>
<listitem><para>
Fully supports a wide range of hardware and device emulation
through the Quick EMUlator (QEMU).
</para></listitem>
<listitem><para>
Provides a layer mechanism that allows you to easily extend
the system, make customizations, and keep them organized.
</para></listitem>
</itemizedlist>
<para>
You can use the Yocto Project to generate images for many kinds
of devices.
As mentioned earlier, the Yocto Project supports creation of
reference images that you can boot within and emulate using QEMU.
The standard example machines target QEMU full-system
emulation for 32-bit and 64-bit variants of x86, ARM, MIPS, and
PowerPC architectures.
Beyond emulation, you can use the layer mechanism to extend
support to just about any platform that Linux can run on and that
a toolchain can target.
</para>
<para>
Another Yocto Project feature is the Sato reference User
Interface.
This optional UI that is based on GTK+ is intended for devices with
restricted screen sizes and is included as part of the
OpenEmbedded Core layer so that developers can test parts of the
software stack.
</para>
</section>
<section id='yp-resources'>
<title>Setting Up to Use the Yocto Project</title>