1
0
mirror of https://git.yoctoproject.org/poky synced 2026-07-21 05:27:01 +00:00

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 <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
Scott Rifenbark
2012-07-02 14:34:39 -07:00
committed by Richard Purdie
parent 7064538309
commit 5966b44893
11 changed files with 200 additions and 168 deletions
+35 -26
View File
@@ -9,12 +9,12 @@
<para>
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 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>source directory</ulink>
and gives information about the various files and directories.
</para>
<para>
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
"<ulink url='&YOCTO_DOCS_DEV_URL;#getting-setup'>Getting Set Up</ulink>"
section in the Yocto Project Development Manual.
</para>
@@ -49,18 +49,20 @@
<para>
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 <filename>source</filename>
generated by the OpenEmbedded build system in its standard configuration where
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>.
</para>
<para>
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
<ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>source directory</ulink>
by providing a directory name when you <filename>source</filename>
the setup script.
For information on separating output from the Yocto Project files, see <link
For information on separating output from your local source directory files, see <link
linkend='structure-core-script'>oe-init-build-env</link>.
</para>
</section>
@@ -147,9 +149,11 @@
By default, running this script without a build directory argument creates the
<filename>build</filename> directory.
If you provide a build directory argument when you <filename>source</filename>
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
<ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>build directory</ulink> of your choice.
For example, the following command creates a build directory named
<filename>mybuilds</filename> that is outside of the Yocto Project files:
<filename>mybuilds</filename> that is outside of the
<ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>sourc directory</ulink>:
<literallayout class='monospaced'>
$ source oe-init-build-env ~/mybuilds
</literallayout>
@@ -181,12 +185,12 @@
<title><filename>build/conf/local.conf</filename></title>
<para>
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 <filename>local.conf</filename> present, it is created from
<filename>local.conf.sample</filename>.
The <filename>local.conf</filename> 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.
</para>
@@ -244,10 +248,11 @@
<title><filename>build/tmp/</filename></title>
<para>
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 <filename>tmp</filename> directory or get rid of the
directory completely.
If you do, you should also completely remove the <filename>build/sstate-cache</filename>
directory as well.
</para>
@@ -275,7 +280,7 @@
<title><filename>build/tmp/deploy/</filename></title>
<para>
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.
</para>
</section>
@@ -283,7 +288,8 @@
<title><filename>build/tmp/deploy/deb/</filename></title>
<para>
This directory receives any <filename>.deb</filename> packages produced by the Yocto Project.
This directory receives any <filename>.deb</filename> packages produced by
the build process.
The packages are sorted into feeds for different architecture types.
</para>
</section>
@@ -292,7 +298,8 @@
<title><filename>build/tmp/deploy/rpm/</filename></title>
<para>
This directory receives any <filename>.rpm</filename> packages produced by the Yocto Project.
This directory receives any <filename>.rpm</filename> packages produced by
the build process.
The packages are sorted into feeds for different architecture types.
</para>
</section>
@@ -319,7 +326,9 @@
<section id='structure-build-tmp-deploy-ipk'>
<title><filename>build/tmp/deploy/ipk/</filename></title>
<para>This directory receives <filename>.ipk</filename> packages produced by the Yocto Project.</para>
<para>
This directory receives <filename>.ipk</filename> packages produced by
the build process.</para>
</section>
<section id='structure-build-tmp-sysroots'>
@@ -380,7 +389,8 @@
<para>
It is worth considering the structure of a typical work directory.
As an example, consider the linux-yocto kernel 3.0 on the machine <filename>qemux86</filename>
As an example, consider the <filename>linux-yocto-kernel-3.0</filename>
on the machine <filename>qemux86</filename>
built within the Yocto Project.
For this package, a work directory of
<filename>tmp/work/qemux86-poky-linux/linux-yocto-3.0+git1+&lt;.....&gt;</filename>,
@@ -455,7 +465,7 @@
<para>
This directory contains all the machine configuration files.
If you set <filename>MACHINE="qemux86"</filename>,
Yocto Project looks for a <filename>qemux86.conf</filename> file in this
the OpenEmbedded build system looks for a <filename>qemux86.conf</filename> file in this
directory.
The <filename>include</filename> 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 @@
<para>
Any distribution-specific configuration is controlled from this directory.
The Yocto Project only contains the Yocto Project distribution so
<filename>defaultsetup.conf</filename> is the main file here.
For the Yocto Project, the <filename>defaultsetup.conf</filename> is the main file here.
This directory includes the versions and the
<filename>SRCDATE</filename> definitions for applications that are configured here.
An example of an alternative configuration is <filename>poky-bleeding.conf</filename>
although this file mainly inherits its configuration from the Yocto Project itself.
An example of an alternative configuration might be <filename>poky-bleeding.conf</filename>.
Although this file mainly inherits its configuration from Poky.
</para>
</section>