From 5966b44893a39847d3d590566dd488323a11ff73 Mon Sep 17 00:00:00 2001 From: Scott Rifenbark Date: Mon, 2 Jul 2012 14:34:39 -0700 Subject: documentation/poky-ref-manual: Yocto Project scrub I have changed as many "Yocto Project" terms as possible so that better reflect reality. (From yocto-docs rev: 5f729e53b0cb653c97621e4e6598d9295d60ada5) Signed-off-by: Scott Rifenbark Signed-off-by: Richard Purdie --- documentation/poky-ref-manual/ref-structure.xml | 61 ++++++++++++++----------- 1 file changed, 35 insertions(+), 26 deletions(-) (limited to 'documentation/poky-ref-manual/ref-structure.xml') diff --git a/documentation/poky-ref-manual/ref-structure.xml b/documentation/poky-ref-manual/ref-structure.xml index a5bfe5e876..c950671cb0 100644 --- a/documentation/poky-ref-manual/ref-structure.xml +++ b/documentation/poky-ref-manual/ref-structure.xml @@ -9,12 +9,12 @@ The Yocto Project consists of several components. Understanding them and knowing where they are located is key to using the Yocto Project well. - This appendix describes the Yocto Project file's directory structure and gives information about the various - files and directories. + This appendix describes the source directory + and gives information about the various files and directories. - For information on how to establish the Yocto Project files on your local development system, see the + For information on how to establish a local source directory on your development system, see the "Getting Set Up" section in the Yocto Project Development Manual. @@ -49,18 +49,20 @@ This directory contains user configuration files and the output - generated by the Yocto Project in its standard configuration where the source tree is - combined with the output. - The build directory is created initially when you source + generated by the OpenEmbedded build system in its standard configuration where + the source tree is combined with the output. + The build directory + is created initially when you source the Yocto Project environment setup script oe-init-build-env. It is also possible to place output and configuration - files in a directory separate from the Yocto Project files + files in a directory separate from the + source directory by providing a directory name when you source the setup script. - For information on separating output from the Yocto Project files, see oe-init-build-env. @@ -147,9 +149,11 @@ By default, running this script without a build directory argument creates the build directory. If you provide a build directory argument when you source - the script, you direct the Yocto Project to create a build directory of your choice. + the script, you direct OpenEmbedded build system to create a + build directory of your choice. For example, the following command creates a build directory named - mybuilds that is outside of the Yocto Project files: + mybuilds that is outside of the + sourc directory: $ source oe-init-build-env ~/mybuilds @@ -181,12 +185,12 @@ <filename>build/conf/local.conf</filename> - This file contains all the local user configuration of the Yocto Project. + This file contains all the local user configuration for your build environment. If there is no local.conf present, it is created from local.conf.sample. The local.conf file contains documentation on the various configuration options. - Any variable set here overrides any variable set elsewhere within the Yocto Project unless - that variable is hard-coded within the Yocto Project (e.g. by using '=' instead of '?='). + Any variable set here overrides any variable set elsewhere within the environment unless + that variable is hard-coded within a file (e.g. by using '=' instead of '?='). Some variables are hard-coded for various reasons but these variables are relatively rare. @@ -244,10 +248,11 @@ <filename>build/tmp/</filename> - This directory receives all the Yocto Project output. + This directory receives all the OpenEmbedded build system's output. BitBake creates this directory if it does not exist. - As a last resort, to clean the Yocto Project and start a build from scratch (other than downloads), - you can remove everything in this directory or get rid of the directory completely. + As a last resort, to clean up a build and start it from scratch (other than the downloads), + you can remove everything in the tmp directory or get rid of the + directory completely. If you do, you should also completely remove the build/sstate-cache directory as well. @@ -275,7 +280,7 @@ <filename>build/tmp/deploy/</filename> - This directory contains any 'end result' output from the Yocto Project build process. + This directory contains any 'end result' output from the OpenEmbedded build process. @@ -283,7 +288,8 @@ <filename>build/tmp/deploy/deb/</filename> - This directory receives any .deb packages produced by the Yocto Project. + This directory receives any .deb packages produced by + the build process. The packages are sorted into feeds for different architecture types. @@ -292,7 +298,8 @@ <filename>build/tmp/deploy/rpm/</filename> - This directory receives any .rpm packages produced by the Yocto Project. + This directory receives any .rpm packages produced by + the build process. The packages are sorted into feeds for different architecture types. @@ -319,7 +326,9 @@
<filename>build/tmp/deploy/ipk/</filename> - This directory receives .ipk packages produced by the Yocto Project. + + This directory receives .ipk packages produced by + the build process.
@@ -380,7 +389,8 @@ It is worth considering the structure of a typical work directory. - As an example, consider the linux-yocto kernel 3.0 on the machine qemux86 + As an example, consider the linux-yocto-kernel-3.0 + on the machine qemux86 built within the Yocto Project. For this package, a work directory of tmp/work/qemux86-poky-linux/linux-yocto-3.0+git1+<.....>, @@ -455,7 +465,7 @@ This directory contains all the machine configuration files. If you set MACHINE="qemux86", - Yocto Project looks for a qemux86.conf file in this + the OpenEmbedded build system looks for a qemux86.conf file in this directory. The include directory contains various data common to multiple machines. If you want to add support for a new machine to the Yocto Project, look in this directory. @@ -467,12 +477,11 @@ Any distribution-specific configuration is controlled from this directory. - The Yocto Project only contains the Yocto Project distribution so - defaultsetup.conf is the main file here. + For the Yocto Project, the defaultsetup.conf is the main file here. This directory includes the versions and the SRCDATE definitions for applications that are configured here. - An example of an alternative configuration is poky-bleeding.conf - although this file mainly inherits its configuration from the Yocto Project itself. + An example of an alternative configuration might be poky-bleeding.conf. + Although this file mainly inherits its configuration from Poky.
-- cgit v1.2.3-54-g00ecf