diff options
Diffstat (limited to 'poky/documentation/ref-manual/ref-terms.rst')
| -rw-r--r-- | poky/documentation/ref-manual/ref-terms.rst | 71 |
1 files changed, 34 insertions, 37 deletions
diff --git a/poky/documentation/ref-manual/ref-terms.rst b/poky/documentation/ref-manual/ref-terms.rst index 556bc6b19..b4ceebc0b 100644 --- a/poky/documentation/ref-manual/ref-terms.rst +++ b/poky/documentation/ref-manual/ref-terms.rst @@ -10,7 +10,7 @@ universal, the list includes them just in case: .. glossary:: - Append Files + :term:`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 @@ -45,23 +45,23 @@ universal, the list includes them just in case: .. note:: - The use of the " % " character is limited in that it only works + The use of the "%" character is limited in that it only works directly in front of the .bbappend portion of the append file's name. You cannot use the wildcard character in any other location of the name. - BitBake + :term:`BitBake` The task executor and scheduler used by the OpenEmbedded build system to build images. For more information on BitBake, see the :doc:`BitBake User Manual <bitbake:index>`. - Board Support Package (BSP) + :term:`Board Support Package (BSP)` A group of drivers, definitions, and other components that provide support for a specific hardware configuration. For more information on BSPs, see the :ref:`bsp-guide/bsp-guide:Yocto Project Board Support Package Developer's Guide`. - Build Directory + :term:`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 @@ -101,27 +101,27 @@ universal, the list includes them just in case: .. note:: - By default, the Build Directory contains :term:`TMPDIR` , which is a - temporary directory the build system uses for its work. TMPDIR cannot + By default, the Build Directory contains :term:`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 + set this up by setting ``TMPDIR`` in your ``local.conf`` file to use a local + drive. Doing so effectively separates ``TMPDIR`` from :term:`TOPDIR`, which is the Build Directory. - Build Host + :term:`Build Host` The system used to build images in a Yocto Project Development environment. The build system is sometimes referred to as the development host. - Classes + :term:`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 ":ref:`ref-manual/ref-classes:Classes`" chapter. Class files end with the ``.bbclass`` filename extension. - Configuration File + :term:`Configuration File` Files that hold global definitions of variables, user-defined variables, and hardware configuration information. These files tell the OpenEmbedded build system what to build and what to put into the image to support a @@ -138,13 +138,13 @@ universal, the list includes them just in case: :file:`machine/beaglebone.conf` configuration file defines variables for the Texas Instruments ARM Cortex-A8 development board). - Container Layer + :term:`Container Layer` Layers that hold other layers. An example of a container layer is OpenEmbedded's `meta-openembedded <https://github.com/openembedded/meta-openembedded>`_ layer. The ``meta-openembedded`` layer contains many ``meta-*`` layers. - Cross-Development Toolchain + :term:`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 @@ -167,7 +167,7 @@ universal, the list includes them just in case: toolchain in the :ref:`sdk-manual/sdk-manual:Yocto Project Application Development and the Extensible Software Development Kit (eSDK)` manual. - Extensible Software Development Kit (eSDK) + :term:`Extensible Software Development Kit (eSDK)` A custom SDK for application developers. This eSDK allows developers to incorporate their library and programming changes back into the image to make their code available to other application developers. @@ -176,14 +176,14 @@ universal, the list includes them just in case: Project Application Development and the Extensible Software Development Kit (eSDK)` manual. - Image + :term:`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 ":ref:`ref-manual/ref-images:Images`" chapter. - Layer + :term:`Layer` A collection of related recipes. Layers allow you to consolidate related metadata to customize your build. Layers also isolate information used when building for multiple architectures. Layers are hierarchical in @@ -202,7 +202,7 @@ universal, the list includes them just in case: Layers`" section in the Yocto Project Board Support Packages (BSP) Developer's Guide. - Metadata + :term:`Metadata` A key element of the Yocto Project is the Metadata that is used to construct a Linux distribution and is contained in the files that the :term:`OpenEmbedded Build System` @@ -221,7 +221,7 @@ universal, the list includes them just in case: :yocto_git:`yocto-kernel-cache </cgit/cgit.cgi/yocto-kernel-cache>` Git repository. - OpenEmbedded-Core (OE-Core) + :term:`OpenEmbedded-Core (OE-Core)` OE-Core is metadata comprised of foundational recipes, classes, and associated files that are meant to be common among many different OpenEmbedded-derived systems, @@ -232,9 +232,9 @@ universal, the list includes them just in case: core set of recipes. You can see the Metadata in the ``meta`` directory of the Yocto - Project :yocto_git:`Source Repositories <>`. + Project :yocto_git:`Source Repositories </cgit/cgit.cgi/poky>`. - OpenEmbedded Build System + :term:`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 :term:`BitBake` as the task @@ -246,11 +246,9 @@ universal, the list includes them just in case: .. note:: - For some historical information about Poky, see the - Poky - term. + For some historical information about Poky, see the :term:`Poky` term. - Package + :term:`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 @@ -258,10 +256,9 @@ universal, the list includes them just in case: It is worth noting that the term "package" can, in general, have subtle meanings. For example, the packages referred to in the - "`Required Packages for the Build - Host <#required-packages-for-the-build-host>`__" section are compiled - binaries that, when installed, add functionality to your Linux - distribution. + ":ref:`ref-manual/ref-system-requirements:required packages for the build host`" + section 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 @@ -269,7 +266,7 @@ universal, the list includes them just in case: :term:`PR`, :term:`PV`, and :term:`PE`). - Package Groups + :term:`Package Groups` Arbitrary groups of software Recipes. You use package groups to hold recipes that, when built, usually accomplish a single task. For example, a package group could contain the recipes @@ -278,7 +275,7 @@ universal, the list includes them just in case: is really just another recipe. Because package group files are recipes, they end with the ``.bb`` filename extension. - Poky + :term:`Poky` Poky, which is pronounced *Pock*-ee, is a reference embedded distribution and a reference test configuration. Poky provides the following: @@ -303,7 +300,7 @@ universal, the list includes them just in case: OpenedHand, the poky project became the basis for the Yocto Project's build system. - Recipe + :term:`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. Recipes also @@ -311,13 +308,13 @@ universal, the list includes them just in case: represent the logical unit of execution, the software to build, the images to build, and use the ``.bb`` file extension. - Reference Kit + :term:`Reference Kit` A working example of a system, which includes a :term:`BSP<Board Support Package (BSP)>` as well as a :term:`build host<Build Host>` and other components, that can work on specific hardware. - Source Directory + :term:`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`` or expanding a @@ -376,20 +373,20 @@ universal, the list includes them just in case: ":ref:`overview-manual/overview-manual-development-environment:repositories, tags, and branches`" section in the Yocto Project Overview and Concepts Manual. - Task + :term:`Task` A unit of execution for BitBake (e.g. :ref:`ref-tasks-compile`, :ref:`ref-tasks-fetch`, :ref:`ref-tasks-patch`, and so forth). - Toaster + :term:`Toaster` A web interface to the Yocto Project's :term:`OpenEmbedded Build System`. The interface enables you to configure and run your builds. Information about builds is collected and stored in a database. For information on Toaster, see the :doc:`../toaster-manual/toaster-manual`. - Upstream + :term:`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 |