From c0859cd2b641a6481759a78aec2403a96cd6564a Mon Sep 17 00:00:00 2001 From: Scott Rifenbark Date: Wed, 22 Feb 2012 13:51:35 -0600 Subject: documentation/dev-manual: Fixed YP Build Directory Term Throughout the manual there is a specific term to refer to the YP build directory: "Yocto Project Build Directory." This term was being loosely referred to and was not consisten in linking to the actual term definition in the Terms chapter. All this is fixed. (From yocto-docs rev: 9229a512a62780a0e52089cc865d0903cbe7c92e) Signed-off-by: Scott Rifenbark Signed-off-by: Richard Purdie --- documentation/dev-manual/dev-manual-common-tasks.xml | 17 +++++++++-------- documentation/dev-manual/dev-manual-model.xml | 3 ++- documentation/dev-manual/dev-manual-newbie.xml | 8 +++++--- documentation/dev-manual/dev-manual-start.xml | 4 +++- 4 files changed, 19 insertions(+), 13 deletions(-) (limited to 'documentation/dev-manual') diff --git a/documentation/dev-manual/dev-manual-common-tasks.xml b/documentation/dev-manual/dev-manual-common-tasks.xml index ec9b2183e9..f631f98e18 100644 --- a/documentation/dev-manual/dev-manual-common-tasks.xml +++ b/documentation/dev-manual/dev-manual-common-tasks.xml @@ -771,7 +771,7 @@ so that there are some definite steps on how to do this. I need more detail her During a build, the unpacked temporary source code used by recipes - to build packages is available in the Yocto Project build directory as + to build packages is available in the Yocto Project Build Directory as defined by the S variable. Below is the default value for the S variable as defined in the @@ -802,7 +802,7 @@ so that there are some definite steps on how to do this. I need more detail her Let's look at an example without variables. Assuming a Yocto Project Files top-level directory named poky - and a default Yocto Project build directory of poky/build, + and a default Yocto Project Build Directory of poky/build, the following is the work directory for the acl package: ~/poky/build/tmp/work/i586-poky-linux/acl-2.2.51-r3 @@ -815,7 +815,7 @@ so that there are some definite steps on how to do this. I need more detail her ${TMPDIR}/work/${MACHINE}-poky-${TARGET_OS}/${PN}-${PV}-${PR} Again, assuming a Yocto Project Files top-level directory named poky - and a default Yocto Project build directory of poky/build, the + and a default Yocto Project Build Directory of poky/build, the following is the work directory for the acl package that is being built for a MIPS-based device: @@ -861,7 +861,7 @@ so that there are some definite steps on how to do this. I need more detail her Find the Source Code: The temporary source code used by the Yocto Project build system is kept in the - Yocto Project build directory. + Yocto Project Build Directory. See the "Finding the Temporary Source Code" section to learn how to locate the directory that has the temporary source code for a @@ -957,7 +957,7 @@ so that there are some definite steps on how to do this. I need more detail her Find the Source Code: The temporary source code used by the Yocto Project build system is kept in the - Yocto Project build directory. + Yocto Project Build Directory. See the "Finding the Temporary Source Code" section to learn how to locate the directory that has the temporary source code for a @@ -1141,7 +1141,8 @@ so that there are some definite steps on how to do this. I need more detail her After you have set up the recipes, you need to define the actual combination of multiple libraries you want to build. You accomplish this through your local.conf - configuration file in the Yocto Project build directory. + configuration file in the + Yocto Project Build Directory. An example configuration would be as follows: MACHINE = "qemux86-64" @@ -1185,8 +1186,8 @@ so that there are some definite steps on how to do this. I need more detail her A unique architecture is defined for the Multilib packages, along with creating a unique deploy folder under - tmp/deploy/rpm in the Yocto - Project build directory. + tmp/deploy/rpm in the + Yocto Project Build Directory. For example, consider lib32 in a qemux86-64 image. The possible architectures in the system are "all", "qemux86_64", diff --git a/documentation/dev-manual/dev-manual-model.xml b/documentation/dev-manual/dev-manual-model.xml index e460d8d696..9be8673244 100644 --- a/documentation/dev-manual/dev-manual-model.xml +++ b/documentation/dev-manual/dev-manual-model.xml @@ -427,7 +427,8 @@ When saved, changes using menuconfig update the kernel's .config. Try to resist the temptation of directly editing the .config - file found in the Yocto Project build directory at + file found in the + Yocto Project Build Directory at tmp/sysroots/<machine-name>/kernel. Doing so, can produce unexpected results when the Yocto Project build system regenerates the configuration file. diff --git a/documentation/dev-manual/dev-manual-newbie.xml b/documentation/dev-manual/dev-manual-newbie.xml index f9980fc555..e9077c4efc 100644 --- a/documentation/dev-manual/dev-manual-newbie.xml +++ b/documentation/dev-manual/dev-manual-newbie.xml @@ -147,8 +147,9 @@ Configuration File: Configuration information in various .conf files provides global definitions of variables. - The conf/local.conf configuration file in the Yocto Project - build directory contains user-defined variables that affect each build. + The conf/local.conf configuration file in the + Yocto Project Build Directory + contains user-defined variables that affect each build. The meta-yocto/conf/distro/poky.conf configuration file defines Yocto ‘distro’ configuration variables used only when building with this policy. @@ -327,7 +328,8 @@ You can find this list in the Yocto Project files directory at meta/files/common-licenses. Once the build completes, the list of all licenses found and used during that build are - kept in the Yocto Project build directory at + kept in the + Yocto Project Build Directory at tmp/deploy/images/licenses. diff --git a/documentation/dev-manual/dev-manual-start.xml b/documentation/dev-manual/dev-manual-start.xml index e429065b7a..6bedbc273a 100644 --- a/documentation/dev-manual/dev-manual-start.xml +++ b/documentation/dev-manual/dev-manual-start.xml @@ -264,7 +264,9 @@ Initialize the build environment by sourcing a build environment script. Optionally ensure the /conf/local.conf configuration file, - which is found in the Yocto Project build directory, is set up how you want it. + which is found in the + Yocto Project Build Directory, + is set up how you want it. This file defines many aspects of the build environment including the target machine architecture through the MACHINE variable, -- cgit v1.2.3-54-g00ecf