From c6a7a82a9c11177fc564aa6b29b1473a781e52be Mon Sep 17 00:00:00 2001 From: Scott Rifenbark Date: Fri, 22 Jul 2011 09:44:41 -0700 Subject: documentation/dev-manual/dev-manual-newbie.xml: new section on terms added created a new section on YP terms that might be useful to the new user. (From yocto-docs rev: ab81b6468c39b5c015c7c0654ddf8c4cfd8bd245) Signed-off-by: Scott Rifenbark Signed-off-by: Richard Purdie --- documentation/dev-manual/dev-manual-newbie.xml | 103 ++++++++++++++----------- 1 file changed, 57 insertions(+), 46 deletions(-) (limited to 'documentation/dev-manual/dev-manual-newbie.xml') diff --git a/documentation/dev-manual/dev-manual-newbie.xml b/documentation/dev-manual/dev-manual-newbie.xml index 57079fa0c5..fbd12946e1 100644 --- a/documentation/dev-manual/dev-manual-newbie.xml +++ b/documentation/dev-manual/dev-manual-newbie.xml @@ -119,6 +119,63 @@ +
+ Yocto Project Terms + + + Following is a list of terms and definitions users new to the Yocto Project development + environment might find helpful. + Some terms are universal but are included here just in case: + + Image - An image is a collection of recipes created with + Bitbake (baked). + Images run on specific hardware and use cases. + Recipe - A set of instructions for building packages. + A recipe describes where you get source code and which patches to apply. + Recipes describe dependencies for libraries or for other recipes and they + also contain configuration and compilation options. + Recipes also let you ‘install’ customizations. + Recipes contain the logical unit of execution, the software/images to build and + use the .bb file extension. + BitBake - The task executor and scheduler used by Yocto Project + to build images. + For more information on BitBake, see the + BitBake documentation. + Package - A collection of ‘baked’ recipes. + You ‘bake’ something by running it through Bitbake. + Layer - A logical collection of recipes representing the core, + a BSP, or an application stack. + Metadata - Information for a build that is generally + architecture-independent. + This information includes Task definitions in recipes, classes, and configuration + information. + Configuration File: Configuration information in the + .conf files provides global definitions of variables. + The build/conf/local.conf configuration file defines local user-defined variables. + The distro/poky.conf configuration file defines Yocto ‘distro’ configuration + variables. + The machine/beagleboard.conf configuration file defines machine-specific variables + (i.e. Texas Instruments ARM Cortex-A8 development board in this example. + Configuration files end with a .conf filename extension. + Classes - Files that encapsulate and inherit logic. + Class files end with the .bbclass filename extension. + Append Files - Files that append build information to + a recipe file. + Information in append files override the information in the similarly-named recipe file. + Append files use the .bbappend filename suffix. + Tasks - Arbitrary groups of software used to contain Recipes. + You simply use Tasks to hold recipes that when build usually accomplished a single task. + For example, a task could contain the recipes for a company’s proprietary or value-add software. + Or the task could contain the recipes that enable graphics. + A task is really just another recipe. + Because task files are recipes, they end with the .bb filename + extension. + Common OE-Core - A core set of metadata originating + with OpenEmbedded (OE) that is shared between OE and the Yocto Project. + + +
+
Licensing @@ -286,52 +343,6 @@ Again, if you are familiar with this type of development environment you might want to just skip the section. - - Following are the definitions for some terms used in the Yocto Project. - [WRITER NOTE: I need to move this list of definitions somewhere useful.] - - Image - An image is a collection of recipes created with - Bitbake (baked). Images run on specific hardware and use cases. - Recipe - A set of instructions for building packages. - A recipe describes where you get the source and which patches to apply. - Recipes describe dependencies for libraries or for other recipes and they - also contain configuration and compilation options. - Recipes also let you ‘install’ customizations. - Recipes contain the logical unit of execution, the software/images to build and - use the .bb file extension. - BitBake - The task executor and scheduler used by Yocto Project - to build images. - For more information on BitBake, see the - BitBake documentation. - Package - A collection of ‘baked’ recipes. - You ‘bake’ something by running it through Bitbake. - Layer - A logical collection of recipes representing the core, - a BSP, or an application stack. - Metadata - Information for a build that is generally - architecture-independent. - This information includes Task definitions in recipes, classes, and configuration - information. - Configuration File: Configuration information in the - .conf files provides global definition of variables. - The build/conf/local.conf configuration file defines local user-defined variables. - The distro/poky.conf configuration file defines Yocto ‘distro’ configuration - variables. - The machine/beagleboard.conf configuration file defines machine-specific variables. - Configuration files end with a .conf filename extension. - Classes - Files that encapsulate and inherit logic. - Class files end with the .bbclass filename extension. - Tasks - Arbitrary groups of software used to contain Recipes. - You simply use Tasks to hold recipes that when build usually accomplished a single task. - For example, a task could contain the recipes for a company’s proprietary or value-add software. - Or the task could contain the recipes that enable graphics. - A task is really just another recipe. - Because task files are recipes, they end with the .bb filename - extension. - Common OE-Core - A core set of metadata originating - with OpenEmbedded (OE) that is shared between OE and the Yocto Project. - - - A master Git repository exists that contains the project. Usually a key individual is responsible for this repository. -- cgit v1.2.3-54-g00ecf