mirrors/poky
1
0
Fork 0
mirror of https://git.yoctoproject.org/poky synced 2026-05-30 00:20:08 +00:00
Code Issues Projects Releases Wiki Activity

documentation: Fixed links for "build-directory" term.

Browse Source 
Fixes [YOCTO #11630]

Moving the "Yocto Project Terms" section from the dev-manual to the
ref-manual broke several links to the id "build-directory".  I fixed
these to reference into the ref-manual now.

(From yocto-docs rev: debe2ae8ce203ebe0f1cee0de54124c15df8bb7e)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
Scott Rifenbark
2017-06-13 17:47:10 -07:00
committed by Richard Purdie
parent b8b87dd690
commit 74bf586c94
24 changed files with 117 additions and 108 deletions
Download Patch File Download Diff File Expand all files Collapse all files
documentation/ref-manual/closer-look.xml
+5 -5
View File
@@ -114,7 +114,7 @@
<para>
Sourcing the build environment script creates a
<ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>
<link linkend='build-directory'>Build Directory</link>
if one does not already exist.
BitBake uses the Build Directory for all its work during builds.
The Build Directory has a <filename>conf</filename> directory that
@@ -641,7 +641,7 @@
<para>
When the OpenEmbedded build system generates an image or an SDK,
it gets the packages from a package feed area located in the
<ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>.
<link linkend='build-directory'>Build Directory</link>.
The
<link linkend='general-yocto-environment-figure'>general Yocto Project Development Environment figure</link>
shows this package feeds area in the upper-right corner.
@@ -770,7 +770,7 @@
depend on it are re-executed.
</note>
By default, everything is accomplished in the
<ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>,
<link linkend='build-directory'>Build Directory</link>,
which has a defined structure.
For additional general information on the Build Directory,
see the
@@ -1430,7 +1430,7 @@
<para>
Images are written out to the
<ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>
<link linkend='build-directory'>Build Directory</link>
inside the <filename>tmp/deploy/images/<replaceable>machine</replaceable>/</filename>
folder as shown in the figure.
This folder contains any files expected to be loaded on the
@@ -1545,7 +1545,7 @@
<para>
Once built, the SDK installers are written out to the
<filename>deploy/sdk</filename> folder inside the
<ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>
<link linkend='build-directory'>Build Directory</link>
as shown in the figure at the beginning of this section.
Depending on the type of SDK, several variables exist that help
configure these files.
documentation/ref-manual/faq.xml
+3 -2
View File
@@ -702,7 +702,8 @@
<link linkend='structure-core-script'><filename>&OE_INIT_FILE;</filename></link>
or
<link linkend='structure-memres-core-script'><filename>oe-init-build-env-memres</filename></link>).
By default, this <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>
By default, this
<link linkend='build-directory'>Build Directory</link>
is named <filename>build</filename> but can be named
anything you want.
</para>
@@ -765,7 +766,7 @@
<para>
Meanwhile, <filename>DESTDIR</filename> is a path within the
<ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>.
<link linkend='build-directory'>Build Directory</link>.
However, when the recipe builds a native program (i.e. one
that is intended to run on the build machine), that program
is never installed directly to the build machine's root
documentation/ref-manual/introduction.xml
+1 -1
View File
@@ -953,7 +953,7 @@
<filename>.sh</filename> file that installs
the tools in the <filename>tmp/deploy/sdk</filename>
subdirectory of the
<ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>.
<link linkend='build-directory'>Build Directory</link>.
The installer file has the string "buildtools"
in the name.
</para></listitem>
documentation/ref-manual/migration.xml
+1 -1
View File
@@ -821,7 +821,7 @@
<listitem><para>
When buildhistory is enabled, its output is now written
under the
<ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>
<link linkend='build-directory'>Build Directory</link>
rather than
<link linkend='var-TMPDIR'><filename>TMPDIR</filename></link>.
Doing so makes it easier to delete
documentation/ref-manual/ref-classes.xml
+2 -2
View File
@@ -2393,7 +2393,7 @@ This check was removed for YP 2.3 release
<filename><link linkend='var-PACKAGE_CLASSES'>PACKAGE_CLASSES</link></filename>
variable defined in your <filename>conf/local.conf</filename>
configuration file, which is located in the
<ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>.
<link linkend='build-directory'>Build Directory</link>.
When defining the variable, you can specify one or more package types.
Since images are generated from packages, a packaging class is
needed to enable image generation.
@@ -2988,7 +2988,7 @@ This check was removed for YP 2.3 release
as the build progresses, you can enable <filename>rm_work</filename>
by adding the following to your <filename>local.conf</filename> file,
which is found in the
<ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>.
<link linkend='build-directory'>Build Directory</link>.
<literallayout class='monospaced'>
INHERIT += "rm_work"
</literallayout>
documentation/ref-manual/ref-devtool-reference.xml
+1 -1
View File
@@ -573,7 +573,7 @@
<para>
Use the <filename>devtool create-workspace</filename> command to
create a new workspace layer in your
<ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>.
<link linkend='build-directory'>Build Directory</link>.
When you create a new workspace layer, it is populated with the
<filename>README</filename> file and the
<filename>conf</filename> directory only.
documentation/ref-manual/ref-structure.xml
+7 -6
View File
@@ -75,7 +75,8 @@
This directory contains user configuration files and the output
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>
The
<link linkend='build-directory'>Build Directory</link>
is created initially when you <filename>source</filename>
the OpenEmbedded build environment setup script
(i.e.
@@ -212,7 +213,7 @@
<para>
When you run this script, your Yocto Project environment is set
up, a
<ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>
<link linkend='build-directory'>Build Directory</link>
is created, your working directory becomes the Build Directory,
and you are presented with a list of common BitBake targets.
Here is an example:
@@ -246,7 +247,7 @@
<para>
By default, running this script without a
<ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>
<link linkend='build-directory'>Build Directory</link>
argument creates the <filename>build</filename> directory
in your current working directory.
If you provide a Build Directory argument when you
@@ -330,7 +331,7 @@
<listitem><para>
The script's parameters are positionally dependent.
Consequently, you cannot run the script and provide a
<ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>
<link linkend='build-directory'>Build Directory</link>
name without also providing a port number.
In other words, the following syntax is illegal:
<literallayout class='monospaced'>
@@ -386,7 +387,7 @@
<para>
By default, running this script without a
<ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>
<link linkend='build-directory'>Build Directory</link>
argument creates a build directory named
<filename>build</filename>.
If you provide a Build Directory argument and port number when you
@@ -443,7 +444,7 @@
<para>
The OpenEmbedded build system creates the
<ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>
<link linkend='build-directory'>Build Directory</link>
when you run one of the build environment setup scripts (i.e.
<link linkend='structure-core-script'><filename>&OE_INIT_FILE;</filename></link>
or
documentation/ref-manual/ref-variables.xml
+29 -27
View File
@@ -536,7 +536,7 @@
<para role="glossdeffirst">
<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
The directory within the
<ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>
<link linkend='build-directory'>Build Directory</link>
in which the OpenEmbedded build system places generated
objects during a recipe's build process.
By default, this directory is the same as the <link linkend='var-S'><filename>S</filename></link>
@@ -734,7 +734,7 @@
variable to "1", "yes", or "true"
in your <filename>local.conf</filename> file, which is
located in the
<ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>:
<link linkend='build-directory'>Build Directory</link>:
Here is an example:
<literallayout class='monospaced'>
BB_DANGLINGAPPENDS_WARNONLY = "1"
@@ -759,7 +759,7 @@
Disk space monitoring is disabled by default.
To enable monitoring, add the <filename>BB_DISKMON_DIRS</filename>
variable to your <filename>conf/local.conf</filename> file found in the
<ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>.
<link linkend='build-directory'>Build Directory</link>.
Use the following form:
<literallayout class='monospaced'>
BB_DISKMON_DIRS = "<replaceable>action</replaceable>,<replaceable>dir</replaceable>,<replaceable>threshold</replaceable> [...]"
@@ -852,7 +852,7 @@
Defines the disk space and free inode warning intervals.
To set these intervals, define the variable in your
<filename>conf/local.conf</filename> file in the
<ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>.
<link linkend='build-directory'>Build Directory</link>.
</para>
<para>
@@ -936,7 +936,7 @@
</literallayout>
Set this variable in your <filename>local.conf</filename>
file in the
<ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>.
<link linkend='build-directory'>Build Directory</link>.
</para>
</glossdef>
</glossentry>
@@ -1154,7 +1154,8 @@
<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
Lists the layers to enable during the build.
This variable is defined in the <filename>bblayers.conf</filename> configuration
file in the <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>.
file in the
<link linkend='build-directory'>Build Directory</link>.
Here is an example:
<literallayout class='monospaced'>
BBLAYERS = " \
@@ -1250,7 +1251,7 @@
BBMULTIFONFIG = "configA configB configC"
</literallayout>
Each configuration file you use must reside in the
<ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory's</ulink>
<link linkend='build-directory'>Build Directory</link>
<filename>conf/multiconfig</filename> directory
(e.g.
<replaceable>build_directory</replaceable><filename>/conf/multiconfig/configA.conf</filename>).
@@ -1280,7 +1281,7 @@
<filename>PATH</filename> variable.
<note>
If you run BitBake from a directory outside of the
<ulink url='&YOCTO_DOCS_DEV_URL;build-directory'>Build Directory</ulink>,
<link linkend='build-directory'>Build Directory</link>,
you must be sure to set
<filename>BBPATH</filename> to point to the
Build Directory.
@@ -1626,7 +1627,7 @@
<para role="glossdeffirst">
<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
Points to the location of the
<ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>.
<link linkend='build-directory'>Build Directory</link>.
You can define this directory indirectly through the
<link linkend='structure-core-script'><filename>&OE_INIT_FILE;</filename></link>
and
@@ -2595,7 +2596,7 @@
You should only set this variable in the
<filename>local.conf</filename> configuration file found
in the
<ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>.
<link linkend='build-directory'>Build Directory</link>.
</para>
<para>
@@ -2805,7 +2806,8 @@
<para role="glossdeffirst">
<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
The destination directory.
The location in the <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>
The location in the
<link linkend='build-directory'>Build Directory</link>
where components are installed by the
<link linkend='ref-tasks-install'><filename>do_install</filename></link>
task.
@@ -3116,7 +3118,7 @@
system uses to place images, packages, SDKs and other output
files that are ready to be used outside of the build system.
By default, this directory resides within the
<ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>
<link linkend='build-directory'>Build Directory</link>
as <filename>${TMPDIR}/deploy</filename>.
</para>
@@ -3189,7 +3191,7 @@
The directory is machine-specific as it contains the
<filename>${MACHINE}</filename> name.
By default, this directory resides within the
<ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>
<link linkend='build-directory'>Build Directory</link>
as <filename>${DEPLOY_DIR}/images/${MACHINE}/</filename>.
</para>
@@ -3794,7 +3796,7 @@
to touch it.
By default, the directory is <filename>downloads</filename>
in the
<ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>.
<link linkend='build-directory'>Build Directory</link>.
<literallayout class='monospaced'>
#DL_DIR ?= "${TOPDIR}/downloads"
</literallayout>
@@ -4191,7 +4193,7 @@
<para>
Typically, you configure this variable in your
<filename>local.conf</filename> file, which is found in the
<ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>.
<link linkend='build-directory'>Build Directory</link>.
Although you can use this variable from within a recipe,
best practices dictate that you do not.
<note>
@@ -4761,7 +4763,7 @@
<para>
You define the <filename>FILESYSTEM_PERMS_TABLES</filename> variable in the
<filename>conf/local.conf</filename> file, which is found in the
<ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>, to
<link linkend='build-directory'>Build Directory</link>, to
point to your custom <filename>fs-perms.txt</filename>.
You can specify more than a single file permissions setting table.
The paths you specify to these files must be defined within the
@@ -5613,7 +5615,7 @@
Typically, you configure this variable in an image recipe.
Although you can use this variable from your
<filename>local.conf</filename> file, which is found in the
<ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>,
<link linkend='build-directory'>Build Directory</link>,
best practices dictate that you do not.
<note>
To enable extra features from outside the image recipe,
@@ -6562,7 +6564,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
The combined binary is deposited into the
<filename>tmp/deploy</filename> directory, which is part
of the
<ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>.
<link linkend='build-directory'>Build Directory</link>.
</para>
<para>
@@ -7941,7 +7943,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
Specifies the target device for which the image is built.
You define <filename>MACHINE</filename> in the
<filename>local.conf</filename> file found in the
<ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>.
<link linkend='build-directory'>Build Directory</link>.
By default, <filename>MACHINE</filename> is set to
"qemux86", which is an x86-based architecture machine to
be emulated using QEMU:
@@ -9085,7 +9087,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
This variable, which is set in the
<filename>local.conf</filename> configuration file found in
the <filename>conf</filename> folder of the
<ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>,
<link linkend='build-directory'>Build Directory</link>,
specifies the package manager the OpenEmbedded build system
uses when packaging data.
</para>
@@ -10531,7 +10533,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
build system to attempt before any others by adding
something like the following to the
<filename>local.conf</filename> configuration file in the
<ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>:
<link linkend='build-directory'>Build Directory</link>:
<literallayout class='monospaced'>
PREMIRRORS_prepend = "\
git://.*/.* http://www.yoctoproject.org/sources/ \n \
@@ -11493,7 +11495,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
<para role="glossdeffirst">
<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
The location in the
<ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>
<link linkend='build-directory'>Build Directory</link>
where unpacked recipe source code resides.
By default, this directory is
<filename>${</filename><link linkend='var-WORKDIR'><filename>WORKDIR</filename></link><filename>}/${</filename><link linkend='var-BPN'><filename>BPN</filename></link><filename>}-${</filename><link linkend='var-PV'><filename>PV</filename></link><filename>}</filename>,
@@ -12411,7 +12413,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
To enable file removal, set the variable to "1" in your
<filename>conf/local.conf</filename> configuration file
in your:
<ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>.
<link linkend='build-directory'>Build Directory</link>.
<literallayout class='monospaced'>
SKIP_FILEDEPS = "1"
</literallayout>
@@ -14263,7 +14265,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
The suffix identifies the <filename>libc</filename> variant
for building.
When you are building for multiple variants with the same
<ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>,
<link linkend='build-directory'>Build Directory</link>,
this mechanism ensures that output for different
<filename>libc</filename> variants is kept separate to
avoid potential conflicts.
@@ -14421,7 +14423,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
<filename>ssh</filename>.
You can set this variable to "1" in your
<filename>local.conf</filename> file in the
<ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>
<link linkend='build-directory'>Build Directory</link>
to have the OpenEmbedded build system automatically run
these tests after an image successfully builds:
<literallayout class='monospaced'>
@@ -14789,7 +14791,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
files (other than the shared state cache).
By default, the <filename>TMPDIR</filename> variable points
to <filename>tmp</filename> within the
<ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>.
<link linkend='build-directory'>Build Directory</link>.
</para>
<para>
@@ -14924,7 +14926,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
<para role="glossdeffirst">
<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
The top-level
<ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>.
<link linkend='build-directory'>Build Directory</link>.
BitBake automatically sets this variable when you
initialize your build environment using either
<link linkend='structure-core-script'><filename>&OE_INIT_FILE;</filename></link>
documentation/ref-manual/technical-details.xml
+2 -2
View File
@@ -172,7 +172,7 @@
distribution configuration options, compiler tuning options, general common configuration
options, and user configuration options in <filename>local.conf</filename>, which is found
in the
<ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>.
<link linkend='build-directory'>Build Directory</link>.
</para>
</section>
</section>
@@ -562,7 +562,7 @@
code.
However, there is still the question of a task's indirect inputs - the
things that were already built and present in the
<ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>.
<link linkend='build-directory'>Build Directory</link>.
The checksum (or signature) for a particular task needs to add the hashes
of all the tasks on which the particular task depends.
Choosing which dependencies to add is a policy decision.
documentation/ref-manual/usingpoky.xml
+7 -6
View File
@@ -56,7 +56,8 @@
<para>
The <replaceable>build_dir</replaceable> argument is optional and specifies the directory the
OpenEmbedded build system uses for the build -
the <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>.
the
<link linkend='build-directory'>Build Directory</link>.
If you do not specify a Build Directory, it defaults to a directory
named <filename>build</filename> in your current working directory.
A common practice is to use a different Build Directory for different targets.
@@ -142,7 +143,7 @@
<para>
Once an image has been built, it often needs to be installed.
The images and kernels built by the OpenEmbedded build system are placed in the
<ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> in
<link linkend='build-directory'>Build Directory</link> in
<filename class="directory">tmp/deploy/images</filename>.
For information on how to run pre-built images such as <filename>qemux86</filename>
and <filename>qemuarm</filename>, see the
@@ -978,7 +979,7 @@
Removing
<link linkend='var-TMPDIR'><filename>TMPDIR</filename></link>
(usually <filename>tmp/</filename>, within the
<ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>)
<link linkend='build-directory'>Build Directory</link>)
can often fix temporary build issues.
Removing <filename>TMPDIR</filename> is usually a
relatively cheap operation, because task output will be
@@ -1101,7 +1102,7 @@
<link linkend='var-BUILDHISTORY_COMMIT'><filename>BUILDHISTORY_COMMIT</filename></link>
variable to "1" at the end of your
<filename>conf/local.conf</filename> file found in the
<ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>:
<link linkend='build-directory'>Build Directory</link>:
<literallayout class='monospaced'>
INHERIT += "buildhistory"
BUILDHISTORY_COMMIT = "1"
@@ -1359,7 +1360,7 @@
you can enable writing only image information without
any history by adding the following to your
<filename>conf/local.conf</filename> file found in the
<ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>:
<link linkend='build-directory'>Build Directory</link>:
<literallayout class='monospaced'>
INHERIT += "buildhistory"
BUILDHISTORY_COMMIT = "0"
@@ -1645,7 +1646,7 @@
<filename>sync()</filename> calls into the
file system on the principle that if there was a significant
failure, the
<ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>
<link linkend='build-directory'>Build Directory</link>
contents could easily be rebuilt.
</para></listitem>
<listitem><para>