From 402383637b9a20614bc56221f86ff5b9013519d2 Mon Sep 17 00:00:00 2001 From: Scott Rifenbark Date: Fri, 13 Jul 2012 11:28:34 -0700 Subject: documentation/poky-ref-manual: Fixed various references to YP I did a scrub for "Yocto Project" and found some that could be changed. (From yocto-docs rev: 985062b6a9320e8a3ca3d3dafb6516db4fbc5bd5) Signed-off-by: Scott Rifenbark Signed-off-by: Richard Purdie --- documentation/poky-ref-manual/development.xml | 3 +-- documentation/poky-ref-manual/introduction.xml | 21 ++++++++++----------- documentation/poky-ref-manual/ref-bitbake.xml | 4 ++-- documentation/poky-ref-manual/ref-structure.xml | 17 +++++++++-------- documentation/poky-ref-manual/resources.xml | 2 +- .../poky-ref-manual/technical-details.xml | 22 +++++++++++----------- documentation/poky-ref-manual/usingpoky.xml | 9 +++++---- 7 files changed, 39 insertions(+), 39 deletions(-) (limited to 'documentation') diff --git a/documentation/poky-ref-manual/development.xml b/documentation/poky-ref-manual/development.xml index 9628fcbd15..f7e67a6545 100644 --- a/documentation/poky-ref-manual/development.xml +++ b/documentation/poky-ref-manual/development.xml @@ -45,8 +45,7 @@ - This command opens a terminal with a shell prompt within the Yocto Project - environment. + This command opens a terminal with a shell prompt within the OpenEmbedded build environment. The following occurs: The PATH variable includes the diff --git a/documentation/poky-ref-manual/introduction.xml b/documentation/poky-ref-manual/introduction.xml index 249b9a18fd..ac28eaef4e 100644 --- a/documentation/poky-ref-manual/introduction.xml +++ b/documentation/poky-ref-manual/introduction.xml @@ -51,13 +51,11 @@ the Yocto Project. Reference: Directory Structure: - This appendix describes the directory structure of the - Yocto Project files, referred to as the - source directory. - The source directory represents the local file structure created - as a result from either cloning the upstream - Poky Git repository or unpacking a - released Yocto Project tarball on your host development system. + This appendix describes the + source directory created + either by unpacking a released Yocto Project tarball on your host development system, + or by cloning the upstream + Poky Git repository. Reference: BitBake: @@ -76,7 +74,8 @@ features during the build process using the OpenEmbedded build system. Reference: Variables Glossary: - This appendix presents most Yocto Project variables. + This appendix presents most variables used by the OpenEmbedded build system, which + using BitBake. Entries describe the function of the variable and how to apply them. @@ -128,9 +127,9 @@
Development Checkouts - Development using the Yocto Project requires a local copy of the Yocto Project files - referred to as the source directory. - You can set source directory up by downloading a Yocto Project release tarball and unpacking it, + Development using the Yocto Project requires a local + source directory. + You can set up the source directory by downloading a Yocto Project release tarball and unpacking it, or by cloning a copy of the upstream Poky Git repository. For information on both these methods, see the diff --git a/documentation/poky-ref-manual/ref-bitbake.xml b/documentation/poky-ref-manual/ref-bitbake.xml index 81a8934e6a..8e5d4158b2 100644 --- a/documentation/poky-ref-manual/ref-bitbake.xml +++ b/documentation/poky-ref-manual/ref-bitbake.xml @@ -7,8 +7,8 @@ Reference: BitBake - BitBake is a program written in Python that interprets the metadata used by the Yocto Project. - The OpenEmbedded build system uses BitBake. + BitBake is a program written in Python that interprets the metadata used by the OpenEmbedded + build system. At some point, developers wonder what actually happens when you enter: $ bitbake core-image-sato diff --git a/documentation/poky-ref-manual/ref-structure.xml b/documentation/poky-ref-manual/ref-structure.xml index 3e6a6a2b6a..9d3c358296 100644 --- a/documentation/poky-ref-manual/ref-structure.xml +++ b/documentation/poky-ref-manual/ref-structure.xml @@ -7,10 +7,10 @@ Reference: Directory Structure - The Yocto Project consists of several components. + The source directory consists of several components. Understanding them and knowing where they are located is key to using the Yocto Project well. - This appendix describes the source directory - and gives information about the various files and directories. + This appendix describes the source directory and gives information about the various + files and directories. @@ -26,7 +26,8 @@ <filename>bitbake/</filename> - The Yocto Project includes a copy of BitBake for ease of use. + The source directory + includes a copy of BitBake for ease of use. The copy usually matches the current stable BitBake release from the BitBake project. BitBake, a metadata interpreter, reads the Yocto Project metadata and runs the tasks defined by that data. @@ -59,7 +60,7 @@ 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. + the OpenEmbedded build environment setup script oe-init-build-env. @@ -90,7 +91,7 @@ <filename>meta/</filename> - This directory contains the Yocto Project core metadata. + This directory contains the OpenEmbedded Core metadata. The directory holds machine definitions, the Yocto Project distribution, and the packages that make up a given system. @@ -101,7 +102,7 @@ This directory contains recipes for applications and demos that are not part of the - Yocto Project core. + OpenEmbedded core.
@@ -142,7 +143,7 @@ <filename>oe-init-build-env</filename> - This script sets up the Yocto Project build environment. + This script sets up the OpenEmbedded build environment. Running this script with the source command in a shell makes changes to PATH and sets other core BitBake variables based on the current working directory. diff --git a/documentation/poky-ref-manual/resources.xml b/documentation/poky-ref-manual/resources.xml index 9fe5a65a6d..9e1ae69a0a 100644 --- a/documentation/poky-ref-manual/resources.xml +++ b/documentation/poky-ref-manual/resources.xml @@ -82,7 +82,7 @@ Yocto Project. Poky derives from and contributes back to the OpenEmbedded project. - BitBake: The tool used to process Yocto Project metadata. + BitBake: The tool used to process metadata. BitBake User Manual: A comprehensive guide to the BitBake tool. diff --git a/documentation/poky-ref-manual/technical-details.xml b/documentation/poky-ref-manual/technical-details.xml index 2c6f7c2b98..717015be5c 100644 --- a/documentation/poky-ref-manual/technical-details.xml +++ b/documentation/poky-ref-manual/technical-details.xml @@ -15,7 +15,7 @@ The BitBake task executor together with various types of configuration files form the - Yocto Project core. + OpenEmbedded Core. This section overviews the BitBake task executor and the configuration files by describing what they are used for and how they interact. @@ -55,7 +55,7 @@ BitBake - BitBake is the tool at the heart of the Yocto Project and is responsible + BitBake is the tool at the heart of the OpenEmbedded build system and is responsible for parsing the metadata, generating a list of tasks from it, and then executing those tasks. To see a list of the options BitBake supports, use the following help command: @@ -115,8 +115,8 @@ The term "package" can also be used to describe recipes. - However, since the same word is used for the packaged output from the Yocto - Project (i.e. .ipk or .deb files), + However, since the same word is used for the packaged output from the OpenEmbedded + build system (i.e. .ipk or .deb files), this document avoids using the term "package" when referring to recipes. @@ -143,7 +143,7 @@ These files fall into several areas that define machine configuration options, distribution configuration options, compiler tuning options, general common configuration options and user configuration options (local.conf, which is found - in the Yocto Project files build directory). + in the build directory). @@ -171,7 +171,7 @@ The Yocto Project implements shared state code that supports incremental builds. The implementation of the shared state code answers the following questions that - were fundamental roadblocks within the Yocto Project incremental build support system: + were fundamental roadblocks within the OpenEmbedded incremental build support system: What pieces of the system have changed and what pieces have not changed? How are changed pieces of software removed and replaced? @@ -485,7 +485,7 @@ Tips and Tricks - The code in the Yocto Project that supports incremental builds is not + The code in the build system that supports incremental builds is not simple code. This section presents some tips and tricks that help you work around issues related to shared state code. @@ -691,10 +691,10 @@ Tracking License Changes - The license of an upstream project might change in the future. In order to prevent these changes - going unnoticed, the Yocto Project provides a + The license of an upstream project might change in the future. + In order to prevent these changes going unnoticed, the LIC_FILES_CHKSUM - variable to track changes to the license text. The checksums are validated at the end of the + variable tracks changes to the license text. The checksums are validated at the end of the configure step, and if the checksums do not match, the build will fail. @@ -714,7 +714,7 @@ - The Yocto Project uses the + The build system uses the S variable as the default directory used when searching files listed in LIC_FILES_CHKSUM. diff --git a/documentation/poky-ref-manual/usingpoky.xml b/documentation/poky-ref-manual/usingpoky.xml index 1dde656140..121650cd54 100644 --- a/documentation/poky-ref-manual/usingpoky.xml +++ b/documentation/poky-ref-manual/usingpoky.xml @@ -27,7 +27,7 @@ Build Overview - The first thing you need to do is set up the Yocto Project build environment by sourcing + The first thing you need to do is set up the OpenEmbedded build environment by sourcing the environment setup script as follows: $ source oe-init-build-env [build_dir] @@ -35,8 +35,9 @@ - The build_dir is optional and specifies the directory Yocto Project - uses for the build - the build directory. + The build_dir is optional and specifies the directory the + OpenEmbedded build system uses for the build - + the build directory. If you do not specify a build directory it defaults to build in your current working directory. A common practice is to use a different build directory for different targets. @@ -47,7 +48,7 @@ - Once the Yocto Project build environment is set up, you can build a target using: + Once the build environment is set up, you can build a target using: $ bitbake <target> -- cgit v1.2.3-54-g00ecf