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/dev-manual/dev-manual-common-tasks.xml
+31 -28
View File
@@ -655,7 +655,7 @@
<filename><ulink url='&YOCTO_DOCS_REF_URL;#var-BBLAYERS'>BBLAYERS</ulink></filename>
variable in your <filename>conf/bblayers.conf</filename> file,
which is found in the
<link linkend='build-directory'>Build Directory</link>.
<ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>.
The following example shows how to enable a layer named
<filename>meta-mylayer</filename>:
<literallayout class='monospaced'>
@@ -1192,7 +1192,7 @@
from within a recipe and using
<filename>EXTRA_IMAGE_FEATURES</filename> from within
your <filename>local.conf</filename> file, which is found in the
<link linkend='build-directory'>Build Directory</link>.
<ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>.
</para>
<para>
@@ -1539,7 +1539,7 @@
<para>
To run the tool, you just need to be in your
<link linkend='build-directory'>Build Directory</link>
<ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>
and have sourced the build environment setup script
(i.e.
<ulink url='&YOCTO_DOCS_REF_URL;#structure-core-script'><filename>oe-init-build-env</filename></ulink>
@@ -2027,7 +2027,7 @@
or
<ulink url='&YOCTO_DOCS_REF_URL;#structure-memres-core-script'><filename>oe-init-build-env-memres</filename></ulink>)
and you are in the
<link linkend='build-directory'>Build Directory</link>,
<ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>,
use BitBake to process your recipe.
All you need to provide is the
<filename><replaceable>basename</replaceable></filename> of the recipe as described
@@ -4238,7 +4238,7 @@
combination of multiple libraries you want to build.
You accomplish this through your <filename>local.conf</filename>
configuration file in the
<link linkend='build-directory'>Build Directory</link>.
<ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>.
An example configuration would be as follows:
<literallayout class='monospaced'>
MACHINE = "qemux86-64"
@@ -4314,7 +4314,7 @@
<listitem><para>A unique architecture is defined for the Multilib packages,
along with creating a unique deploy folder under
<filename>tmp/deploy/rpm</filename> in the
<link linkend='build-directory'>Build Directory</link>.
<ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>.
For example, consider <filename>lib32</filename> in a
<filename>qemux86-64</filename> image.
The possible architectures in the system are "all", "qemux86_64",
@@ -4858,7 +4858,7 @@
or
<ulink url='&YOCTO_DOCS_REF_URL;#structure-memres-core-script'><filename>oe-init-build-env-memres</filename></ulink>)
found in the
<link linkend='build-directory'>Build Directory</link>.
<ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>.
</para></listitem>
</itemizedlist>
</para>
@@ -4948,7 +4948,7 @@
or
<ulink url='&YOCTO_DOCS_REF_URL;#structure-memres-core-script'><filename>oe-init-build-env-memres</filename></ulink>
script found in the
<link linkend='build-directory'>Build Directory</link>.
<ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>.
</para>
<section id='raw-mode'>
@@ -5934,7 +5934,7 @@
or
<ulink url='&YOCTO_DOCS_REF_URL;#structure-memres-core-script'><filename>oe-init-build-env-memres</filename></ulink>
script found in the
<link linkend='build-directory'>Build Directory</link>.
<ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>.
You must also be sure of the state of your build in the
<link linkend='source-directory'>Source Directory</link>.
The following commands run <filename>menuconfig</filename>
@@ -6104,7 +6104,7 @@
placed where the OpenEmbedded build system can find and apply them.
Syntactically, the configuration statement is identical to what would appear
in the <filename>.config</filename> file, which is in the
<link linkend='build-directory'>Build Directory</link>:
<ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>:
<literallayout class='monospaced'>
tmp/work/<replaceable>arch</replaceable>-poky-linux/linux-yocto-<replaceable>release_specific_string</replaceable>/linux-<replaceable>arch</replaceable>-<replaceable>build_type</replaceable>
</literallayout>
@@ -6390,9 +6390,11 @@
machine in a
<link linkend='source-directory'>Source Directory</link>
named <filename>poky</filename>.
Furthermore, the <link linkend='build-directory'>Build Directory</link> is
<filename>build</filename> and is located in <filename>poky</filename> and
the kernel is based on the Linux 3.4 kernel.
Furthermore, the
<ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>
is <filename>build</filename> and is located in
<filename>poky</filename> and the kernel is based on the
Linux 3.4 kernel.
</para>
<para>
@@ -6593,7 +6595,7 @@
<listitem><para><emphasis>Build for the correct target architecture:</emphasis> Your
selected <ulink url='&YOCTO_DOCS_REF_URL;#var-MACHINE'><filename>MACHINE</filename></ulink>
definition within the <filename>local.conf</filename> file in the
<link linkend='build-directory'>Build Directory</link>
<ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>
specifies the target architecture used when building the Linux kernel.
By default, <filename>MACHINE</filename> is set to
<filename>qemux86</filename>, which specifies a 32-bit
@@ -6653,7 +6655,7 @@
Never remove any files by hand from the
<filename>tmp/deploy</filename>
directory inside the
<link linkend='build-directory'>Build Directory</link>.
<ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>.
Always use the various BitBake clean tasks to
clear out previous build artifacts.
For information on the clean tasks, see the
@@ -7018,7 +7020,7 @@
previous bulleted item.</para></listitem>
<listitem><para><emphasis>Point to Your distribution configuration file:</emphasis>
In your <filename>local.conf</filename> file in the
<link linkend='build-directory'>Build Directory</link>,
<ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>,
set your
<ulink url='&YOCTO_DOCS_REF_URL;#var-DISTRO'><filename>DISTRO</filename></ulink>
variable to point to your distribution's configuration file.
@@ -7078,7 +7080,7 @@
<filename>TEMPLATECONF</filename> to locate the directory
from which it gathers configuration information that ultimately
ends up in the
<link linkend='build-directory'>Build Directory's</link>
<ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>
<filename>conf</filename> directory.
By default, <filename>TEMPLATECONF</filename> is set as
follows in the <filename>poky</filename> repository:
@@ -8031,7 +8033,7 @@
setting
<ulink url='&YOCTO_DOCS_REF_URL;#var-PRSERV_HOST'><filename>PRSERV_HOST</filename></ulink>
in your <filename>local.conf</filename> file in the
<ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>:
<ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>:
<literallayout class='monospaced'>
PRSERV_HOST = "localhost:0"
</literallayout>
@@ -8567,7 +8569,7 @@
<listitem><para>
Open the <filename>local.conf</filename> file
inside your
<link linkend='build-directory'>Build Directory</link>
<ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>
(e.g. <filename>~/poky/build/conf/local.conf</filename>).
</para></listitem>
<listitem><para>
@@ -9025,7 +9027,7 @@
and <ulink url='&YOCTO_DOCS_REF_URL;#var-EXTRA_IMAGE_FEATURES'><filename>EXTRA_IMAGE_FEATURES</filename></ulink>
variables to your <filename>local.conf</filename> file,
which is found in the
<link linkend='build-directory'>Build Directory</link>:
<ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>:
<literallayout class='monospaced'>
DISTRO_FEATURES_append = " ptest"
EXTRA_IMAGE_FEATURES += "ptest-pkgs"
@@ -9261,8 +9263,8 @@
<para>
By default, the OpenEmbedded build system uses the
<link linkend='build-directory'>Build Directory</link> when
building source code.
<ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>
when building source code.
The build process involves fetching the source files, unpacking
them, and then patching them if necessary before the build takes
place.
@@ -9626,7 +9628,7 @@
Using either of the following statements in your
image recipe or from within the
<filename>local.conf</filename> file found in the
<link linkend='build-directory'>Build Directory</link>
<ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>
causes the build system to create a read-only root filesystem:
<literallayout class='monospaced'>
IMAGE_FEATURES = "read-only-rootfs"
@@ -10220,7 +10222,7 @@
<ulink url='&YOCTO_DOCS_REF_URL;#var-TEST_IMAGE'><filename>TEST_IMAGE</filename></ulink>
variable to "1" in your <filename>local.conf</filename>
file in the
<ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>:
<ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>:
<literallayout class='monospaced'>
TEST_IMAGE = "1"
</literallayout>
@@ -10352,7 +10354,8 @@
$ bitbake <replaceable>image</replaceable> -c testexport
</literallayout>
Exporting the tests places them in the
<link linkend='build-directory'>Build Directory</link> in
<ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>
in
<filename>tmp/testexport/</filename><replaceable>image</replaceable>,
which is controlled by the
<filename>TEST_EXPORT_DIR</filename> variable.
@@ -11509,7 +11512,7 @@
release just the source as a tarball.
You can do this by adding the following to the
<filename>local.conf</filename> file found in the
<link linkend='build-directory'>Build Directory</link>:
<ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>:
<literallayout class='monospaced'>
INHERIT += "archiver"
ARCHIVER_MODE[src] = "original"
@@ -11724,7 +11727,7 @@
<ulink url='&YOCTO_DOCS_REF_URL;#ref-classes-report-error'><filename>report-error</filename></ulink>
class by adding the following statement to the end of
your <filename>local.conf</filename> file in your
<link linkend='build-directory'>Build Directory</link>.
<ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>.
<literallayout class='monospaced'>
INHERIT += "report-error"
</literallayout>
@@ -11783,7 +11786,7 @@
To disable the error reporting feature, simply remove or comment
out the following statement from the end of your
<filename>local.conf</filename> file in your
<link linkend='build-directory'>Build Directory</link>.
<ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>.
<literallayout class='monospaced'>
INHERIT += "report-error"
</literallayout>
documentation/dev-manual/dev-manual-model.xml
+8 -7
View File
@@ -87,7 +87,8 @@
<note>
For a brief list of terms used when describing the development process in the Yocto Project,
see the "<link linkend='yocto-project-terms'>Yocto Project Terms</link>" section.
see the
"<ulink url='&YOCTO_DOCS_REF_URL;#yocto-project-terms'>Yocto Project Terms</ulink>" section.
</note>
<para>
@@ -431,8 +432,8 @@
The following figure shows the temporary file structure
created on your host system when the build occurs.
This
<link linkend='build-directory'>Build Directory</link> contains all the
source files used during the build.
<ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>
contains all the source files used during the build.
</para>
<para>
@@ -478,7 +479,7 @@
</para></listitem>
<listitem><para><emphasis>Establish the temporary kernel source files</emphasis>:
Temporary kernel source files are kept in the
<link linkend='build-directory'>Build Directory</link>
<ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>
created by the
OpenEmbedded build system when you run BitBake.
If you have never built the kernel in which you are
@@ -1270,7 +1271,7 @@
<listitem><para><emphasis>Find the Source Code:</emphasis>
Temporary source code used by the OpenEmbedded build system
is kept in the
<link linkend='build-directory'>Build Directory</link>.
<ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>.
See the
"<link linkend='finding-the-temporary-source-code'>Finding Temporary Source Code</link>"
section to learn how to locate the directory that has the
@@ -1364,8 +1365,8 @@
experiment a bit to figure out your solution.
After you have initially built the package, you can iteratively
tweak the source code, which is located in the
<link linkend='build-directory'>Build Directory</link>, and then
you can force a re-compile and quickly test your altered code.
<ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>,
and then you can force a re-compile and quickly test your altered code.
Once you settle on a solution, you can then preserve your changes
in the form of patches.
If you are using Quilt for development, see the
documentation/dev-manual/dev-manual-newbie.xml
+2 -2
View File
@@ -526,8 +526,8 @@
<filename>meta/files/common-licenses</filename>.
Once the build completes, the list of all licenses found and used during that build are
kept in the
<link linkend='build-directory'>Build Directory</link> at
<filename>tmp/deploy/licenses</filename>.
<ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>
at <filename>tmp/deploy/licenses</filename>.
</para>
<para>
documentation/dev-manual/dev-manual-qemu.xml
+1 -1
View File
@@ -252,7 +252,7 @@ qemux86" or "qemux86-64".
This example starts QEMU with
<replaceable>MACHINE</replaceable> set to "qemux86".
Assuming a standard
<link linkend='build-directory'>Build Directory</link>,
<ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>,
<filename>runqemu</filename> automatically finds the
<filename>bzImage-qemux86.bin</filename> image file and
the
documentation/dev-manual/dev-manual-start.xml
+1 -1
View File
@@ -309,7 +309,7 @@
</para></listitem>
<listitem><para>Optionally ensure the <filename>conf/local.conf</filename> configuration file,
which is found in the
<link linkend='build-directory'>Build Directory</link>,
<ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>,
is set up how you want it.
This file defines many aspects of the build environment including
the target machine architecture through the