summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
Diffstat
-rw-r--r--documentation/Makefile3
-rw-r--r--documentation/overview-manual/figures/YP-flow-diagram.png (renamed from documentation/ref-manual/figures/YP-flow-diagram.png)bin190715 -> 190715 bytes
-rw-r--r--documentation/overview-manual/overview-development-environment.xml117
-rw-r--r--documentation/ref-manual/introduction.xml120
4 files changed, 121 insertions, 119 deletions
diff --git a/documentation/Makefile b/documentation/Makefile
index bb7f327598..4759a1d992 100644
--- a/documentation/Makefile
+++ b/documentation/Makefile
@@ -94,6 +94,7 @@ TARFILES = overview-style.css overview-manual.html figures/overview-title.png \
94 figures/source-fetching.png figures/patching.png figures/configuration-compile-autoreconf.png \ 94 figures/source-fetching.png figures/patching.png figures/configuration-compile-autoreconf.png \
95 figures/analysis-for-package-splitting.png figures/image-generation.png \ 95 figures/analysis-for-package-splitting.png figures/image-generation.png \
96 figures/sdk-generation.png figures/images.png figures/sdk.png \ 96 figures/sdk-generation.png figures/images.png figures/sdk.png \
97 figures/YP-flow-diagram.png \
97 eclipse 98 eclipse
98MANUALS = $(DOC)/$(DOC).html $(DOC)/eclipse 99MANUALS = $(DOC)/$(DOC).html $(DOC)/eclipse
99FIGURES = figures 100FIGURES = figures
@@ -279,7 +280,7 @@ endif
279ifeq ($(DOC),ref-manual) 280ifeq ($(DOC),ref-manual)
280XSLTOPTS = --xinclude 281XSLTOPTS = --xinclude
281ALLPREQ = html eclipse tarball 282ALLPREQ = html eclipse tarball
282TARFILES = ref-manual.html ref-style.css figures/poky-title.png figures/YP-flow-diagram.png \ 283TARFILES = ref-manual.html ref-style.css figures/poky-title.png \
283 figures/buildhistory.png figures/buildhistory-web.png \ 284 figures/buildhistory.png figures/buildhistory-web.png \
284 figures/cross-development-toolchains.png \ 285 figures/cross-development-toolchains.png \
285 figures/building-an-image.png \ 286 figures/building-an-image.png \
diff --git a/documentation/ref-manual/figures/YP-flow-diagram.png b/documentation/overview-manual/figures/YP-flow-diagram.png
index 8264410504..8264410504 100644
--- a/documentation/ref-manual/figures/YP-flow-diagram.png
+++ b/documentation/overview-manual/figures/YP-flow-diagram.png
Binary files differ
diff --git a/documentation/overview-manual/overview-development-environment.xml b/documentation/overview-manual/overview-development-environment.xml
index 32fe1816ab..d34f35ec88 100644
--- a/documentation/overview-manual/overview-development-environment.xml
+++ b/documentation/overview-manual/overview-development-environment.xml
@@ -21,6 +21,123 @@
21 syntax. 21 syntax.
22</para> 22</para>
23 23
24<section id='yp-intro'>
25 <title>Introduction</title>
26
27 <para>
28 The Yocto Project is an open-source collaboration project whose
29 focus is for developers of embedded Linux systems.
30 Among other things, the Yocto Project uses an
31 <ulink url='&YOCTO_DOCS_REF_URL;#build-system-term'>OpenEmbedded build system</ulink>.
32 The build system, which is based on the OpenEmbedded (OE) project and
33 uses the
34 <ulink url='&YOCTO_DOCS_REF_URL;#bitbake-term'>BitBake</ulink> tool,
35 constructs complete Linux images for architectures based on ARM, MIPS,
36 PowerPC, x86 and x86-64.
37 <note>
38 Historically, the OpenEmbedded build system, which is the
39 combination of BitBake and OE components, formed a reference
40 build host that was known as
41 "<ulink url='&YOCTO_DOCS_REF_URL;#poky'>Poky</ulink>"
42 (<emphasis>Pah</emphasis>-kee).
43 The term "Poky", as used throughout the Yocto Project Documentation
44 set, can have different meanings.
45 </note>
46 The Yocto Project provides various ancillary tools for the embedded
47 developer and also features the Sato reference User Interface, which
48 is optimized for stylus-driven, low-resolution screens.
49 </para>
50
51 <mediaobject>
52 <imageobject>
53 <imagedata fileref="figures/YP-flow-diagram.png"
54 format="PNG" align='center' width="8in"/>
55 </imageobject>
56 </mediaobject>
57
58 <para>
59 Here are some highlights for the Yocto Project:
60 </para>
61
62 <itemizedlist>
63 <listitem><para>
64 Provides a recent Linux kernel along with a set of system
65 commands and libraries suitable for the embedded
66 environment.
67 </para></listitem>
68 <listitem><para>
69 Makes available system components such as X11, GTK+, Qt,
70 Clutter, and SDL (among others) so you can create a rich user
71 experience on devices that have display hardware.
72 For devices that do not have a display or where you wish to
73 use alternative UI frameworks, these components need not be
74 installed.
75 </para></listitem>
76 <listitem><para>
77 Creates a focused and stable core compatible with the
78 OpenEmbedded project with which you can easily and reliably
79 build and develop.
80 </para></listitem>
81 <listitem><para>
82 Fully supports a wide range of hardware and device emulation
83 through the Quick EMUlator (QEMU).
84 </para></listitem>
85 <listitem><para>
86 Provides a layer mechanism that allows you to easily extend
87 the system, make customizations, and keep them organized.
88 </para></listitem>
89 </itemizedlist>
90
91 <para>
92 You can use the Yocto Project to generate images for many kinds
93 of devices.
94 As mentioned earlier, the Yocto Project supports creation of
95 reference images that you can boot within and emulate using QEMU.
96 The standard example machines target QEMU full-system
97 emulation for 32-bit and 64-bit variants of x86, ARM, MIPS, and
98 PowerPC architectures.
99 Beyond emulation, you can use the layer mechanism to extend
100 support to just about any platform that Linux can run on and that
101 a toolchain can target.
102 </para>
103
104 <para>
105 Another Yocto Project feature is the Sato reference User
106 Interface.
107 This optional UI that is based on GTK+ is intended for devices with
108 restricted screen sizes and is included as part of the
109 OpenEmbedded Core layer so that developers can test parts of the
110 software stack.
111 </para>
112
113 <para>
114 While the Yocto Project does not provide a strict testing framework,
115 it does provide or generate for you artifacts that let you perform
116 target-level and emulated testing and debugging.
117 Additionally, if you are an
118 <trademark class='trade'>Eclipse</trademark> IDE user, you can
119 install an Eclipse Yocto Plug-in to allow you to develop within that
120 familiar environment.
121 </para>
122
123 <para>
124 By default, using the Yocto Project to build an image creates a Poky
125 distribution.
126 However, you can create your own distribution by providing key
127 <ulink url='&YOCTO_DOCS_REF_URL;#metadata'>Metadata</ulink>.
128 A good example is Angstrom, which has had a distribution
129 based on the Yocto Project since its inception.
130 Other examples include commercial distributions like
131 <ulink url='https://www.yoctoproject.org/organization/wind-river-systems'>Wind River Linux</ulink>,
132 <ulink url='https://www.yoctoproject.org/organization/mentor-graphics'>Mentor Embedded Linux</ulink>,
133 <ulink url='https://www.yoctoproject.org/organization/enea-ab'>ENEA Linux</ulink>
134 and <ulink url='https://www.yoctoproject.org/ecosystem/member-organizations'>others</ulink>.
135 See the "<ulink url='&YOCTO_DOCS_DEV_URL;#creating-your-own-distribution'>Creating Your Own Distribution</ulink>"
136 section in the Yocto Project Development Tasks Manual for more
137 information.
138 </para>
139</section>
140
24<section id='open-source-philosophy'> 141<section id='open-source-philosophy'>
25 <title>Open Source Philosophy</title> 142 <title>Open Source Philosophy</title>
26 143
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>
generated by cgit v1.2.3-54-g00ecf (git 2.39.0) at 2026-04-22 22:26:38 +0000