documentation/poky-ref-manual: English scrub performed for consistency.
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
This commit is contained in:
Scott Rifenbark
Saul Wold
parent
57d38a7e7a
commit
252cecf379
|
|
@ -6,9 +6,9 @@
|
|||
<title>Reference: Directory Structure</title>
|
||||
|
||||
<para>
|
||||
Poky consists of several components and understanding what these are
|
||||
and where they're located is one of the keys to using it. This section walks
|
||||
through the Poky directory structure giving information about the various
|
||||
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
|
||||
files and directories.
|
||||
</para>
|
||||
|
||||
|
|
@ -19,17 +19,20 @@
|
|||
<title><filename class="directory">bitbake/</filename></title>
|
||||
|
||||
<para>
|
||||
A copy of BitBake is included within Poky for ease of use, and should
|
||||
usually match the current BitBake stable release from the BitBake project.
|
||||
Bitbake, a metadata interpreter, reads the Poky metadata and runs the tasks
|
||||
defined in the Poky metadata. Failures are usually from the metadata, not
|
||||
BitBake itself, so most users don't need to worry about BitBake. The
|
||||
<filename class="directory">bitbake/bin/</filename> directory is placed
|
||||
into the PATH environment variable by the <link
|
||||
linkend="structure-core-script">poky-init-build-env</link> script.
|
||||
Poky 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
|
||||
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
|
||||
<link linkend="structure-core-script">poky-init-build-env</link> script.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
For more information on BitBake please see the BitBake project site at
|
||||
For more information on BitBake, see the BitBake project site at
|
||||
<ulink url="http://bitbake.berlios.de/"/>
|
||||
and the BitBake on-line manual at <ulink url="http://bitbake.berlios.de/manual/"/>.
|
||||
</para>
|
||||
|
|
@ -41,9 +44,11 @@
|
|||
<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. It is also possible to place output and configuration
|
||||
files in a directory separate from the Poky source, see the section <link
|
||||
linkend='structure-core-script'>seperate output directory</link>.
|
||||
combined with the output.
|
||||
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
|
||||
linkend='structure-core-script'>poky-init-build-env</link>.
|
||||
</para>
|
||||
</section>
|
||||
|
||||
|
|
@ -51,8 +56,8 @@
|
|||
<title><filename class="directory">meta/</filename></title>
|
||||
|
||||
<para>
|
||||
This directory contains the core metadata, a key part of Poky. Within this
|
||||
directory there are definitions of the machines, the Poky distribution
|
||||
This directory contains the core metadata, which is a key part of Poky.
|
||||
This directory contains the machine definitions, the Poky distribution,
|
||||
and the packages that make up a given system.
|
||||
</para>
|
||||
</section>
|
||||
|
|
@ -61,9 +66,9 @@
|
|||
<title><filename class="directory">meta-extras/</filename></title>
|
||||
|
||||
<para>
|
||||
This directory is similar to <filename class="directory">meta/</filename>,
|
||||
and contains some extra metadata not included in standard Poky. These are
|
||||
disabled by default, and are not supported as part of Poky.
|
||||
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>
|
||||
|
||||
|
|
@ -71,8 +76,8 @@
|
|||
<title><filename class="directory">meta-***/</filename></title>
|
||||
|
||||
<para>
|
||||
These directories are optional layers to be added to core metadata, which
|
||||
are enabled by adding them to conf/bblayers.conf.
|
||||
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.
|
||||
</para>
|
||||
</section>
|
||||
|
||||
|
|
@ -80,10 +85,10 @@
|
|||
<title><filename class="directory">scripts/</filename></title>
|
||||
|
||||
<para>
|
||||
This directory contains various integration scripts which implement
|
||||
extra functionality in the Poky environment, such as the QEMU
|
||||
scripts. This directory is appended to the PATH environment variable by the
|
||||
<link linkend="structure-core-script">poky-init-build-env</link> script.
|
||||
This directory contains various integration scripts that implement
|
||||
extra functionality in the Poky environment (e.g. QEMU scripts).
|
||||
The <link linkend="structure-core-script">poky-init-build-env</link> script appends this
|
||||
directory to the PATH environment variable.
|
||||
</para>
|
||||
</section>
|
||||
|
||||
|
|
@ -91,40 +96,42 @@
|
|||
<title><filename class="directory">sources/</filename></title>
|
||||
|
||||
<para>
|
||||
While not part of a checkout, Poky will create this directory as
|
||||
part of any build. Any downloads are placed in this directory (as
|
||||
specified by the <glossterm><link linkend='var-DL_DIR'>DL_DIR</link>
|
||||
</glossterm> variable). This directory can be shared between Poky
|
||||
builds to save downloading files multiple times. SCM checkouts are
|
||||
also stored here as e.g. <filename class="directory">sources/svn/
|
||||
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> and the
|
||||
sources directory may contain archives of checkouts for various
|
||||
revisions or dates.
|
||||
<filename class="directory">sources/git/</filename>).
|
||||
The <filename class="directory">sources</filename> directory can contain archives of
|
||||
checkouts for various revisions or dates.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
It's worth noting that BitBake creates <filename class="extension">.md5
|
||||
</filename> stamp files for downloads. It uses these to mark downloads as
|
||||
complete as well as for checksum and access accounting purposes. If you add
|
||||
a file manually to the directory, you need to touch the corresponding
|
||||
<filename class="extension">.md5</filename> file too.
|
||||
</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>
|
||||
|
||||
<para>
|
||||
This location can be overridden by setting <glossterm><link
|
||||
linkend='var-DL_DIR'>DL_DIR</link></glossterm> in <filename>local.conf
|
||||
</filename>. This directory can be shared between builds and even between
|
||||
machines via NFS, so downloads are only made once, speeding up builds.
|
||||
</para>
|
||||
|
||||
</section>
|
||||
|
||||
<section id='handbook'>
|
||||
<title><filename class="directory">documentation</filename></title>
|
||||
|
||||
<para>
|
||||
This is the location for documentaiton about poky including this handbook.
|
||||
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>.
|
||||
</para>
|
||||
</section>
|
||||
|
||||
|
|
@ -132,46 +139,50 @@
|
|||
<title><filename>poky-init-build-env</filename></title>
|
||||
|
||||
<para>
|
||||
This script is used to setup the Poky build environment. Sourcing this file in
|
||||
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
|
||||
current working directory. You need to use this before running Poky commands.
|
||||
Internally it uses scripts within the <filename class="directory">scripts/
|
||||
</filename> directory to do the bulk of the work. This script supports
|
||||
specifying any directory as the build output:
|
||||
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:
|
||||
</para>
|
||||
|
||||
<programlisting>
|
||||
source POKY_SRC/poky-init-build-env [BUILDDIR]
|
||||
</programlisting>
|
||||
<literallayout class='monospaced'>
|
||||
$ source POKY_SRC/poky-init-build-env [BUILDDIR]
|
||||
</literallayout>
|
||||
|
||||
<para>
|
||||
The above command can be typed from any directory, as long as POKY_SRC points to
|
||||
the desired Poky source tree. The optional BUILDDIR could be any directory you'd
|
||||
like Poky to generate the build output into.
|
||||
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.
|
||||
</para>
|
||||
</section>
|
||||
</section>
|
||||
|
||||
<section id='structure-build'>
|
||||
<title><filename class="directory">build/</filename> - The Build Directory</title>
|
||||
<title>The Build Directory - <filename class="directory">build/</filename></title>
|
||||
|
||||
<section id='structure-build-conf-local.conf'>
|
||||
<title><filename>build/conf/local.conf</filename></title>
|
||||
|
||||
<para>
|
||||
This file contains all the local user configuration of Poky. 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 hardcoded within Poky (e.g. by using '=' instead of '?=').
|
||||
Some variables are hardcoded for various reasons but these variables are
|
||||
This file contains all the local user configuration of Poky.
|
||||
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 '?=').
|
||||
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> for which you want to build, which package types you
|
||||
wish to use (PACKAGE_CLASSES) or where downloaded files should go
|
||||
Edit this file to set the <glossterm><link linkend='var-MACHINE'>MACHINE</link></glossterm>
|
||||
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>).
|
||||
</para>
|
||||
</section>
|
||||
|
|
@ -180,9 +191,10 @@ source POKY_SRC/poky-init-build-env [BUILDDIR]
|
|||
<title><filename>build/conf/bblayers.conf</filename></title>
|
||||
|
||||
<para>
|
||||
This file defines layers walked by bitbake. If there's no <filename>
|
||||
bblayers.conf</filename> present, it is created from <filename>bblayers.conf.sample
|
||||
</filename> when the environment setup script is sourced.
|
||||
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.
|
||||
</para>
|
||||
</section>
|
||||
|
||||
|
|
@ -190,10 +202,12 @@ source POKY_SRC/poky-init-build-env [BUILDDIR]
|
|||
<title><filename class="directory">build/tmp/</filename></title>
|
||||
|
||||
<para>
|
||||
This is created by BitBake if it doesn't exist and is where all the Poky output
|
||||
is placed. To clean Poky and start a build from scratch (other than downloads),
|
||||
you can wipe this directory. The <filename class="directory">tmp/
|
||||
</filename> directory has some important sub-components detailed below.
|
||||
This directory receives all the Poky output.
|
||||
BitBake creates this directory if it does not exist.
|
||||
To clean Poky 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.
|
||||
</para>
|
||||
</section>
|
||||
|
||||
|
|
@ -201,24 +215,24 @@ source POKY_SRC/poky-init-build-env [BUILDDIR]
|
|||
<title><filename class="directory">build/tmp/cache/</filename></title>
|
||||
|
||||
<para>
|
||||
When BitBake parses the metadata it creates a cache file of the result which can
|
||||
be used when subsequently running commands. These are stored here on
|
||||
a per machine basis.
|
||||
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>
|
||||
|
||||
<para>Any 'end result' output from Poky is placed under here.</para>
|
||||
<para>This directory contains any 'end result' output from Poky.</para>
|
||||
</section>
|
||||
|
||||
<section id='structure-build-tmp-deploy-deb'>
|
||||
<title><filename class="directory">build/tmp/deploy/deb/</filename></title>
|
||||
|
||||
<para>
|
||||
Any .deb packages emitted by Poky are placed here, sorted into feeds for
|
||||
different architecture types.
|
||||
This directory receives any .deb packages produced by Poky.
|
||||
The packages are sorted into feeds for different architecture types.
|
||||
</para>
|
||||
</section>
|
||||
|
||||
|
|
@ -226,8 +240,8 @@ source POKY_SRC/poky-init-build-env [BUILDDIR]
|
|||
<title><filename class="directory">build/tmp/deploy/rpm/</filename></title>
|
||||
|
||||
<para>
|
||||
Any .rpm packages emitted by Poky are placed here, sorted into feeds for
|
||||
different architecture types.
|
||||
This directory receives any .rpm packages produced by Poky.
|
||||
The packages re sorted into feeds for different architecture types.
|
||||
</para>
|
||||
</section>
|
||||
|
||||
|
|
@ -235,24 +249,25 @@ source POKY_SRC/poky-init-build-env [BUILDDIR]
|
|||
<title><filename class="directory">build/tmp/deploy/images/</filename></title>
|
||||
|
||||
<para>
|
||||
Complete filesystem images are placed here. If you want to flash the resulting
|
||||
image from a build onto a device, look here for them.
|
||||
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>
|
||||
</section>
|
||||
|
||||
<section id='structure-build-tmp-deploy-ipk'>
|
||||
<title><filename class="directory">build/tmp/deploy/ipk/</filename></title>
|
||||
|
||||
<para>Any resulting .ipk packages emitted by Poky are placed here.</para>
|
||||
<para>This directory receives .ipk packages produced by Poky.</para>
|
||||
</section>
|
||||
|
||||
<section id='structure-build-tmp-sysroots'>
|
||||
<title><filename class="directory">build/tmp/sysroots/</filename></title>
|
||||
|
||||
<para>
|
||||
Any package needing to share output with other packages does so within sysroots.
|
||||
This means it contains any shared header files and any shared libraries amongst
|
||||
other data. It is subdivided by architecture so multiple builds can run within
|
||||
This directory contains shared header files and libraries as well as other shared
|
||||
data.
|
||||
Packages that need to share output with other packages do so within this directory.
|
||||
The directory is subdivided by architecture so multiple builds can run within
|
||||
the one build directory.
|
||||
</para>
|
||||
</section>
|
||||
|
|
@ -261,9 +276,11 @@ source POKY_SRC/poky-init-build-env [BUILDDIR]
|
|||
<title><filename class="directory">build/tmp/stamps/</filename></title>
|
||||
|
||||
<para>
|
||||
This is used by BitBake for accounting purposes to keep track of which tasks
|
||||
have been run and when. It is also subdivided by architecture. The files are
|
||||
empty and the important information is the filenames and timestamps.
|
||||
This directory holds information that that BitBake uses for accounting purposes
|
||||
to track what tasks have run and when they have run.
|
||||
The directory is sub-divided by architecture.
|
||||
The files in the directory are empty of data.
|
||||
However, BitBake uses the filenames and timestamps for tracking purposes.
|
||||
</para>
|
||||
</section>
|
||||
|
||||
|
|
@ -271,9 +288,9 @@ source POKY_SRC/poky-init-build-env [BUILDDIR]
|
|||
<title><filename class="directory">build/tmp/log/</filename></title>
|
||||
|
||||
<para>
|
||||
This contains some general logs if not placing in a package's
|
||||
<glossterm><link linkend='var-WORKDIR'>WORKDIR</link></glossterm>, such as
|
||||
the log output from check_pkg or distro_check tasks.
|
||||
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.
|
||||
</para>
|
||||
</section>
|
||||
|
||||
|
|
@ -281,9 +298,8 @@ source POKY_SRC/poky-init-build-env [BUILDDIR]
|
|||
<title><filename class="directory">build/tmp/pkgdata/</filename></title>
|
||||
|
||||
<para>
|
||||
This is an intermediate place for saving packaging data, which will be used
|
||||
in later packaging process. For detail please refer to <link linkend='ref-classes-package'>
|
||||
package.bbclass</link>.
|
||||
This directory contains intermediate packaging data that is used later in the packaging process.
|
||||
For more information, see <link linkend='ref-classes-package'>package.bbclass</link>.
|
||||
</para>
|
||||
</section>
|
||||
|
||||
|
|
@ -291,9 +307,9 @@ source POKY_SRC/poky-init-build-env [BUILDDIR]
|
|||
<title><filename class="directory">build/tmp/pstagelogs/</filename></title>
|
||||
|
||||
<para>
|
||||
This directory contains manifest for task based prebuilt. Each manifest is basically
|
||||
a file list for installed files from a given task, which would be useful for later
|
||||
packaging or cleanup process.
|
||||
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>
|
||||
|
||||
|
|
@ -301,62 +317,63 @@ source POKY_SRC/poky-init-build-env [BUILDDIR]
|
|||
<title><filename class="directory">build/tmp/work/</filename></title>
|
||||
|
||||
<para>
|
||||
This directory contains various subdirectories for each architecture, and each package built by BitBake has its own work directory under the appropriate architecture subdirectory. All tasks are executed from this work directory. As an example, the source for a particular package will be unpacked, patched, configured and compiled all within its own work directory.
|
||||
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.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
It is worth considering the structure of a typical work directory. An
|
||||
example is 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>).
|
||||
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>
|
||||
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.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
There are other directories generated within <glossterm><link
|
||||
linkend='var-WORKDIR'>WORKDIR</link></glossterm>. The most important
|
||||
is <glossterm><link linkend='var-WORKDIR'>WORKDIR</link></glossterm><filename class="directory">/temp/</filename> which has log files for each
|
||||
task (<filename>log.do_*.pid</filename>) and the scripts BitBake runs for
|
||||
each task (<filename>run.do_*.pid</filename>). The <glossterm><link
|
||||
linkend='var-WORKDIR'>WORKDIR</link></glossterm><filename
|
||||
class="directory">/image/</filename> directory is where <command>make
|
||||
install</command> places its output which is then split into subpackages
|
||||
within <glossterm><link linkend='var-WORKDIR'>WORKDIR</link></glossterm>
|
||||
<filename class="directory">/packages-split/</filename>.
|
||||
There are other directories generated within WORKDIR.
|
||||
The most important directory is WORKDIR
|
||||
<filename class="directory">/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
|
||||
install" places its output that is then split into sub-packages
|
||||
within WORKDIR<filename class="directory">/packages-split/</filename>.
|
||||
</para>
|
||||
</section>
|
||||
</section>
|
||||
|
||||
<section id='structure-meta'>
|
||||
<title><filename class="directory">meta/</filename> - The Metadata</title>
|
||||
<title>The Metadata - <filename class="directory">meta/</filename></title>
|
||||
|
||||
<para>
|
||||
As mentioned previously, this is the core of Poky. It has several
|
||||
important subdivisions:
|
||||
As mentioned previously, metadata is the core of Poky.
|
||||
Metadata has several important subdivisions:
|
||||
</para>
|
||||
|
||||
<section id='structure-meta-classes'>
|
||||
<title><filename class="directory">meta/classes/</filename></title>
|
||||
|
||||
<para>
|
||||
Contains the <filename class="extension">*.bbclass</filename> files. Class
|
||||
files are used to abstract common code allowing it to be reused by multiple
|
||||
packages. The <filename>base.bbclass</filename> file is inherited by every
|
||||
package. Examples of other important classes are
|
||||
<filename>autotools.bbclass</filename> that in theory allows any
|
||||
Autotool-enabled package to work with Poky with minimal effort, or
|
||||
<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 (<filename>image.bbclass
|
||||
</filename>, <filename>rootfs_*.bbclass</filename> and
|
||||
<filename>package*.bbclass</filename>).
|
||||
This directory contains the <filename class="extension">*.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.
|
||||
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
|
||||
such as <filename>image.bbclass</filename>, <filename>rootfs_*.bbclass</filename> and
|
||||
<filename>package*.bbclass</filename>.
|
||||
</para>
|
||||
</section>
|
||||
|
||||
|
|
@ -364,13 +381,14 @@ source POKY_SRC/poky-init-build-env [BUILDDIR]
|
|||
<title><filename class="directory">meta/conf/</filename></title>
|
||||
|
||||
<para>
|
||||
This is the core set of configuration files which start from
|
||||
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, even
|
||||
<filename>local.conf</filename> is loaded from there!). While
|
||||
<filename>bitbake.conf</filename> sets up the defaults, these can often be
|
||||
overridden by user (<filename>local.conf</filename>), machine or
|
||||
distribution configuration files.
|
||||
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!
|
||||
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.
|
||||
</para>
|
||||
</section>
|
||||
|
||||
|
|
@ -378,10 +396,11 @@ source POKY_SRC/poky-init-build-env [BUILDDIR]
|
|||
<title><filename class="directory">meta/conf/machine/</filename></title>
|
||||
|
||||
<para>
|
||||
Contains all the machine configuration files. If you set MACHINE="spitz", the
|
||||
end result is Poky looking 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, this is the directory to look in.
|
||||
This directory contains all the machine configuration files.
|
||||
If you set MACHINE="spitz", Poky 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.
|
||||
</para>
|
||||
</section>
|
||||
|
||||
|
|
@ -389,12 +408,12 @@ source POKY_SRC/poky-init-build-env [BUILDDIR]
|
|||
<title><filename class="directory">meta/conf/distro/</filename></title>
|
||||
|
||||
<para>
|
||||
Any distribution specific configuration is controlled from here. OpenEmbedded
|
||||
supports multiple distributions of which Poky is one. Poky only contains the
|
||||
Poky distribution so poky.conf is the main file here. This includes the
|
||||
versions and SRCDATES for applications which are configured here. An example of
|
||||
an alternative configuration is poky-bleeding.conf although this mainly inherits
|
||||
its configuration from Poky itself.
|
||||
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.
|
||||
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.
|
||||
</para>
|
||||
</section>
|
||||
|
||||
|
|
@ -402,8 +421,8 @@ source POKY_SRC/poky-init-build-env [BUILDDIR]
|
|||
<title><filename class="directory">meta/recipes-bsp/</filename></title>
|
||||
|
||||
<para>
|
||||
Anything linking to specific hardware or hardware configuration information
|
||||
are placed here, such as uboot, grub, etc.
|
||||
This directory contains anything linking to specific hardware or hardware configuration information
|
||||
such as "uboot" and "grub".
|
||||
</para>
|
||||
</section>
|
||||
|
||||
|
|
@ -411,7 +430,7 @@ source POKY_SRC/poky-init-build-env [BUILDDIR]
|
|||
<title><filename class="directory">meta/recipes-connectivity/</filename></title>
|
||||
|
||||
<para>
|
||||
Libraries and applications related to communication with other devices
|
||||
This directory contains libraries and applications related to communication with other devices.
|
||||
</para>
|
||||
</section>
|
||||
|
||||
|
|
@ -419,7 +438,8 @@ source POKY_SRC/poky-init-build-env [BUILDDIR]
|
|||
<title><filename class="directory">meta/recipes-core/</filename></title>
|
||||
|
||||
<para>
|
||||
What's needed to build a basic working Linux image including commonly used dependencies
|
||||
This directory contains what is needed to build a basic working Linux image
|
||||
including commonly used dependencies.
|
||||
</para>
|
||||
</section>
|
||||
|
||||
|
|
@ -427,7 +447,8 @@ source POKY_SRC/poky-init-build-env [BUILDDIR]
|
|||
<title><filename class="directory">meta/recipes-devtools/</filename></title>
|
||||
|
||||
<para>
|
||||
Tools primarily used by the build system (but can also be used on targets)
|
||||
This directory contains tools that are primarily used by the build system.
|
||||
The tools, however, can also be used on targets.
|
||||
</para>
|
||||
</section>
|
||||
|
||||
|
|
@ -435,8 +456,10 @@ source POKY_SRC/poky-init-build-env [BUILDDIR]
|
|||
<title><filename class="directory">meta/recipes-extended/</filename></title>
|
||||
|
||||
<para>
|
||||
Applications which whilst not essential add features compared to the alternatives in
|
||||
core. May be needed for full tool functionality or LSB compliance.
|
||||
This directory contains non-essential applications that add features compared to the
|
||||
alternatives in core.
|
||||
You might need this directory for full tool functionality or for Linux Standard Base (LSB)
|
||||
compliance.
|
||||
</para>
|
||||
</section>
|
||||
|
||||
|
|
@ -444,7 +467,7 @@ source POKY_SRC/poky-init-build-env [BUILDDIR]
|
|||
<title><filename class="directory">meta/recipes-gnome/</filename></title>
|
||||
|
||||
<para>
|
||||
All things related to the GTK+ application framework
|
||||
This directory contains all things related to the GTK+ application framework.
|
||||
</para>
|
||||
</section>
|
||||
|
||||
|
|
@ -452,7 +475,7 @@ source POKY_SRC/poky-init-build-env [BUILDDIR]
|
|||
<title><filename class="directory">meta/recipes-graphics/</filename></title>
|
||||
|
||||
<para>
|
||||
X and other graphically related system libraries
|
||||
This directory contains X and other graphically related system libraries
|
||||
</para>
|
||||
</section>
|
||||
|
||||
|
|
@ -460,7 +483,8 @@ source POKY_SRC/poky-init-build-env [BUILDDIR]
|
|||
<title><filename class="directory">meta/recipes-kernel/</filename></title>
|
||||
|
||||
<para>
|
||||
The kernel and generic applications/libraries with strong kernel dependencies
|
||||
This directory contains the kernel and generic applications and libraries that
|
||||
have strong kernel dependencies.
|
||||
</para>
|
||||
</section>
|
||||
|
||||
|
|
@ -468,7 +492,7 @@ source POKY_SRC/poky-init-build-env [BUILDDIR]
|
|||
<title><filename class="directory">meta/recipes-multimedia/</filename></title>
|
||||
|
||||
<para>
|
||||
Codecs and support utilties for audio, images and video
|
||||
This directory contains codecs and support utilities for audio, images and video.
|
||||
</para>
|
||||
</section>
|
||||
|
||||
|
|
@ -476,7 +500,7 @@ source POKY_SRC/poky-init-build-env [BUILDDIR]
|
|||
<title><filename class="directory">meta/recipes-qt/</filename></title>
|
||||
|
||||
<para>
|
||||
All things related to the QT application framework
|
||||
This directory contains all things related to the QT application framework.
|
||||
</para>
|
||||
</section>
|
||||
|
||||
|
|
@ -484,7 +508,8 @@ source POKY_SRC/poky-init-build-env [BUILDDIR]
|
|||
<title><filename class="directory">meta/recipes-sato/</filename></title>
|
||||
|
||||
<para>
|
||||
The Sato demo/reference UI/UX, its associated apps and configuration
|
||||
This directory contains the Sato demo/reference UI/UX and its associated applications
|
||||
and configuration data.
|
||||
</para>
|
||||
</section>
|
||||
|
||||
|
|
@ -492,9 +517,10 @@ source POKY_SRC/poky-init-build-env [BUILDDIR]
|
|||
<title><filename class="directory">meta/site/</filename></title>
|
||||
|
||||
<para>
|
||||
Certain autoconf test results cannot be determined when cross compiling since it
|
||||
can't run tests on a live system. This directory therefore contains a list of
|
||||
cached results for various architectures which is passed to autoconf.
|
||||
This directory contains a list of cached results for various architectures.
|
||||
Because certain "autoconf" test results cannot be determined when cross-compiling due to
|
||||
the tests not able to run on a live system, the information in this directory is
|
||||
passed to "autoconf" for the various architectures.
|
||||
</para>
|
||||
</section>
|
||||
</section>
|
||||
|
|
|
|||
Loading…
Reference in New Issue