summaryrefslogtreecommitdiffstats
path: root/documentation/dev-manual/dev-manual-common-tasks.xml
diff options
context:
space:
mode:
authorScott Rifenbark <srifenbark@gmail.com>2017-06-13 17:47:10 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2017-06-22 09:16:42 +0100
commit74bf586c940d20fc5546a60a290545c7c0edecb0 (patch)
tree5887ef777422efab49cc0ff37de17cd736faa242 /documentation/dev-manual/dev-manual-common-tasks.xml
parentb8b87dd690ef2f828c21937ec82c2d1dab405734 (diff)
downloadpoky-74bf586c940d20fc5546a60a290545c7c0edecb0.tar.gz
documentation: Fixed links for "build-directory" term.
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>
Diffstat (limited to 'documentation/dev-manual/dev-manual-common-tasks.xml')
-rw-r--r--documentation/dev-manual/dev-manual-common-tasks.xml59
1 files changed, 31 insertions, 28 deletions
diff --git a/documentation/dev-manual/dev-manual-common-tasks.xml b/documentation/dev-manual/dev-manual-common-tasks.xml
index 4a7306fb24..d73b663250 100644
--- a/documentation/dev-manual/dev-manual-common-tasks.xml
+++ b/documentation/dev-manual/dev-manual-common-tasks.xml
@@ -655,7 +655,7 @@
655 <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-BBLAYERS'>BBLAYERS</ulink></filename> 655 <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-BBLAYERS'>BBLAYERS</ulink></filename>
656 variable in your <filename>conf/bblayers.conf</filename> file, 656 variable in your <filename>conf/bblayers.conf</filename> file,
657 which is found in the 657 which is found in the
658 <link linkend='build-directory'>Build Directory</link>. 658 <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>.
659 The following example shows how to enable a layer named 659 The following example shows how to enable a layer named
660 <filename>meta-mylayer</filename>: 660 <filename>meta-mylayer</filename>:
661 <literallayout class='monospaced'> 661 <literallayout class='monospaced'>
@@ -1192,7 +1192,7 @@
1192 from within a recipe and using 1192 from within a recipe and using
1193 <filename>EXTRA_IMAGE_FEATURES</filename> from within 1193 <filename>EXTRA_IMAGE_FEATURES</filename> from within
1194 your <filename>local.conf</filename> file, which is found in the 1194 your <filename>local.conf</filename> file, which is found in the
1195 <link linkend='build-directory'>Build Directory</link>. 1195 <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>.
1196 </para> 1196 </para>
1197 1197
1198 <para> 1198 <para>
@@ -1539,7 +1539,7 @@
1539 1539
1540 <para> 1540 <para>
1541 To run the tool, you just need to be in your 1541 To run the tool, you just need to be in your
1542 <link linkend='build-directory'>Build Directory</link> 1542 <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>
1543 and have sourced the build environment setup script 1543 and have sourced the build environment setup script
1544 (i.e. 1544 (i.e.
1545 <ulink url='&YOCTO_DOCS_REF_URL;#structure-core-script'><filename>oe-init-build-env</filename></ulink> 1545 <ulink url='&YOCTO_DOCS_REF_URL;#structure-core-script'><filename>oe-init-build-env</filename></ulink>
@@ -2027,7 +2027,7 @@
2027 or 2027 or
2028 <ulink url='&YOCTO_DOCS_REF_URL;#structure-memres-core-script'><filename>oe-init-build-env-memres</filename></ulink>) 2028 <ulink url='&YOCTO_DOCS_REF_URL;#structure-memres-core-script'><filename>oe-init-build-env-memres</filename></ulink>)
2029 and you are in the 2029 and you are in the
2030 <link linkend='build-directory'>Build Directory</link>, 2030 <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>,
2031 use BitBake to process your recipe. 2031 use BitBake to process your recipe.
2032 All you need to provide is the 2032 All you need to provide is the
2033 <filename><replaceable>basename</replaceable></filename> of the recipe as described 2033 <filename><replaceable>basename</replaceable></filename> of the recipe as described
@@ -4238,7 +4238,7 @@
4238 combination of multiple libraries you want to build. 4238 combination of multiple libraries you want to build.
4239 You accomplish this through your <filename>local.conf</filename> 4239 You accomplish this through your <filename>local.conf</filename>
4240 configuration file in the 4240 configuration file in the
4241 <link linkend='build-directory'>Build Directory</link>. 4241 <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>.
4242 An example configuration would be as follows: 4242 An example configuration would be as follows:
4243 <literallayout class='monospaced'> 4243 <literallayout class='monospaced'>
4244 MACHINE = "qemux86-64" 4244 MACHINE = "qemux86-64"
@@ -4314,7 +4314,7 @@
4314 <listitem><para>A unique architecture is defined for the Multilib packages, 4314 <listitem><para>A unique architecture is defined for the Multilib packages,
4315 along with creating a unique deploy folder under 4315 along with creating a unique deploy folder under
4316 <filename>tmp/deploy/rpm</filename> in the 4316 <filename>tmp/deploy/rpm</filename> in the
4317 <link linkend='build-directory'>Build Directory</link>. 4317 <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>.
4318 For example, consider <filename>lib32</filename> in a 4318 For example, consider <filename>lib32</filename> in a
4319 <filename>qemux86-64</filename> image. 4319 <filename>qemux86-64</filename> image.
4320 The possible architectures in the system are "all", "qemux86_64", 4320 The possible architectures in the system are "all", "qemux86_64",
@@ -4858,7 +4858,7 @@
4858 or 4858 or
4859 <ulink url='&YOCTO_DOCS_REF_URL;#structure-memres-core-script'><filename>oe-init-build-env-memres</filename></ulink>) 4859 <ulink url='&YOCTO_DOCS_REF_URL;#structure-memres-core-script'><filename>oe-init-build-env-memres</filename></ulink>)
4860 found in the 4860 found in the
4861 <link linkend='build-directory'>Build Directory</link>. 4861 <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>.
4862 </para></listitem> 4862 </para></listitem>
4863 </itemizedlist> 4863 </itemizedlist>
4864 </para> 4864 </para>
@@ -4948,7 +4948,7 @@
4948 or 4948 or
4949 <ulink url='&YOCTO_DOCS_REF_URL;#structure-memres-core-script'><filename>oe-init-build-env-memres</filename></ulink> 4949 <ulink url='&YOCTO_DOCS_REF_URL;#structure-memres-core-script'><filename>oe-init-build-env-memres</filename></ulink>
4950 script found in the 4950 script found in the
4951 <link linkend='build-directory'>Build Directory</link>. 4951 <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>.
4952 </para> 4952 </para>
4953 4953
4954 <section id='raw-mode'> 4954 <section id='raw-mode'>
@@ -5934,7 +5934,7 @@
5934 or 5934 or
5935 <ulink url='&YOCTO_DOCS_REF_URL;#structure-memres-core-script'><filename>oe-init-build-env-memres</filename></ulink> 5935 <ulink url='&YOCTO_DOCS_REF_URL;#structure-memres-core-script'><filename>oe-init-build-env-memres</filename></ulink>
5936 script found in the 5936 script found in the
5937 <link linkend='build-directory'>Build Directory</link>. 5937 <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>.
5938 You must also be sure of the state of your build in the 5938 You must also be sure of the state of your build in the
5939 <link linkend='source-directory'>Source Directory</link>. 5939 <link linkend='source-directory'>Source Directory</link>.
5940 The following commands run <filename>menuconfig</filename> 5940 The following commands run <filename>menuconfig</filename>
@@ -6104,7 +6104,7 @@
6104 placed where the OpenEmbedded build system can find and apply them. 6104 placed where the OpenEmbedded build system can find and apply them.
6105 Syntactically, the configuration statement is identical to what would appear 6105 Syntactically, the configuration statement is identical to what would appear
6106 in the <filename>.config</filename> file, which is in the 6106 in the <filename>.config</filename> file, which is in the
6107 <link linkend='build-directory'>Build Directory</link>: 6107 <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>:
6108 <literallayout class='monospaced'> 6108 <literallayout class='monospaced'>
6109 tmp/work/<replaceable>arch</replaceable>-poky-linux/linux-yocto-<replaceable>release_specific_string</replaceable>/linux-<replaceable>arch</replaceable>-<replaceable>build_type</replaceable> 6109 tmp/work/<replaceable>arch</replaceable>-poky-linux/linux-yocto-<replaceable>release_specific_string</replaceable>/linux-<replaceable>arch</replaceable>-<replaceable>build_type</replaceable>
6110 </literallayout> 6110 </literallayout>
@@ -6390,9 +6390,11 @@
6390 machine in a 6390 machine in a
6391 <link linkend='source-directory'>Source Directory</link> 6391 <link linkend='source-directory'>Source Directory</link>
6392 named <filename>poky</filename>. 6392 named <filename>poky</filename>.
6393 Furthermore, the <link linkend='build-directory'>Build Directory</link> is 6393 Furthermore, the
6394 <filename>build</filename> and is located in <filename>poky</filename> and 6394 <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>
6395 the kernel is based on the Linux 3.4 kernel. 6395 is <filename>build</filename> and is located in
6396 <filename>poky</filename> and the kernel is based on the
6397 Linux 3.4 kernel.
6396 </para> 6398 </para>
6397 6399
6398 <para> 6400 <para>
@@ -6593,7 +6595,7 @@
6593 <listitem><para><emphasis>Build for the correct target architecture:</emphasis> Your 6595 <listitem><para><emphasis>Build for the correct target architecture:</emphasis> Your
6594 selected <ulink url='&YOCTO_DOCS_REF_URL;#var-MACHINE'><filename>MACHINE</filename></ulink> 6596 selected <ulink url='&YOCTO_DOCS_REF_URL;#var-MACHINE'><filename>MACHINE</filename></ulink>
6595 definition within the <filename>local.conf</filename> file in the 6597 definition within the <filename>local.conf</filename> file in the
6596 <link linkend='build-directory'>Build Directory</link> 6598 <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>
6597 specifies the target architecture used when building the Linux kernel. 6599 specifies the target architecture used when building the Linux kernel.
6598 By default, <filename>MACHINE</filename> is set to 6600 By default, <filename>MACHINE</filename> is set to
6599 <filename>qemux86</filename>, which specifies a 32-bit 6601 <filename>qemux86</filename>, which specifies a 32-bit
@@ -6653,7 +6655,7 @@
6653 Never remove any files by hand from the 6655 Never remove any files by hand from the
6654 <filename>tmp/deploy</filename> 6656 <filename>tmp/deploy</filename>
6655 directory inside the 6657 directory inside the
6656 <link linkend='build-directory'>Build Directory</link>. 6658 <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>.
6657 Always use the various BitBake clean tasks to 6659 Always use the various BitBake clean tasks to
6658 clear out previous build artifacts. 6660 clear out previous build artifacts.
6659 For information on the clean tasks, see the 6661 For information on the clean tasks, see the
@@ -7018,7 +7020,7 @@
7018 previous bulleted item.</para></listitem> 7020 previous bulleted item.</para></listitem>
7019 <listitem><para><emphasis>Point to Your distribution configuration file:</emphasis> 7021 <listitem><para><emphasis>Point to Your distribution configuration file:</emphasis>
7020 In your <filename>local.conf</filename> file in the 7022 In your <filename>local.conf</filename> file in the
7021 <link linkend='build-directory'>Build Directory</link>, 7023 <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>,
7022 set your 7024 set your
7023 <ulink url='&YOCTO_DOCS_REF_URL;#var-DISTRO'><filename>DISTRO</filename></ulink> 7025 <ulink url='&YOCTO_DOCS_REF_URL;#var-DISTRO'><filename>DISTRO</filename></ulink>
7024 variable to point to your distribution's configuration file. 7026 variable to point to your distribution's configuration file.
@@ -7078,7 +7080,7 @@
7078 <filename>TEMPLATECONF</filename> to locate the directory 7080 <filename>TEMPLATECONF</filename> to locate the directory
7079 from which it gathers configuration information that ultimately 7081 from which it gathers configuration information that ultimately
7080 ends up in the 7082 ends up in the
7081 <link linkend='build-directory'>Build Directory's</link> 7083 <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>
7082 <filename>conf</filename> directory. 7084 <filename>conf</filename> directory.
7083 By default, <filename>TEMPLATECONF</filename> is set as 7085 By default, <filename>TEMPLATECONF</filename> is set as
7084 follows in the <filename>poky</filename> repository: 7086 follows in the <filename>poky</filename> repository:
@@ -8031,7 +8033,7 @@
8031 setting 8033 setting
8032 <ulink url='&YOCTO_DOCS_REF_URL;#var-PRSERV_HOST'><filename>PRSERV_HOST</filename></ulink> 8034 <ulink url='&YOCTO_DOCS_REF_URL;#var-PRSERV_HOST'><filename>PRSERV_HOST</filename></ulink>
8033 in your <filename>local.conf</filename> file in the 8035 in your <filename>local.conf</filename> file in the
8034 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>: 8036 <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>:
8035 <literallayout class='monospaced'> 8037 <literallayout class='monospaced'>
8036 PRSERV_HOST = "localhost:0" 8038 PRSERV_HOST = "localhost:0"
8037 </literallayout> 8039 </literallayout>
@@ -8567,7 +8569,7 @@
8567 <listitem><para> 8569 <listitem><para>
8568 Open the <filename>local.conf</filename> file 8570 Open the <filename>local.conf</filename> file
8569 inside your 8571 inside your
8570 <link linkend='build-directory'>Build Directory</link> 8572 <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>
8571 (e.g. <filename>~/poky/build/conf/local.conf</filename>). 8573 (e.g. <filename>~/poky/build/conf/local.conf</filename>).
8572 </para></listitem> 8574 </para></listitem>
8573 <listitem><para> 8575 <listitem><para>
@@ -9025,7 +9027,7 @@
9025 and <ulink url='&YOCTO_DOCS_REF_URL;#var-EXTRA_IMAGE_FEATURES'><filename>EXTRA_IMAGE_FEATURES</filename></ulink> 9027 and <ulink url='&YOCTO_DOCS_REF_URL;#var-EXTRA_IMAGE_FEATURES'><filename>EXTRA_IMAGE_FEATURES</filename></ulink>
9026 variables to your <filename>local.conf</filename> file, 9028 variables to your <filename>local.conf</filename> file,
9027 which is found in the 9029 which is found in the
9028 <link linkend='build-directory'>Build Directory</link>: 9030 <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>:
9029 <literallayout class='monospaced'> 9031 <literallayout class='monospaced'>
9030 DISTRO_FEATURES_append = " ptest" 9032 DISTRO_FEATURES_append = " ptest"
9031 EXTRA_IMAGE_FEATURES += "ptest-pkgs" 9033 EXTRA_IMAGE_FEATURES += "ptest-pkgs"
@@ -9261,8 +9263,8 @@
9261 9263
9262 <para> 9264 <para>
9263 By default, the OpenEmbedded build system uses the 9265 By default, the OpenEmbedded build system uses the
9264 <link linkend='build-directory'>Build Directory</link> when 9266 <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>
9265 building source code. 9267 when building source code.
9266 The build process involves fetching the source files, unpacking 9268 The build process involves fetching the source files, unpacking
9267 them, and then patching them if necessary before the build takes 9269 them, and then patching them if necessary before the build takes
9268 place. 9270 place.
@@ -9626,7 +9628,7 @@
9626 Using either of the following statements in your 9628 Using either of the following statements in your
9627 image recipe or from within the 9629 image recipe or from within the
9628 <filename>local.conf</filename> file found in the 9630 <filename>local.conf</filename> file found in the
9629 <link linkend='build-directory'>Build Directory</link> 9631 <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>
9630 causes the build system to create a read-only root filesystem: 9632 causes the build system to create a read-only root filesystem:
9631 <literallayout class='monospaced'> 9633 <literallayout class='monospaced'>
9632 IMAGE_FEATURES = "read-only-rootfs" 9634 IMAGE_FEATURES = "read-only-rootfs"
@@ -10220,7 +10222,7 @@
10220 <ulink url='&YOCTO_DOCS_REF_URL;#var-TEST_IMAGE'><filename>TEST_IMAGE</filename></ulink> 10222 <ulink url='&YOCTO_DOCS_REF_URL;#var-TEST_IMAGE'><filename>TEST_IMAGE</filename></ulink>
10221 variable to "1" in your <filename>local.conf</filename> 10223 variable to "1" in your <filename>local.conf</filename>
10222 file in the 10224 file in the
10223 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>: 10225 <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>:
10224 <literallayout class='monospaced'> 10226 <literallayout class='monospaced'>
10225 TEST_IMAGE = "1" 10227 TEST_IMAGE = "1"
10226 </literallayout> 10228 </literallayout>
@@ -10352,7 +10354,8 @@
10352 $ bitbake <replaceable>image</replaceable> -c testexport 10354 $ bitbake <replaceable>image</replaceable> -c testexport
10353 </literallayout> 10355 </literallayout>
10354 Exporting the tests places them in the 10356 Exporting the tests places them in the
10355 <link linkend='build-directory'>Build Directory</link> in 10357 <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>
10358 in
10356 <filename>tmp/testexport/</filename><replaceable>image</replaceable>, 10359 <filename>tmp/testexport/</filename><replaceable>image</replaceable>,
10357 which is controlled by the 10360 which is controlled by the
10358 <filename>TEST_EXPORT_DIR</filename> variable. 10361 <filename>TEST_EXPORT_DIR</filename> variable.
@@ -11509,7 +11512,7 @@
11509 release just the source as a tarball. 11512 release just the source as a tarball.
11510 You can do this by adding the following to the 11513 You can do this by adding the following to the
11511 <filename>local.conf</filename> file found in the 11514 <filename>local.conf</filename> file found in the
11512 <link linkend='build-directory'>Build Directory</link>: 11515 <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>:
11513 <literallayout class='monospaced'> 11516 <literallayout class='monospaced'>
11514 INHERIT += "archiver" 11517 INHERIT += "archiver"
11515 ARCHIVER_MODE[src] = "original" 11518 ARCHIVER_MODE[src] = "original"
@@ -11724,7 +11727,7 @@
11724 <ulink url='&YOCTO_DOCS_REF_URL;#ref-classes-report-error'><filename>report-error</filename></ulink> 11727 <ulink url='&YOCTO_DOCS_REF_URL;#ref-classes-report-error'><filename>report-error</filename></ulink>
11725 class by adding the following statement to the end of 11728 class by adding the following statement to the end of
11726 your <filename>local.conf</filename> file in your 11729 your <filename>local.conf</filename> file in your
11727 <link linkend='build-directory'>Build Directory</link>. 11730 <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>.
11728 <literallayout class='monospaced'> 11731 <literallayout class='monospaced'>
11729 INHERIT += "report-error" 11732 INHERIT += "report-error"
11730 </literallayout> 11733 </literallayout>
@@ -11783,7 +11786,7 @@
11783 To disable the error reporting feature, simply remove or comment 11786 To disable the error reporting feature, simply remove or comment
11784 out the following statement from the end of your 11787 out the following statement from the end of your
11785 <filename>local.conf</filename> file in your 11788 <filename>local.conf</filename> file in your
11786 <link linkend='build-directory'>Build Directory</link>. 11789 <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>.
11787 <literallayout class='monospaced'> 11790 <literallayout class='monospaced'>
11788 INHERIT += "report-error" 11791 INHERIT += "report-error"
11789 </literallayout> 11792 </literallayout>