documentation/poky-ref-manual/ref-structure.xml: Scrubbed for Poky and edits
I converted "Poky" to "the Yocto Project." I also updated several examples. In particular the build/tmp/work example. (From yocto-docs rev: eb82bc36904f502fb4f314ff05eb86cff27ce0b6) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
parent
cde376cc04
commit
39de08c105
|
@ -6,28 +6,36 @@
|
|||
<title>Reference: Directory Structure</title>
|
||||
|
||||
<para>
|
||||
Poky consists of several components.
|
||||
Understanding them and knowing where they are located is key to using Poky well.
|
||||
This appendix describes the Poky directory structure and gives information about the various
|
||||
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.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
For information on how to establish the Yocto Project files on your local development system, see the
|
||||
<ulink url='http://www.yoctoproject.org/docs/1.1/dev-manual/dev-manual.html#getting-started'>
|
||||
Getting Setup</ulink> section in the
|
||||
<ulink url='http://www.yoctoproject.org/docs/1.1/dev-manual/dev-manual.html'>
|
||||
The Yocto Project Development Manual</ulink>.
|
||||
</para>
|
||||
|
||||
<section id='structure-core'>
|
||||
<title>Top level core components</title>
|
||||
|
||||
<section id='structure-core-bitbake'>
|
||||
<title><filename class="directory">bitbake/</filename></title>
|
||||
<title><filename>bitbake/</filename></title>
|
||||
|
||||
<para>
|
||||
Poky includes a copy of BitBake for ease of use.
|
||||
The Yocto Project 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 Poky metadata and runs the tasks
|
||||
BitBake, a metadata interpreter, reads the Yocto Project metadata and runs the tasks
|
||||
defined by that data.
|
||||
Failures are usually from the metadata and not
|
||||
from BitBake itself.
|
||||
Consequently, most users do not need to worry about BitBake.
|
||||
The <filename class="directory">bitbake/bin/</filename> directory is placed
|
||||
into the PATH environment variable by the
|
||||
The <filename>bitbake/bin/</filename> directory is placed
|
||||
into the <filename>PATH</filename> environment variable by the
|
||||
<link linkend="structure-core-script">oe-init-build-env</link> script.
|
||||
</para>
|
||||
|
||||
|
@ -38,118 +46,88 @@
|
|||
</section>
|
||||
|
||||
<section id='structure-core-build'>
|
||||
<title><filename class="directory">build/</filename></title>
|
||||
<title><filename>build/</filename></title>
|
||||
|
||||
<para>
|
||||
This directory contains user configuration files and the output
|
||||
generated by Poky in its standard configuration where the source tree is
|
||||
combined with 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>
|
||||
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 Poky source.
|
||||
For information on separating output from the Poky source, see <link
|
||||
files in a directory separate from the Yocto Project files
|
||||
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
|
||||
linkend='structure-core-script'>oe-init-build-env</link>.
|
||||
</para>
|
||||
</section>
|
||||
|
||||
<section id='structure-core-meta'>
|
||||
<title><filename class="directory">meta/</filename></title>
|
||||
<section id='handbook'>
|
||||
<title><filename>documentation</filename></title>
|
||||
|
||||
<para>
|
||||
This directory contains the core metadata, which is a key part of Poky.
|
||||
This directory contains the machine definitions, the Poky distribution,
|
||||
This directory holds the source for the Yocto Project documentation
|
||||
as well as templates and tools that allow you to generate PDF and HTML
|
||||
versions of the manuals.
|
||||
Each manual is contained in a sub-folder.
|
||||
For example, the files for this manual reside in
|
||||
<filename>poky-ref-manual</filename>.
|
||||
</para>
|
||||
</section>
|
||||
|
||||
<section id='structure-core-meta'>
|
||||
<title><filename>meta/</filename></title>
|
||||
|
||||
<para>
|
||||
This directory contains the Yocto Project core metadata.
|
||||
The directory holds machine definitions, the Yocto Project distribution,
|
||||
and the packages that make up a given system.
|
||||
</para>
|
||||
</section>
|
||||
|
||||
<!-- <section id='structure-core-meta-extras'>
|
||||
<title><filename class="directory">meta-extras/</filename></title>
|
||||
|
||||
<para>
|
||||
This directory is similar to <filename class="directory">meta/</filename>.
|
||||
The directory contains extra metadata not included in standard Poky.
|
||||
This metadata is disabled by default and is not supported as part of Poky.
|
||||
</para>
|
||||
</section>
|
||||
-->
|
||||
|
||||
<section id='structure-core-meta-demoapps'>
|
||||
<title><filename class="directory">meta-demoapps/</filename></title>
|
||||
<title><filename>meta-demoapps/</filename></title>
|
||||
|
||||
<para>
|
||||
This directory contains recipes for applications and demos that are not core.
|
||||
This directory contains recipes for applications and demos that are not part of the
|
||||
Yocto Project core.
|
||||
</para>
|
||||
</section>
|
||||
|
||||
<section id='structure-core-meta-rt'>
|
||||
<title><filename class="directory">meta-rt/</filename></title>
|
||||
<title><filename>meta-rt/</filename></title>
|
||||
|
||||
<para>
|
||||
This directory contains recipes for RealTime.
|
||||
This directory contains recipes for real-time kernels.
|
||||
</para>
|
||||
</section>
|
||||
|
||||
<!-- <section id='structure-core-meta-***'>
|
||||
<title><filename class="directory">meta-***/</filename></title>
|
||||
<section id='structure-meta-skeleton'>
|
||||
<title><filename>meta-skeleton/</filename></title>
|
||||
|
||||
<para>
|
||||
These directories are optional layers that are added to core metadata.
|
||||
The layers are enabled by adding them to the <filename>conf/bblayers.conf</filename> file.
|
||||
This directory contains template recipes for BSP and kernel development.
|
||||
</para>
|
||||
</section>
|
||||
-->
|
||||
|
||||
<section id='structure-core-scripts'>
|
||||
<title><filename class="directory">scripts/</filename></title>
|
||||
<title><filename>scripts/</filename></title>
|
||||
|
||||
<para>
|
||||
This directory contains various integration scripts that implement
|
||||
extra functionality in the Poky environment (e.g. QEMU scripts).
|
||||
extra functionality in the Yocto Project environment (e.g. QEMU scripts).
|
||||
The <link linkend="structure-core-script">oe-init-build-env</link> script appends this
|
||||
directory to the PATH environment variable.
|
||||
</para>
|
||||
</section>
|
||||
|
||||
<!-- <section id='structure-core-sources'>
|
||||
<title><filename class="directory">sources/</filename></title>
|
||||
|
||||
<para>
|
||||
This directory receives downloads as specified by the
|
||||
<glossterm><link linkend='var-DL_DIR'>DL_DIR</link></glossterm> variable.
|
||||
Even though the directory is not part of a checkout, Poky creates it during a build.
|
||||
You can use this directory to share downloading files between Poky builds.
|
||||
This practice can save you from downloading files multiple times.
|
||||
<note><para>
|
||||
You can override the location for this directory by setting
|
||||
the DL_DIR variable in <filename>local.conf</filename>.
|
||||
</para></note>
|
||||
</para>
|
||||
|
||||
<para>
|
||||
This directory also contains SCM checkouts (e.g. <filename class="directory">sources/svn/
|
||||
</filename>, <filename class="directory">sources/cvs/</filename> or
|
||||
<filename class="directory">sources/git/</filename>).
|
||||
The <filename class="directory">sources</filename> directory can contain archives of
|
||||
checkouts for various revisions or dates.
|
||||
directory to the <filename>PATH</filename> environment variable.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
It's worth noting that BitBake creates <filename class="extension">.md5
|
||||
</filename> stamp files for downloads.
|
||||
BitBake uses these files to mark downloads as
|
||||
complete as well as for checksum and access accounting purposes.
|
||||
If you manually add a file to the directory, you need to touch the corresponding
|
||||
<filename class="extension">.md5</filename> file as well.
|
||||
</para>
|
||||
</section>
|
||||
-->
|
||||
|
||||
<section id='handbook'>
|
||||
<title><filename class="directory">documentation</filename></title>
|
||||
|
||||
<para>
|
||||
This directory holds the source for the documentation. Each manual is contained in
|
||||
a sub-folder. For example, the files for this manual reside in
|
||||
<filename class="directory">poky-ref-manual</filename>.
|
||||
The <filename>scripts</filename> directory has useful scripts that assist contributing
|
||||
back to the Yocto Project, such as <filename>create_pull_request</filename> and
|
||||
<filename>send_pull_request</filename>.
|
||||
</para>
|
||||
</section>
|
||||
|
||||
|
@ -157,25 +135,25 @@
|
|||
<title><filename>oe-init-build-env</filename></title>
|
||||
|
||||
<para>
|
||||
This script sets up the Poky build environment.
|
||||
Sourcing this file in
|
||||
a shell makes changes to PATH and sets other core BitBake variables based on the
|
||||
This script sets up the Yocto Project 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.
|
||||
You need to run this script before running Poky commands.
|
||||
The script uses other scripts within the <filename class="directory">scripts/
|
||||
</filename> directory to do the bulk of the work.
|
||||
You can use this script to specify any directory for the build's output by doing the following:
|
||||
You need to run this script before running BitBake commands.
|
||||
The script uses other scripts within the <filename>scripts</filename> directory to do
|
||||
the bulk of the work.
|
||||
</para>
|
||||
|
||||
<literallayout class='monospaced'>
|
||||
$ source POKY_SRC/oe-init-build-env [BUILDDIR]
|
||||
</literallayout>
|
||||
|
||||
<para>
|
||||
You can enter the above command from any directory, as long as POKY_SRC points to
|
||||
the desired Poky source tree.
|
||||
The optional BUILDDIR can be any directory into which you would
|
||||
like Poky to generate the build output.
|
||||
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.
|
||||
For example, the following command creates a build directory named
|
||||
<filename>mybuilds</filename> that is outside of the Yocto Project files:
|
||||
<literallayout class='monospaced'>
|
||||
$ source oe-init-build-env ~/mybuilds
|
||||
</literallayout>
|
||||
</para>
|
||||
</section>
|
||||
|
||||
|
@ -189,14 +167,14 @@
|
|||
</section>
|
||||
|
||||
<section id='structure-build'>
|
||||
<title>The Build Directory - <filename class="directory">build/</filename></title>
|
||||
<title>The Build Directory - <filename>build/</filename></title>
|
||||
|
||||
<section id='structure-build-pseudodone'>
|
||||
<title><filename>build/pseudodone</filename></title>
|
||||
|
||||
<para>
|
||||
This tag file indicates that the intitial pseudo binar was created.
|
||||
The first time BitBake is invoked this file is built.
|
||||
This tag file indicates that the intitial pseudo binary was created.
|
||||
The file is built the first time BitBake is invoked.
|
||||
</para>
|
||||
</section>
|
||||
|
||||
|
@ -204,21 +182,21 @@
|
|||
<title><filename>build/conf/local.conf</filename></title>
|
||||
|
||||
<para>
|
||||
This file contains all the local user configuration of Poky.
|
||||
This file contains all the local user configuration of the Yocto Project.
|
||||
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 Poky unless
|
||||
that variable is hard-coded within Poky (e.g. by using '=' instead of '?=').
|
||||
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 '?=').
|
||||
Some variables are hard-coded for various reasons but these variables are
|
||||
relatively rare.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
Edit this file to set the <glossterm><link linkend='var-MACHINE'>MACHINE</link></glossterm>
|
||||
Edit this file to set the <filename><link linkend='var-MACHINE'>MACHINE</link></filename>
|
||||
for which you want to build, which package types you
|
||||
wish to use (PACKAGE_CLASSES) or where you want to downloaded files
|
||||
(<glossterm><link linkend='var-DL_DIR'>DL_DIR</link></glossterm>).
|
||||
wish to use (<filename>PACKAGE_CLASSES</filename>), or where you want to downloaded files
|
||||
(<filename><link linkend='var-DL_DIR'>DL_DIR</link></filename>).
|
||||
</para>
|
||||
</section>
|
||||
|
||||
|
@ -228,8 +206,8 @@
|
|||
<para>
|
||||
This file defines layers, which is a directory tree, traversed (or walked) by BitBake.
|
||||
If <filename>bblayers.conf</filename>
|
||||
is not present, it is created from <filename>bblayers.conf.sample</filename> when the environment
|
||||
setup script is sourced.
|
||||
is not present, it is created from <filename>bblayers.conf.sample</filename> when
|
||||
you <filename>source</filename> the environment setup script.
|
||||
</para>
|
||||
</section>
|
||||
|
||||
|
@ -248,7 +226,7 @@
|
|||
This directory is used for the upstream source tarballs.
|
||||
The directory can be reused by multiple builds or moved to another location.
|
||||
You can control the location of this directory through the
|
||||
<glossterm><link linkend='var-DL_DIR'>DL_DIR</link></glossterm> variable.
|
||||
<filename><link linkend='var-DL_DIR'>DL_DIR</link></filename> variable.
|
||||
</para>
|
||||
</section>
|
||||
|
||||
|
@ -259,25 +237,25 @@
|
|||
This directory is used for the shared state cache.
|
||||
The directory can be reused by multiple builds or moved to another location.
|
||||
You can control the location of this directory through the
|
||||
<glossterm><link linkend='var-SSTATE_DIR'>SSTATE_DIR</link></glossterm> variable.
|
||||
<filename><link linkend='var-SSTATE_DIR'>SSTATE_DIR</link></filename> variable.
|
||||
</para>
|
||||
</section>
|
||||
|
||||
<section id='structure-build-tmp'>
|
||||
<title><filename class="directory">build/tmp/</filename></title>
|
||||
<title><filename>build/tmp/</filename></title>
|
||||
|
||||
<para>
|
||||
This directory receives all the Poky output.
|
||||
This directory receives all the Yocto Project output.
|
||||
BitBake creates this directory if it does not exist.
|
||||
To clean Poky and start a build from scratch (other than downloads),
|
||||
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.
|
||||
The <filename class="directory">tmp/</filename> directory has some important
|
||||
sub-components detailed below.
|
||||
If you do, you should also completely remove the <filename>build/sstate-cache</filename>
|
||||
directory as well.
|
||||
</para>
|
||||
</section>
|
||||
|
||||
<section id='structure-build-tmp-buildstats'>
|
||||
<title><filename class="directory">build/tmp/buildstats/</filename></title>
|
||||
<title><filename>build/tmp/buildstats/</filename></title>
|
||||
|
||||
<para>
|
||||
This directory stores the build statistics.
|
||||
|
@ -285,56 +263,68 @@
|
|||
</section>
|
||||
|
||||
<section id='structure-build-tmp-cache'>
|
||||
<title><filename class="directory">build/tmp/cache/</filename></title>
|
||||
<title><filename>build/tmp/cache/</filename></title>
|
||||
|
||||
<para>
|
||||
When BitBake parses the metadata it creates a cache file of the result that can
|
||||
When BitBake parses the metadata, it creates a cache file of the result that can
|
||||
be used when subsequently running commands.
|
||||
These results are stored here on a per-machine basis.
|
||||
</para>
|
||||
</section>
|
||||
|
||||
<section id='structure-build-tmp-deploy'>
|
||||
<title><filename class="directory">build/tmp/deploy/</filename></title>
|
||||
<title><filename>build/tmp/deploy/</filename></title>
|
||||
|
||||
<para>This directory contains any 'end result' output from Poky.</para>
|
||||
<para>
|
||||
This directory contains any 'end result' output from the Yocto Project build process.
|
||||
</para>
|
||||
</section>
|
||||
|
||||
<section id='structure-build-tmp-deploy-deb'>
|
||||
<title><filename class="directory">build/tmp/deploy/deb/</filename></title>
|
||||
<title><filename>build/tmp/deploy/deb/</filename></title>
|
||||
|
||||
<para>
|
||||
This directory receives any <filename>.deb</filename> packages produced by Poky.
|
||||
This directory receives any <filename>.deb</filename> packages produced by the Yocto Project.
|
||||
The packages are sorted into feeds for different architecture types.
|
||||
</para>
|
||||
</section>
|
||||
|
||||
<section id='structure-build-tmp-deploy-rpm'>
|
||||
<title><filename class="directory">build/tmp/deploy/rpm/</filename></title>
|
||||
<title><filename>build/tmp/deploy/rpm/</filename></title>
|
||||
|
||||
<para>
|
||||
This directory receives any <filename>.rpm</filename> packages produced by Poky.
|
||||
This directory receives any <filename>.rpm</filename> packages produced by the Yocto Project.
|
||||
The packages are sorted into feeds for different architecture types.
|
||||
</para>
|
||||
</section>
|
||||
|
||||
<section id='structure-build-tmp-deploy-images'>
|
||||
<title><filename class="directory">build/tmp/deploy/images/</filename></title>
|
||||
<title><filename>build/tmp/deploy/images/</filename></title>
|
||||
|
||||
<para>
|
||||
This directory receives complete filesystem images.
|
||||
If you want to flash the resulting image from a build onto a device, look here for the image.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
Note, you should not remove any files from this directory by hand in an attempt
|
||||
to rebuild an image.
|
||||
If you want to clean out the cache, re-run the build using the following
|
||||
BitBake command:
|
||||
<literallayout class='monospaced'>
|
||||
$ bitbake -c cleanall <target>
|
||||
</literallayout>
|
||||
</para>
|
||||
</section>
|
||||
|
||||
<section id='structure-build-tmp-deploy-ipk'>
|
||||
<title><filename class="directory">build/tmp/deploy/ipk/</filename></title>
|
||||
<title><filename>build/tmp/deploy/ipk/</filename></title>
|
||||
|
||||
<para>This directory receives <filename>.ipk</filename> packages produced by Poky.</para>
|
||||
<para>This directory receives <filename>.ipk</filename> packages produced by the Yocto Project.</para>
|
||||
</section>
|
||||
|
||||
<section id='structure-build-tmp-sysroots'>
|
||||
<title><filename class="directory">build/tmp/sysroots/</filename></title>
|
||||
<title><filename>build/tmp/sysroots/</filename></title>
|
||||
|
||||
<para>
|
||||
This directory contains shared header files and libraries as well as other shared
|
||||
|
@ -346,7 +336,7 @@
|
|||
</section>
|
||||
|
||||
<section id='structure-build-tmp-stamps'>
|
||||
<title><filename class="directory">build/tmp/stamps/</filename></title>
|
||||
<title><filename>build/tmp/stamps/</filename></title>
|
||||
|
||||
<para>
|
||||
This directory holds information that that BitBake uses for accounting purposes
|
||||
|
@ -358,17 +348,18 @@
|
|||
</section>
|
||||
|
||||
<section id='structure-build-tmp-log'>
|
||||
<title><filename class="directory">build/tmp/log/</filename></title>
|
||||
<title><filename>build/tmp/log/</filename></title>
|
||||
|
||||
<para>
|
||||
This directory contains general logs that are not otherwise placed using the
|
||||
package's <glossterm><link linkend='var-WORKDIR'>WORKDIR</link></glossterm>.
|
||||
Examples of logs are the output from the "check_pkg" or "distro_check" tasks.
|
||||
package's <filename><link linkend='var-WORKDIR'>WORKDIR</link></filename>.
|
||||
Examples of logs are the output from the <filename>check_pkg</filename> or
|
||||
<filename>distro_check</filename> tasks.
|
||||
</para>
|
||||
</section>
|
||||
|
||||
<section id='structure-build-tmp-pkgdata'>
|
||||
<title><filename class="directory">build/tmp/pkgdata/</filename></title>
|
||||
<title><filename>build/tmp/pkgdata/</filename></title>
|
||||
|
||||
<para>
|
||||
This directory contains intermediate packaging data that is used later in the packaging process.
|
||||
|
@ -376,72 +367,65 @@
|
|||
</para>
|
||||
</section>
|
||||
|
||||
<section id='structure-build-tmp-pstagelogs'>
|
||||
<title><filename class="directory">build/tmp/pstagelogs/</filename></title>
|
||||
|
||||
<para>
|
||||
This directory contains manifest for task-based pre-built.
|
||||
Each manifest is basically a file list for installed files from a given task.
|
||||
Manifests are useful for later packaging or cleanup processes.
|
||||
</para>
|
||||
</section>
|
||||
|
||||
<section id='structure-build-tmp-work'>
|
||||
<title><filename class="directory">build/tmp/work/</filename></title>
|
||||
<title><filename>build/tmp/work/</filename></title>
|
||||
|
||||
<para>
|
||||
This directory contains architecture-specific work sub-directories for packages built by BitBake.
|
||||
All tasks execute from a work directory.
|
||||
For example, the source for a particular package is unpacked, patched, configured and compiled all
|
||||
within its own work directory.
|
||||
Within the work directory, organization is based on the package group for which the source
|
||||
is being compiled.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
It is worth considering the structure of a typical work directory.
|
||||
As an example consider the linux-rp kernel, version 2.6.20 r7 on the machine spitz
|
||||
built within Poky.
|
||||
For this package a work directory of
|
||||
<filename class="directory">tmp/work/spitz-poky-linux-gnueabi/linux-rp-2.6.20-r7/</filename>,
|
||||
referred to as <glossterm><link linkend='var-WORKDIR'>WORKDIR</link></glossterm>, is created.
|
||||
Within this directory, the source is unpacked to linux-2.6.20 and then patched by quilt
|
||||
(see <link linkend="usingpoky-modifying-packages-quilt">Section 3.5.1</link>).
|
||||
Within the <filename class="directory">linux-2.6.20</filename> directory,
|
||||
standard quilt directories <filename class="directory">linux-2.6.20/patches</filename>
|
||||
and <filename class="directory">linux-2.6.20/.pc</filename> are created,
|
||||
and standard quilt commands can be used.
|
||||
As an example, consider the linux-yocto kernel 3.0 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+<.....></filename>,
|
||||
referred to as <filename><link linkend='var-WORKDIR'>WORKDIR</link></filename>, is created.
|
||||
Within this directory, the source is unpacked to
|
||||
<filename>linux-qemux86-standard-build</filename> and then patched by Quilt
|
||||
(see the <link linkend="usingpoky-modifying-packages-quilt">Modifying Package Source Code
|
||||
With Quilt</link> section).
|
||||
Within the <filename>linux-qemux86-standard-build</filename> directory,
|
||||
standard Quilt directories <filename>linux-3.0/patches</filename>
|
||||
and <filename>linux-3.0/.pc</filename> are created,
|
||||
and standard Quilt commands can be used.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
There are other directories generated within WORKDIR.
|
||||
The most important directory is WORKDIR
|
||||
<filename class="directory">/temp/</filename>, which has log files for each
|
||||
The most important directory is WORKDIR<filename>/temp/</filename>, which has log files for each
|
||||
task (<filename>log.do_*.pid</filename>) and contains the scripts BitBake runs for
|
||||
each task (<filename>run.do_*.pid</filename>).
|
||||
The WORKDIR<filename class="directory">/image/</filename> directory is where "make
|
||||
The WORKDIR<filename>/image/</filename> directory is where "make
|
||||
install" places its output that is then split into sub-packages
|
||||
within WORKDIR<filename class="directory">/packages-split/</filename>.
|
||||
within WORKDIR<filename>/packages-split/</filename>.
|
||||
</para>
|
||||
</section>
|
||||
</section>
|
||||
|
||||
<section id='structure-meta'>
|
||||
<title>The Metadata - <filename class="directory">meta/</filename></title>
|
||||
<title>The Metadata - <filename>meta/</filename></title>
|
||||
|
||||
<para>
|
||||
As mentioned previously, metadata is the core of Poky.
|
||||
As mentioned previously, metadata is the core of the Yocto Project.
|
||||
Metadata has several important subdivisions:
|
||||
</para>
|
||||
|
||||
<section id='structure-meta-classes'>
|
||||
<title><filename class="directory">meta/classes/</filename></title>
|
||||
<title><filename>meta/classes/</filename></title>
|
||||
|
||||
<para>
|
||||
This directory contains the <filename class="extension">*.bbclass</filename> files.
|
||||
This directory contains the <filename>*.bbclass</filename> files.
|
||||
Class files are used to abstract common code so it can be reused by multiple
|
||||
packages.
|
||||
Every package inherits the <filename>base.bbclass</filename> file.
|
||||
Examples of other important classes are <filename>autotools.bbclass</filename>, which
|
||||
in theory allows any Autotool-enabled package to work with Poky with minimal effort.
|
||||
in theory allows any Autotool-enabled package to work with the Yocto Project with minimal effort.
|
||||
Another example is <filename>kernel.bbclass</filename> that contains common code and functions
|
||||
for working with the Linux kernel.
|
||||
Functions like image generation or packaging also have their specific class files
|
||||
|
@ -451,14 +435,14 @@
|
|||
</section>
|
||||
|
||||
<section id='structure-meta-conf'>
|
||||
<title><filename class="directory">meta/conf/</filename></title>
|
||||
<title><filename>meta/conf/</filename></title>
|
||||
|
||||
<para>
|
||||
This directory contains the core set of configuration files that start from
|
||||
<filename>bitbake.conf</filename> and from which all other configuration
|
||||
files are included.
|
||||
See the includes at the end of the file and you will note that even
|
||||
<filename>local.conf</filename> is loaded from there!
|
||||
See the include statements at the end of the file and you will note that even
|
||||
<filename>local.conf</filename> is loaded from there.
|
||||
While <filename>bitbake.conf</filename> sets up the defaults, you can often override
|
||||
these by using the (<filename>local.conf</filename>) file, machine file or
|
||||
the distribution configuration file.
|
||||
|
@ -466,32 +450,32 @@
|
|||
</section>
|
||||
|
||||
<section id='structure-meta-conf-machine'>
|
||||
<title><filename class="directory">meta/conf/machine/</filename></title>
|
||||
<title><filename>meta/conf/machine/</filename></title>
|
||||
|
||||
<para>
|
||||
This directory contains all the machine configuration files.
|
||||
If you set MACHINE="spitz", Poky looks for a <filename>spitz.conf</filename> file in this
|
||||
If you set MACHINE="spitz", Yocto Project looks for a <filename>spitz.conf</filename> file in this
|
||||
directory.
|
||||
The includes directory contains various data common to multiple machines.
|
||||
If you want to add support for a new machine to Poky, look 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.
|
||||
</para>
|
||||
</section>
|
||||
|
||||
<section id='structure-meta-conf-distro'>
|
||||
<title><filename class="directory">meta/conf/distro/</filename></title>
|
||||
<title><filename>meta/conf/distro/</filename></title>
|
||||
|
||||
<para>
|
||||
Any distribution-specific configuration is controlled from this directory.
|
||||
Poky only contains the Poky distribution so <filename>poky.conf</filename>
|
||||
is the main file here.
|
||||
The Yocto Project only contains the Yocto Project distribution so
|
||||
<filename>defaultsetup.conf</filename> is the main file here.
|
||||
This directory includes the versions and SRCDATES 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 Poky itself.
|
||||
although this file mainly inherits its configuration from the Yocto Project itself.
|
||||
</para>
|
||||
</section>
|
||||
|
||||
<section id='structure-meta-recipes-bsp'>
|
||||
<title><filename class="directory">meta/recipes-bsp/</filename></title>
|
||||
<title><filename>meta/recipes-bsp/</filename></title>
|
||||
|
||||
<para>
|
||||
This directory contains anything linking to specific hardware or hardware configuration information
|
||||
|
@ -500,7 +484,7 @@
|
|||
</section>
|
||||
|
||||
<section id='structure-meta-recipes-connectivity'>
|
||||
<title><filename class="directory">meta/recipes-connectivity/</filename></title>
|
||||
<title><filename>meta/recipes-connectivity/</filename></title>
|
||||
|
||||
<para>
|
||||
This directory contains libraries and applications related to communication with other devices.
|
||||
|
@ -508,7 +492,7 @@
|
|||
</section>
|
||||
|
||||
<section id='structure-meta-recipes-core'>
|
||||
<title><filename class="directory">meta/recipes-core/</filename></title>
|
||||
<title><filename>meta/recipes-core/</filename></title>
|
||||
|
||||
<para>
|
||||
This directory contains what is needed to build a basic working Linux image
|
||||
|
@ -517,7 +501,7 @@
|
|||
</section>
|
||||
|
||||
<section id='structure-meta-recipes-devtools'>
|
||||
<title><filename class="directory">meta/recipes-devtools/</filename></title>
|
||||
<title><filename>meta/recipes-devtools/</filename></title>
|
||||
|
||||
<para>
|
||||
This directory contains tools that are primarily used by the build system.
|
||||
|
@ -526,7 +510,7 @@
|
|||
</section>
|
||||
|
||||
<section id='structure-meta-recipes-extended'>
|
||||
<title><filename class="directory">meta/recipes-extended/</filename></title>
|
||||
<title><filename>meta/recipes-extended/</filename></title>
|
||||
|
||||
<para>
|
||||
This directory contains non-essential applications that add features compared to the
|
||||
|
@ -537,7 +521,7 @@
|
|||
</section>
|
||||
|
||||
<section id='structure-meta-recipes-gnome'>
|
||||
<title><filename class="directory">meta/recipes-gnome/</filename></title>
|
||||
<title><filename>meta/recipes-gnome/</filename></title>
|
||||
|
||||
<para>
|
||||
This directory contains all things related to the GTK+ application framework.
|
||||
|
@ -545,7 +529,7 @@
|
|||
</section>
|
||||
|
||||
<section id='structure-meta-recipes-graphics'>
|
||||
<title><filename class="directory">meta/recipes-graphics/</filename></title>
|
||||
<title><filename>meta/recipes-graphics/</filename></title>
|
||||
|
||||
<para>
|
||||
This directory contains X and other graphically related system libraries
|
||||
|
@ -553,7 +537,7 @@
|
|||
</section>
|
||||
|
||||
<section id='structure-meta-recipes-kernel'>
|
||||
<title><filename class="directory">meta/recipes-kernel/</filename></title>
|
||||
<title><filename>meta/recipes-kernel/</filename></title>
|
||||
|
||||
<para>
|
||||
This directory contains the kernel and generic applications and libraries that
|
||||
|
@ -562,7 +546,7 @@
|
|||
</section>
|
||||
|
||||
<section id='structure-meta-recipes-multimedia'>
|
||||
<title><filename class="directory">meta/recipes-multimedia/</filename></title>
|
||||
<title><filename>meta/recipes-multimedia/</filename></title>
|
||||
|
||||
<para>
|
||||
This directory contains codecs and support utilities for audio, images and video.
|
||||
|
@ -570,7 +554,7 @@
|
|||
</section>
|
||||
|
||||
<section id='structure-meta-recipes-qt'>
|
||||
<title><filename class="directory">meta/recipes-qt/</filename></title>
|
||||
<title><filename>meta/recipes-qt/</filename></title>
|
||||
|
||||
<para>
|
||||
This directory contains all things related to the QT application framework.
|
||||
|
@ -578,7 +562,7 @@
|
|||
</section>
|
||||
|
||||
<section id='structure-meta-recipes-sato'>
|
||||
<title><filename class="directory">meta/recipes-sato/</filename></title>
|
||||
<title><filename>meta/recipes-sato/</filename></title>
|
||||
|
||||
<para>
|
||||
This directory contains the Sato demo/reference UI/UX and its associated applications
|
||||
|
@ -587,7 +571,7 @@
|
|||
</section>
|
||||
|
||||
<section id='structure-meta-recipes-support'>
|
||||
<title><filename class="directory">meta/recipes-support/</filename></title>
|
||||
<title><filename>meta/recipes-support/</filename></title>
|
||||
|
||||
<para>
|
||||
This directory contains recipes that used by other recipes, but that are not directly
|
||||
|
@ -596,7 +580,7 @@
|
|||
</section>
|
||||
|
||||
<section id='structure-meta-site'>
|
||||
<title><filename class="directory">meta/site/</filename></title>
|
||||
<title><filename>meta/site/</filename></title>
|
||||
|
||||
<para>
|
||||
This directory contains a list of cached results for various architectures.
|
||||
|
@ -607,7 +591,7 @@
|
|||
</section>
|
||||
|
||||
<section id='structure-meta-recipes-txt'>
|
||||
<title><filename class="directory">meta/recipes.txt/</filename></title>
|
||||
<title><filename>meta/recipes.txt/</filename></title>
|
||||
|
||||
<para>
|
||||
This file is a description of the contents of <filename>recipes-*</filename>.
|
||||
|
|
Loading…
Reference in New Issue