summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual
diff options
context:
space:
mode:
authorScott Rifenbark <srifenbark@gmail.com>2018-02-20 15:25:49 -0800
committerRichard Purdie <richard.purdie@linuxfoundation.org>2018-03-03 08:35:24 +0000
commit6f488928cb25960e42794c20ce77f2b2978e4fa2 (patch)
tree292c9a863f0b4c6c832737a6ceecf2623f6b6c61 /documentation/ref-manual
parent189851f9d6c32f32a236338c35d2a911a91f2282 (diff)
downloadpoky-6f488928cb25960e42794c20ce77f2b2978e4fa2.tar.gz
ref-manual: Updated some terms in the "Terms" chapter.
(From yocto-docs rev: c00be16a858ece1d3b02d554ec202088f78a2d1d) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/ref-manual')
-rw-r--r--documentation/ref-manual/ref-terms.xml136
1 files changed, 97 insertions, 39 deletions
diff --git a/documentation/ref-manual/ref-terms.xml b/documentation/ref-manual/ref-terms.xml
index 63fbf9c7b2..e746b4b7c6 100644
--- a/documentation/ref-manual/ref-terms.xml
+++ b/documentation/ref-manual/ref-terms.xml
@@ -135,8 +135,15 @@
135 </para></listitem> 135 </para></listitem>
136 <listitem><para> 136 <listitem><para>
137 <emphasis>Configuration File:</emphasis> 137 <emphasis>Configuration File:</emphasis>
138 Configuration information in various <filename>.conf</filename> 138 Files that hold global definitions of variables,
139 files provides global definitions of variables. 139 user-defined variables, and hardware configuration
140 information.
141 These files tell the OpenEmbedded build system what to
142 build and what to put into the image to support a
143 particular platform.</para>
144
145 <para>Configuration files end with a <filename>.conf</filename>
146 filename extension.
140 The <filename>conf/local.conf</filename> configuration file in 147 The <filename>conf/local.conf</filename> configuration file in
141 the 148 the
142 <link linkend='build-directory'>Build Directory</link> 149 <link linkend='build-directory'>Build Directory</link>
@@ -152,8 +159,6 @@
152 <filename>machine/beaglebone.conf</filename> configuration 159 <filename>machine/beaglebone.conf</filename> configuration
153 file defines variables for the Texas Instruments ARM Cortex-A8 160 file defines variables for the Texas Instruments ARM Cortex-A8
154 development board). 161 development board).
155 Configuration files end with a <filename>.conf</filename>
156 filename extension.
157 </para></listitem> 162 </para></listitem>
158 <listitem><para id='cross-development-toolchain'> 163 <listitem><para id='cross-development-toolchain'>
159 <emphasis>Cross-Development Toolchain:</emphasis> 164 <emphasis>Cross-Development Toolchain:</emphasis>
@@ -189,6 +194,17 @@
189 manual. 194 manual.
190 </para></listitem> 195 </para></listitem>
191 <listitem><para> 196 <listitem><para>
197 <emphasis>Extensible Software Development Kit (eSDK):</emphasis>
198 A custom SDK for application developers.
199 This eSDK allows developers to incorporate their library
200 and programming changes back into the image to make
201 their code available to other application developers.</para>
202
203 <para>For information on the eSDK, see the
204 <ulink url='&YOCTO_DOCS_SDK_URL;'>Yocto Project Application Development and Extensible Software Development Kit (eSDK)</ulink>
205 manual.
206 </para></listitem>
207 <listitem><para>
192 <emphasis>Image:</emphasis> 208 <emphasis>Image:</emphasis>
193 An image is an artifact of the BitBake build process given 209 An image is an artifact of the BitBake build process given
194 a collection of recipes and related Metadata. 210 a collection of recipes and related Metadata.
@@ -201,8 +217,25 @@
201 </para></listitem> 217 </para></listitem>
202 <listitem><para> 218 <listitem><para>
203 <emphasis>Layer:</emphasis> 219 <emphasis>Layer:</emphasis>
204 A collection of recipes representing the core, 220 A collection of related recipes.
205 a BSP, or an application stack. 221 Layers allow you to consolidate related metadata to
222 customize your build.
223 Layers also isolate information used when building
224 for multiple architectures.
225 Layers are hierarchical in their ability to override
226 previous specifications.
227 You can include any number of available layers from the
228 Yocto Project and customize the build by adding your
229 layers after them.
230 You can search the Layer Index for layers used within
231 Yocto Project.</para>
232
233 <para>For introductory information on layers, see the
234 "<ulink url='&YOCTO_DOCS_GS_URL;#the-yocto-project-layer-model'>The Yocto Project Layer Model</ulink>"
235 section in the Getting Started With Yocto Project Manual.
236 For more detailed information on layers, see the
237 "<ulink url='&YOCTO_DOCS_DEV_URL;#understanding-and-creating-layers'>Understanding and Creating Layers</ulink>"
238 section in the Yocto Project Development Tasks Manual.
206 For a discussion specifically on BSP Layers, see the 239 For a discussion specifically on BSP Layers, see the
207 "<ulink url='&YOCTO_DOCS_BSP_URL;#bsp-layers'>BSP Layers</ulink>" 240 "<ulink url='&YOCTO_DOCS_BSP_URL;#bsp-layers'>BSP Layers</ulink>"
208 section in the Yocto Project Board Support Packages (BSP) 241 section in the Yocto Project Board Support Packages (BSP)
@@ -210,22 +243,47 @@
210 </para></listitem> 243 </para></listitem>
211 <listitem><para id='metadata'> 244 <listitem><para id='metadata'>
212 <emphasis>Metadata:</emphasis> 245 <emphasis>Metadata:</emphasis>
213 The files that BitBake parses when building an image. 246 A key element of the Yocto Project is the Metadata that
214 In general, Metadata includes recipes, classes, and 247 is used to construct a Linux distribution and is contained
215 configuration files. 248 in the files that the
216 In the context of the kernel ("kernel Metadata"), the 249 <link linkend='build-system-term'>OpenEmbedded build system</link>
250 parses when building an image.
251 In general, Metadata includes recipes, configuration
252 files, and other information that refers to the build
253 instructions themselves, as well as the data used to
254 control what things get built and the effects of the
255 build.
256 Metadata also includes commands and data used to
257 indicate what versions of software are used, from
258 where they are obtained, and changes or additions to the
259 software itself (patches or auxiliary files) that
260 are used to fix bugs or customize the software for use
261 in a particular situation.
262 OpenEmbedded Core is an important set of validated
263 metadata.</para>
264
265 <para>In the context of the kernel ("kernel Metadata"), the
217 term refers to the kernel config fragments and features 266 term refers to the kernel config fragments and features
218 contained in the 267 contained in the
219 <ulink url='&YOCTO_GIT_URL;/cgit/cgit.cgi/yocto-kernel-cache'><filename>yocto-kernel-cache</filename></ulink> 268 <ulink url='&YOCTO_GIT_URL;/cgit/cgit.cgi/yocto-kernel-cache'><filename>yocto-kernel-cache</filename></ulink>
220 Git repository. 269 Git repository.
221 </para></listitem> 270 </para></listitem>
222 <listitem><para id='oe-core'> 271 <listitem><para id='oe-core'>
223 <emphasis>OE-Core:</emphasis> 272 <emphasis>OpenEmbedded Core (OE-Core):</emphasis>
224 A core set of Metadata originating with OpenEmbedded (OE) 273 OE-Core is metadata comprised of foundational recipes,
225 that is shared between OE and the Yocto Project. 274 classes, and associated files that are meant to be
226 This Metadata is found in the <filename>meta</filename> 275 common among many different OpenEmbedded-derived systems,
227 directory of the 276 including the Yocto Project.
228 <link linkend='source-directory'>Source Directory</link>. 277 OE-Core is a curated subset of an original repository
278 developed by the OpenEmbedded community that has been
279 pared down into a smaller, core set of continuously
280 validated recipes.
281 The result is a tightly controlled and an quality-assured
282 core set of recipes.</para>
283
284 <para>You can see the Metadata in the
285 <filename>meta</filename> directory of the Yocto Project
286 <ulink url='http://git.yoctoproject.org/cgit/cgit.cgi'>Source Repositories</ulink>.
229 </para></listitem> 287 </para></listitem>
230 <listitem><para id='build-system-term'> 288 <listitem><para id='build-system-term'>
231 <emphasis>OpenEmbedded Build System:</emphasis> 289 <emphasis>OpenEmbedded Build System:</emphasis>
@@ -285,37 +343,37 @@
285 </para></listitem> 343 </para></listitem>
286 <listitem><para id='poky'> 344 <listitem><para id='poky'>
287 <emphasis>Poky:</emphasis> 345 <emphasis>Poky:</emphasis>
288 The term "poky", which is pronounced 346 Poky, which is pronounced <emphasis>Pock</emphasis>-ee,
289 <emphasis>Pock</emphasis>-ee, can mean several things: 347 is a reference embedded distribution and a reference
348 test configuration.
349 Poky provides the following:
290 <itemizedlist> 350 <itemizedlist>
291 <listitem><para> 351 <listitem><para>
292 In its most general sense, poky is an open-source 352 A base-level functional distro used to illustrate
293 project that was initially developed by OpenedHand. 353 how to customize a distribution.
294 OpenedHand developed poky off of the existing
295 OpenEmbedded build system to create a commercially
296 supportable build system for embedded Linux.
297 After Intel Corporation acquired OpenedHand, the
298 poky project became the basis for the Yocto Project's
299 build system.
300 </para></listitem> 354 </para></listitem>
301 <listitem><para> 355 <listitem><para>
302 Within the Yocto Project 356 A means by which to test the Yocto Project
303 <ulink url='&YOCTO_GIT_URL;'>Source Repositories</ulink>, 357 components (i.e. Poky is used to validate
304 "poky" exists as a separate Git 358 the Yocto Project).
305 repository from which you can clone to yield a local
306 Git repository that is a copy on your host system.
307 Thus, "poky" can refer to the upstream or
308 local copy of the files used for development within
309 the Yocto Project.
310 </para></listitem> 359 </para></listitem>
311 <listitem><para> 360 <listitem><para>
312 Finally, "poky" can refer to the default 361 A vehicle through which you can download
313 <link linkend='var-DISTRO'><filename>DISTRO</filename></link> 362 the Yocto Project.
314 (i.e. distribution) created when you use the Yocto
315 Project in conjunction with the
316 <filename>poky</filename> repository to build an image.
317 </para></listitem> 363 </para></listitem>
318 </itemizedlist> 364 </itemizedlist>
365 Poky is not a product level distro.
366 Rather, it is a good starting point for customization.
367 <note>
368 Poky began an open-source
369 project initially developed by OpenedHand.
370 OpenedHand developed Poky from the existing
371 OpenEmbedded build system to create a commercially
372 supportable build system for embedded Linux.
373 After Intel Corporation acquired OpenedHand, the
374 poky project became the basis for the Yocto Project's
375 build system.
376 </note>
319 </para></listitem> 377 </para></listitem>
320 <listitem><para> 378 <listitem><para>
321 <emphasis>Recipe:</emphasis> 379 <emphasis>Recipe:</emphasis>