mirrors/poky
1
0
Fork 0
mirror of https://git.yoctoproject.org/poky synced 2026-09-29 07:36:20 +02:00
Code Issues Packages Projects Releases Wiki Activity

bitbake: user-manual-ref-variables.xml: Editing pass.

Browse Source 
Corrected grammar and applied active voice where possible.
Also removed several cross-reference tags to the YP manual set.

(Bitbake rev: 17cbad436c97e904a04596237022e84853b10a21)

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
2014-01-21 17:20:55 -06:00
committed by Richard Purdie
parent d51fb535a6
commit 37ab0888a1
1 changed files with 47 additions and 46 deletions
Download Patch File Download Diff File Expand all files Collapse all files

93
bitbake/doc/user-manual/user-manual-ref-variables.xml
View File

@@ -55,7 +55,7 @@
<glossentry id='var-B'><glossterm>B</glossterm> <glossentry id='var-B'><glossterm>B</glossterm>
<glossdef> <glossdef>
<para> <para>
The directory in which BitBake will execute functions The directory in which BitBake executes functions
during a recipe's build process. during a recipe's build process.
</para> </para>
</glossdef> </glossdef>
@@ -146,7 +146,7 @@
below 1 Gbyte or the available free inodes drops below below 1 Gbyte or the available free inodes drops below
100 Kbytes. 100 Kbytes.
Because two directories are provided with the variable, the Because two directories are provided with the variable, the
build system also issue a build system also issues a
warning when the disk space in the warning when the disk space in the
<filename>${SSTATE_DIR}</filename> directory drops <filename>${SSTATE_DIR}</filename> directory drops
below 1 Gbyte or the number of free inodes drops below 1 Gbyte or the number of free inodes drops
@@ -295,7 +295,7 @@
<para>Lists the names of configured layers. <para>Lists the names of configured layers.
These names are used to find the other <filename>BBFILE_*</filename> These names are used to find the other <filename>BBFILE_*</filename>
variables. variables.
Typically, each layer will append its name to this variable in its Typically, each layer appends its name to this variable in its
<filename>conf/layer.conf</filename> file. <filename>conf/layer.conf</filename> file.
</para> </para>
</glossdef> </glossdef>
@@ -345,7 +345,7 @@
<glossentry id='var-BBFILES'><glossterm>BBFILES</glossterm> <glossentry id='var-BBFILES'><glossterm>BBFILES</glossterm>
<glossdef> <glossdef>
<para>List of recipe files used by BitBake to build software.</para> <para>List of recipe files BitBake uses to build software.</para>
</glossdef> </glossdef>
</glossentry> </glossentry>
@@ -435,8 +435,9 @@
<glossentry id='var-BBPATH'><glossterm>BBPATH</glossterm> <glossentry id='var-BBPATH'><glossterm>BBPATH</glossterm>
<glossdef> <glossdef>
<para> <para>
Used by BitBake to locate Used by BitBake to locate class
<filename>.bbclass</filename> and configuration files. (<filename>.bbclass</filename>) and configuration
(<filename>.conf</filename>) files.
This variable is analogous to the This variable is analogous to the
<filename>PATH</filename> variable. <filename>PATH</filename> variable.
<note> <note>
@@ -645,17 +646,18 @@
<glossentry id='var-LAYERDEPENDS'><glossterm>LAYERDEPENDS</glossterm> <glossentry id='var-LAYERDEPENDS'><glossterm>LAYERDEPENDS</glossterm>
<glossdef> <glossdef>
<para>Lists the layers that this recipe depends upon, separated by spaces. <para>Lists the layers, separated by spaces, upon which this recipe depends.
Optionally, you can specify a specific layer version for a dependency Optionally, you can specify a specific layer version for a dependency
by adding it to the end of the layer name with a colon, (e.g. "anotherlayer:3" by adding it to the end of the layer name with a colon, (e.g. "anotherlayer:3"
to be compared against to be compared against
<link linkend='var-LAYERVERSION'><filename>LAYERVERSION</filename></link><filename>_anotherlayer</filename> <link linkend='var-LAYERVERSION'><filename>LAYERVERSION</filename></link><filename>_anotherlayer</filename>
in this case). in this case).
An error will be produced if any dependency is missing or BitBake produces an error if any dependency is missing or
the version numbers do not match exactly (if specified). the version numbers do not match exactly (if specified).</para>
This variable is used in the <filename>conf/layer.conf</filename> file <para>
and must be suffixed with the name of the specific layer (e.g. You use this variable in the <filename>conf/layer.conf</filename> file.
<filename>LAYERDEPENDS_mylayer</filename>).</para> You must also use the specific layer name as a suffix
to the variable (e.g. <filename>LAYERDEPENDS_mylayer</filename>).</para>
</glossdef> </glossdef>
</glossentry> </glossentry>
@@ -671,13 +673,14 @@
<glossentry id='var-LAYERVERSION'><glossterm>LAYERVERSION</glossterm> <glossentry id='var-LAYERVERSION'><glossterm>LAYERVERSION</glossterm>
<glossdef> <glossdef>
<para>Optionally specifies the version of a layer as a single number. <para>Optionally specifies the version of a layer as a single number.
You can use this within You can use this variable within
<link linkend='var-LAYERDEPENDS'><filename>LAYERDEPENDS</filename></link> <link linkend='var-LAYERDEPENDS'><filename>LAYERDEPENDS</filename></link>
for another layer in order to depend on a specific version for another layer in order to depend on a specific version
of the layer. of the layer.</para>
This variable is used in the <filename>conf/layer.conf</filename> file <para>
and must be suffixed with the name of the specific layer (e.g. You use this variable in the <filename>conf/layer.conf</filename> file.
<filename>LAYERVERSION_mylayer</filename>).</para> You must also use the specific layer name as a suffix
to the variable (e.g. <filename>LAYERDEPENDS_mylayer</filename>).</para>
</glossdef> </glossdef>
</glossentry> </glossentry>
@@ -696,7 +699,7 @@
<glossentry id='var-MIRRORS'><glossterm>MIRRORS</glossterm> <glossentry id='var-MIRRORS'><glossterm>MIRRORS</glossterm>
<glossdef> <glossdef>
<para> <para>
Specifies additional paths from which the BitBake gets source code. Specifies additional paths from which BitBake gets source code.
When the build system searches for source code, it first When the build system searches for source code, it first
tries the local download directory. tries the local download directory.
If that location fails, the build system tries locations If that location fails, the build system tries locations
@@ -732,9 +735,9 @@
what variables are overridden after BitBake parses what variables are overridden after BitBake parses
recipes and configuration files. recipes and configuration files.
You can find more information on how overrides are handled You can find more information on how overrides are handled
in the BitBake Manual that is located at in the
<filename>bitbake/doc/manual</filename> in the "<link linkend='conditional-syntax-overrides'>Conditional Syntax (Overrides)</link>"
<ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>. section.
</para> </para>
</glossdef> </glossdef>
</glossentry> </glossentry>
@@ -744,7 +747,7 @@
<glossentry id='var-PACKAGES'><glossterm>PACKAGES</glossterm> <glossentry id='var-PACKAGES'><glossterm>PACKAGES</glossterm>
<glossdef> <glossdef>
<para>The list of packages to be created from the recipe. <para>The list of packages the recipe creates.
</para> </para>
</glossdef> </glossdef>
</glossentry> </glossentry>
@@ -759,8 +762,8 @@
they should be satisfied. they should be satisfied.
For example, if a hard, runtime dependency For example, if a hard, runtime dependency
(<link linkend='var-RDEPENDS'><filename>RDEPENDS</filename></link>) (<link linkend='var-RDEPENDS'><filename>RDEPENDS</filename></link>)
of another package is satisfied of another package is satisfied during the build
at build time through the <filename>PACKAGES_DYNAMIC</filename> through the <filename>PACKAGES_DYNAMIC</filename>
variable, but a package with the module name is never actually variable, but a package with the module name is never actually
produced, then the other package will be broken. produced, then the other package will be broken.
Thus, if you attempt to include that package in an image, Thus, if you attempt to include that package in an image,
@@ -775,7 +778,7 @@
<para> <para>
The epoch of the recipe. The epoch of the recipe.
By default, this variable is unset. By default, this variable is unset.
The field is used to make upgrades possible when the The variable is used to make upgrades possible when the
versioning scheme changes in some backwards incompatible versioning scheme changes in some backwards incompatible
way. way.
</para> </para>
@@ -831,7 +834,7 @@
variable determines which recipe should be given preference. variable determines which recipe should be given preference.
You must always suffix the variable with the You must always suffix the variable with the
<link linkend='var-PN'><filename>PN</filename></link> <link linkend='var-PN'><filename>PN</filename></link>
you want to select, and you should set the you want to select, and you should set
<link linkend='var-PV'><filename>PV</filename></link> <link linkend='var-PV'><filename>PV</filename></link>
accordingly for precedence. accordingly for precedence.
You can use the "<filename>%</filename>" character as a You can use the "<filename>%</filename>" character as a
@@ -870,7 +873,7 @@
</para> </para>
<para> <para>
Typically, you could add a specific server for the Typically, you would add a specific server for the
build system to attempt before any others by adding build system to attempt before any others by adding
something like the following to your configuration: something like the following to your configuration:
<literallayout class='monospaced'> <literallayout class='monospaced'>
@@ -915,14 +918,13 @@
</para> </para>
<para> <para>
An example of how the <filename>PRSERV_HOST</filename> variable is Following is an example of how the <filename>PRSERV_HOST</filename> variable is
set: set:
<literallayout class='monospaced'> <literallayout class='monospaced'>
PRSERV_HOST = "localhost:0" PRSERV_HOST = "localhost:0"
</literallayout> </literallayout>
You must set the variable if you want to automatically You must set the variable if you want to automatically
start a local start a local PR service.
<ulink url='&YOCTO_DOCS_DEV_URL;#working-with-a-pr-service'>PR service</ulink>.
You can set <filename>PRSERV_HOST</filename> to other You can set <filename>PRSERV_HOST</filename> to other
values to use a remote PR service. values to use a remote PR service.
</para> </para>
@@ -1083,18 +1085,18 @@
to pull in for the build and how to pull them in. to pull in for the build and how to pull them in.
For example, if the recipe or append file only needs to For example, if the recipe or append file only needs to
fetch a tarball from the Internet, the recipe or fetch a tarball from the Internet, the recipe or
append file uses a single <filename>SRC_URI</filename> append file uses a <filename>SRC_URI</filename>
entry. entry that specifies just the tarball.
On the other hand, if the recipe or append file needs to On the other hand, if the recipe or append file needs to
fetch a tarball, apply two patches, and include a custom fetch a tarball, apply two patches, and include a custom
file, the recipe or append file would include four file, the recipe or append file needs an
instances of the variable.</para> <filename>SRC_URI</filename> variable that specifies all
those sources.</para>
<para>The following list explains the available URI protocols: <para>The following list explains the available URI protocols:
<itemizedlist> <itemizedlist>
<listitem><para><emphasis><filename>file://</filename> -</emphasis> <listitem><para><emphasis><filename>file://</filename> -</emphasis>
Fetches files, which are usually files shipped with Fetches files, which are usually files shipped with
the the metadata,
<ulink url='&YOCTO_DOCS_DEV_URL;#metadata'>Metadata</ulink>,
from the local machine. from the local machine.
The path is relative to the The path is relative to the
<link linkend='var-FILESPATH'><filename>FILESPATH</filename></link> <link linkend='var-FILESPATH'><filename>FILESPATH</filename></link>
@@ -1116,7 +1118,7 @@
any special package name suffix. any special package name suffix.
</para></listitem> </para></listitem>
<listitem><para><emphasis>files -</emphasis> <listitem><para><emphasis>files -</emphasis>
Files within a directory, which is named Files within a directory that is named
<filename>files</filename> and is also <filename>files</filename> and is also
alongside the recipe or append file. alongside the recipe or append file.
</para></listitem> </para></listitem>
@@ -1144,11 +1146,11 @@
<listitem><para><emphasis><filename>svk://</filename> -</emphasis> Fetches files from <listitem><para><emphasis><filename>svk://</filename> -</emphasis> Fetches files from
an SVK revision control repository.</para></listitem> an SVK revision control repository.</para></listitem>
<listitem><para><emphasis><filename>http://</filename> -</emphasis> Fetches files from <listitem><para><emphasis><filename>http://</filename> -</emphasis> Fetches files from
the Internet using <filename>http</filename>.</para></listitem> the Internet using HTTP.</para></listitem>
<listitem><para><emphasis><filename>https://</filename> -</emphasis> Fetches files <listitem><para><emphasis><filename>https://</filename> -</emphasis> Fetches files
from the Internet using <filename>https</filename>.</para></listitem> from the Internet using HTTPS.</para></listitem>
<listitem><para><emphasis><filename>ftp://</filename> -</emphasis> Fetches files <listitem><para><emphasis><filename>ftp://</filename> -</emphasis> Fetches files
from the Internet using <filename>ftp</filename>.</para></listitem> from the Internet using FTP.</para></listitem>
<listitem><para><emphasis><filename>cvs://</filename> -</emphasis> Fetches files from <listitem><para><emphasis><filename>cvs://</filename> -</emphasis> Fetches files from
a CVS revision control repository.</para></listitem> a CVS revision control repository.</para></listitem>
<listitem><para><emphasis><filename>hg://</filename> -</emphasis> Fetches files from <listitem><para><emphasis><filename>hg://</filename> -</emphasis> Fetches files from
@@ -1240,9 +1242,8 @@
<glossdef> <glossdef>
<para> <para>
The revision of the source code used to build the package. The revision of the source code used to build the package.
This variable applies to Subversion, Git, Mercurial and Bazaar This variable applies only when using Subversion, Git, Mercurial and Bazaar.
only. If you want to build a fixed revision and you want
Note that if you wish to build a fixed revision and you wish
to avoid performing a query on the remote repository every time to avoid performing a query on the remote repository every time
BitBake parses your recipe, you should specify a <filename>SRCREV</filename> that is a BitBake parses your recipe, you should specify a <filename>SRCREV</filename> that is a
full revision identifier and not just a tag. full revision identifier and not just a tag.
@@ -1263,7 +1264,7 @@
<glossentry id='var-SUMMARY'><glossterm>SUMMARY</glossterm> <glossentry id='var-SUMMARY'><glossterm>SUMMARY</glossterm>
<glossdef> <glossdef>
<para> <para>
A short (72 characters or less) summary for the recipe. A short summary for the recipe, which is 72 characters or less.
</para> </para>
</glossdef> </glossdef>
</glossentry> </glossentry>
@@ -1274,7 +1275,7 @@
<glossentry id='var-T'><glossterm>T</glossterm> <glossentry id='var-T'><glossterm>T</glossterm>
<glossdef> <glossdef>
<para>This variable points to a directory were BitBake places <para>Points to a directory were BitBake places
temporary files, which consist mostly of task logs and temporary files, which consist mostly of task logs and
scripts, when building a particular recipe. scripts, when building a particular recipe.
</para> </para>
@@ -1284,7 +1285,7 @@
<glossentry id='var-TOPDIR'><glossterm>TOPDIR</glossterm> <glossentry id='var-TOPDIR'><glossterm>TOPDIR</glossterm>
<glossdef> <glossdef>
<para> <para>
This variable points to the Points to the
<ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>.
BitBake automatically sets this variable. BitBake automatically sets this variable.
</para> </para>