From b8b87dd690ef2f828c21937ec82c2d1dab405734 Mon Sep 17 00:00:00 2001 From: Scott Rifenbark Date: Tue, 13 Jun 2017 16:50:32 -0700 Subject: ref-manual: Fixed links in the "Yocto Project Terms" section. Fixes [YOCTO #11630] Moving the "Yocto Project Terms" section from the dev-manual to the ref-manual caused many links local to that section to be incorrect. I scrubbed the section and fixed all the links. (From yocto-docs rev: 4b795159aa80184f26ff1181a564516840c373b2) Signed-off-by: Scott Rifenbark Signed-off-by: Richard Purdie --- documentation/ref-manual/introduction.xml | 318 +++++++++++++++++------------- 1 file changed, 180 insertions(+), 138 deletions(-) (limited to 'documentation/ref-manual/introduction.xml') diff --git a/documentation/ref-manual/introduction.xml b/documentation/ref-manual/introduction.xml index 58ee073868..deaac033a3 100644 --- a/documentation/ref-manual/introduction.xml +++ b/documentation/ref-manual/introduction.xml @@ -43,110 +43,123 @@ Yocto Project Terms - Following is a list of terms and definitions users new to the Yocto Project development - environment might find helpful. - While some of these terms are universal, the list includes them just in case: + Following is a list of terms and definitions users new to the Yocto + Project development environment might find helpful. + While some of these terms are universal, the list includes them + just in case: - Append Files: Files that append build information to - a recipe file. - Append files are known as BitBake append files and .bbappend files. - The OpenEmbedded build system expects every append file to have a corresponding - recipe (.bb) file. + + Append Files: + Files that append build information to a recipe file. + Append files are known as BitBake append files and + .bbappend files. + The OpenEmbedded build system expects every append file to have + a corresponding recipe (.bb) file. Furthermore, the append file and corresponding recipe file must use the same root filename. - The filenames can differ only in the file type suffix used (e.g. - formfactor_0.0.bb and formfactor_0.0.bbappend). - + The filenames can differ only in the file type suffix used + (e.g. + formfactor_0.0.bb and + formfactor_0.0.bbappend). + Information in append files extends or overrides the information in the similarly-named recipe file. For an example of an append file in use, see the "Using .bbappend Files" section in the Yocto Project Development Manual. - Append files can also use wildcard patterns in their version numbers - so they can be applied to more than one version of the underlying recipe file. + Append files can also use wildcard patterns in their + version numbers so they can be applied to more than one + version of the underlying recipe file. - BitBake: + + BitBake: The task executor and scheduler used by the OpenEmbedded build system to build images. For more information on BitBake, see the BitBake User Manual. - Build Directory: + + Build Directory: This term refers to the area used by the OpenEmbedded build system for builds. The area is created when you source the setup environment script that is found in the Source Directory - (i.e. &OE_INIT_FILE; + (i.e. &OE_INIT_FILE; or - oe-init-build-env-memres). - The TOPDIR + oe-init-build-env-memres). + The + TOPDIR variable points to the Build Directory. - - You have a lot of flexibility when creating the Build - Directory. - Following are some examples that show how to create the - directory. - The examples assume your - Source Directory is - named poky: - - Create the Build Directory inside your - Source Directory and let the name of the Build - Directory default to build: - + You have a lot of flexibility when creating the Build + Directory. + Following are some examples that show how to create the + directory. + The examples assume your + Source Directory is + named poky: + + Create the Build Directory inside your + Source Directory and let the name of the Build + Directory default to build: + $ cd $HOME/poky $ source &OE_INIT_FILE; - - Create the Build Directory inside your - home directory and specifically name it - test-builds: - + + + Create the Build Directory inside your + home directory and specifically name it + test-builds: + $ cd $HOME $ source poky/&OE_INIT_FILE; test-builds - - - Provide a directory path and - specifically name the Build Directory. - Any intermediate folders in the pathname must - exist. - This next example creates a Build Directory named - YP-&POKYVERSION; - in your home directory within the existing - directory mybuilds: - + + + + Provide a directory path and specifically name the + Build Directory. + Any intermediate folders in the pathname must exist. + This next example creates a Build Directory named + YP-&POKYVERSION; + in your home directory within the existing + directory mybuilds: + $cd $HOME $ source $HOME/poky/&OE_INIT_FILE; $HOME/mybuilds/YP-&POKYVERSION; - - - - By default, the Build Directory contains - TMPDIR, - which is a temporary directory the build system uses for - its work. - TMPDIR cannot be under NFS. - Thus, by default, the Build Directory cannot be under NFS. - However, if you need the Build Directory to be under NFS, - you can set this up by setting TMPDIR - in your local.conf file - to use a local drive. - Doing so effectively separates TMPDIR - from TOPDIR, which is the Build - Directory. - - - Classes: Files that provide for logic encapsulation - and inheritance so that commonly used patterns can be defined once and then easily used - in multiple recipes. + + + + + By default, the Build Directory contains + TMPDIR, + which is a temporary directory the build system uses for + its work. + TMPDIR cannot be under NFS. + Thus, by default, the Build Directory cannot be under NFS. + However, if you need the Build Directory to be under NFS, + you can set this up by setting TMPDIR + in your local.conf file + to use a local drive. + Doing so effectively separates TMPDIR + from TOPDIR, which is the Build + Directory. + + + + Classes: + Files that provide for logic encapsulation and inheritance so + that commonly used patterns can be defined once and then + easily used in multiple recipes. For reference information on the Yocto Project classes, see the - "Classes" chapter of the - Yocto Project Reference Manual. - Class files end with the .bbclass filename extension. + "Classes" chapter. + Class files end with the .bbclass + filename extension. - Configuration File: + + Configuration File: Configuration information in various .conf files provides global definitions of variables. The conf/local.conf configuration file in @@ -169,52 +182,58 @@ Cross-Development Toolchain: - In general, a cross-development toolchain is a collection of - software development tools and utilities that run on one - architecture and allow you to develop software for a - different, or targeted, architecture. - These toolchains contain cross-compilers, linkers, and - debuggers that are specific to the target architecture. - + In general, a cross-development toolchain is a collection of + software development tools and utilities that run on one + architecture and allow you to develop software for a + different, or targeted, architecture. + These toolchains contain cross-compilers, linkers, and + debuggers that are specific to the target architecture. The Yocto Project supports two different cross-development - toolchains: - - A toolchain only used by and within - BitBake when building an image for a target - architecture. - A relocatable toolchain used outside of - BitBake by developers when developing applications - that will run on a targeted device. - - - + toolchains: + + + A toolchain only used by and within + BitBake when building an image for a target + architecture. + + A relocatable toolchain used outside of + BitBake by developers when developing applications + that will run on a targeted device. + + - - Creation of these toolchains is simple and automated. - For information on toolchain concepts as they apply to the - Yocto Project, see the - "Cross-Development Toolchain Generation" - section in the Yocto Project Reference Manual. - You can also find more information on using the - relocatable toolchain in the - Yocto Project Software Development Kit (SDK) Developer's Guide. - - Image: + Creation of these toolchains is simple and automated. + For information on toolchain concepts as they apply to the + Yocto Project, see the + "Cross-Development Toolchain Generation" + section. + You can also find more information on using the + relocatable toolchain in the + Yocto Project Software Development Kit (SDK) Developer's Guide. + + + Image: An image is an artifact of the BitBake build process given a collection of recipes and related Metadata. Images are the binary output that run on specific hardware or QEMU and are used for specific use-cases. - For a list of the supported image types that the Yocto Project provides, see the - "Images" - chapter in the Yocto Project Reference Manual. - Layer: A collection of recipes representing the core, + For a list of the supported image types that the Yocto Project + provides, see the + "Images" + chapter. + + + Layer: + A collection of recipes representing the core, a BSP, or an application stack. For a discussion specifically on BSP Layers, see the "BSP Layers" section in the Yocto Project Board Support Packages (BSP) - Developer's Guide. - Metadata: + Developer's Guide. + + + Metadata: The files that BitBake parses when building an image. In general, Metadata includes recipes, classes, and configuration files. @@ -222,11 +241,16 @@ it refers to Metadata in the meta branches of the kernel source Git repositories. - OE-Core: A core set of Metadata originating - with OpenEmbedded (OE) that is shared between OE and the Yocto Project. - This Metadata is found in the meta directory of the - Source Directory. - OpenEmbedded Build System: + + OE-Core: + A core set of Metadata originating with OpenEmbedded (OE) + that is shared between OE and the Yocto Project. + This Metadata is found in the meta + directory of the + Source Directory. + + + OpenEmbedded Build System: The build system specific to the Yocto Project. The OpenEmbedded build system is based on another project known as "Poky", which uses @@ -243,26 +267,33 @@ Poky term. - Package: + + Package: In the context of the Yocto Project, this term refers to a recipe's packaged output produced by BitBake (i.e. a "baked recipe"). A package is generally the compiled binaries produced from the recipe's sources. You "bake" something by running it through BitBake. - It is worth noting that the term "package" can, in general, have subtle - meanings. For example, the packages referred to in the - "The Build Host Packages" section are - compiled binaries that, when installed, add functionality to your Linux + + It is worth noting that the term "package" can, + in general, have subtle meanings. + For example, the packages referred to in the + "The Build Host Packages" + section in the Yocto Project Quick Start are compiled binaries + that, when installed, add functionality to your Linux distribution. - Another point worth noting is that historically within the Yocto Project, - recipes were referred to as packages - thus, the existence of several BitBake - variables that are seemingly mis-named, - (e.g. PR, - PV, and - PE). - - Package Groups: + + Another point worth noting is that historically within + the Yocto Project, recipes were referred to as packages - thus, + the existence of several BitBake variables that are seemingly + mis-named, + (e.g. PR, + PV, and + PE). + + + Package Groups: Arbitrary groups of software Recipes. You use package groups to hold recipes that, when built, usually accomplish a single task. @@ -272,8 +303,10 @@ graphics. A package group is really just another recipe. Because package group files are recipes, they end with the - .bb filename extension. - Poky: + .bb filename extension. + + + Poky: The term "poky" can mean several things. In its most general sense, it is an open-source project that was initially developed by OpenedHand. @@ -283,6 +316,7 @@ After Intel Corporation acquired OpenedHand, the project poky became the basis for the Yocto Project's build system. + Within the Yocto Project source repositories, poky exists as a separate Git repository you can clone to yield a local copy on your @@ -290,13 +324,15 @@ Thus, "poky" can refer to the local copy of the Source Directory used for development within the Yocto Project. + Finally, "poky" can refer to the default - DISTRO + DISTRO (i.e. distribution) created when you use the Yocto Project in conjunction with the poky repository to build an image. - Recipe: + + Recipe: A set of instructions for building packages. A recipe describes where you get source code, which patches to apply, how to configure the source, how to compile it and so on. @@ -307,7 +343,8 @@ .bb file extension. - Source Directory: + + Source Directory: This term refers to the directory structure created as a result of creating a local copy of the poky Git repository git://git.yoctoproject.org/poky @@ -373,16 +410,21 @@ Task: A unit of execution for BitBake (e.g. - do_compile, - do_fetch, - do_patch, + do_compile, + do_fetch, + do_patch, and so forth). - Upstream: A reference to source code or repositories - that are not local to the development system but located in a master area that is controlled - by the maintainer of the source code. - For example, in order for a developer to work on a particular piece of code, they need to - first get a copy of it from an "upstream" source. + + Upstream: + A reference to source code or repositories + that are not local to the development system but located in a + master area that is controlled by the maintainer of the source + code. + For example, in order for a developer to work on a particular + piece of code, they need to first get a copy of it from an + "upstream" source. + -- cgit v1.2.3-54-g00ecf