</para>
<para>
- 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:
<itemizedlist>
<listitem><para>The <filename>PATH</filename> variable includes the
the Yocto Project.</para></listitem>
<listitem><para><emphasis>
<link linkend='ref-structure'>Reference: Directory Structure</link>:</emphasis>
- This appendix describes the directory structure of the
- Yocto Project files, referred to as the
- <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>source directory</ulink>.
- The source directory represents the local file structure created
- as a result from either cloning the upstream
- <ulink url='&YOCTO_DOCS_DEV_URL;#poky'>Poky</ulink> Git repository or unpacking a
- released Yocto Project tarball on your host development system.
+ This appendix describes the
+ <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>source directory</ulink> created
+ either by unpacking a released Yocto Project tarball on your host development system,
+ or by cloning the upstream
+ <ulink url='&YOCTO_DOCS_DEV_URL;#poky'>Poky</ulink> Git repository.
</para></listitem>
<listitem><para><emphasis>
<link linkend='ref-bitbake'>Reference: BitBake</link>:</emphasis>
features during the build process using the OpenEmbedded build system.</para></listitem>
<listitem><para><emphasis>
<link linkend='ref-variables-glos'>Reference: Variables Glossary</link>:</emphasis>
- 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.
</para></listitem>
<listitem><para><emphasis>
<section id='intro-getit-dev'>
<title>Development Checkouts</title>
<para>
- Development using the Yocto Project requires a local copy of the Yocto Project files
-
referred to as the <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>source directory</ulink>.
- You can set source directory up by downloading a Yocto Project release tarball and unpacking it,
+ Development using the Yocto Project requires a local
+ <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>source directory</ulink>.
+ 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
<ulink url='&YOCTO_DOCS_DEV_URL;#poky'>Poky</ulink> Git repository.
For information on both these methods, see the
<title>Reference: BitBake</title>
<para>
- 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:
<literallayout class='monospaced'>
$ bitbake core-image-sato
<title>Reference: Directory Structure</title>
<para>
- The Yocto Project consists of several components.
+ The <ulink url='source-directory'>source directory</ulink> consists of several components.
Understanding them and knowing where they are located is key to using the Yocto Project well.
- This appendix describes the <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>source directory</ulink>
- and gives information about the various files and directories.
+ This appendix describes the source directory and gives information about the various
+ files and directories.
</para>
<para>
<title><filename>bitbake/</filename></title>
<para>
- The Yocto Project includes a copy of BitBake for ease of use.
+ The <ulink url='source-directory'>source directory</ulink>
+ 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.
the source tree is combined with the output.
The <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>build directory</ulink>
is created initially when you <filename>source</filename>
- the Yocto Project environment setup script <filename>oe-init-build-env</filename>.
+ the OpenEmbedded build environment setup script <filename>oe-init-build-env</filename>.
</para>
<para>
<title><filename>meta/</filename></title>
<para>
- 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.
</para>
<para>
This directory contains recipes for applications and demos that are not part of the
- Yocto Project core.
+ OpenEmbedded core.
</para>
</section>
<title><filename>oe-init-build-env</filename></title>
<para>
- This script sets up the Yocto Project build environment.
+ This script sets up the OpenEmbedded build environment.
Running this script with the <filename>source</filename> command in
a shell makes changes to <filename>PATH</filename> and sets other core BitBake variables based on the
current working directory.
Yocto Project.
Poky derives from and contributes back to the OpenEmbedded project.</para></listitem>
<listitem><para><emphasis><ulink url='http://developer.berlios.de/projects/bitbake/'>
- BitBake</ulink>:</emphasis> The tool used to process Yocto Project metadata.</para></listitem>
+ BitBake</ulink>:</emphasis> The tool used to process metadata.</para></listitem>
<listitem><para><emphasis><ulink url='http://bitbake.berlios.de/manual/'>
BitBake User Manual</ulink>:</emphasis> A comprehensive guide to the BitBake tool.
</para></listitem>
<para>
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.
</para>
<title>BitBake</title>
<para>
- 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:
<para>
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. <filename>.ipk</filename> or <filename>.deb</filename> files),
+ However, since the same word is used for the packaged output from the OpenEmbedded
+ build system (i.e. <filename>.ipk</filename> or <filename>.deb</filename> files),
this document avoids using the term "package" when referring to recipes.
</para>
</section>
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 (<filename>local.conf</filename>, which is found
- in the Yocto Project files build directory).
+ in the <ulink url='build-directory'>build directory</ulink>).
</para>
</section>
</section>
<para>
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:
<itemizedlist>
<listitem>What pieces of the system have changed and what pieces have not changed?</listitem>
<listitem>How are changed pieces of software removed and replaced?</listitem>
<title>Tips and Tricks</title>
<para>
- 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.
<title>Tracking License Changes</title>
<para>
- 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
<filename><link linkend='var-LIC_FILES_CHKSUM'>LIC_FILES_CHKSUM</link></filename>
- 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.
</para>
</para>
<para>
- The Yocto Project uses the
+ The build system uses the
<filename><link linkend='var-S'>S</link></filename> variable as the
default directory used when searching files listed in
<filename>LIC_FILES_CHKSUM</filename>.
<title>Build Overview</title>
<para>
- 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:
<literallayout class='monospaced'>
$ source oe-init-build-env [build_dir]
</para>
<para>
- The <filename>build_dir</filename> is optional and specifies the directory Yocto Project
- uses for the build - the <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>build directory</ulink>.
+ The <filename>build_dir</filename> is optional and specifies the directory the
+ OpenEmbedded build system uses for the build -
+ the <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>build directory</ulink>.
If you do not specify a build directory it defaults to <filename>build</filename>
in your current working directory.
A common practice is to use a different build directory for different targets.
</para>
<para>
- 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:
<literallayout class='monospaced'>
$ bitbake <target>
</literallayout>
projects / thirdparty / openembedded / openembedded-core-contrib.git / commitdiff
