diff options
24 files changed, 117 insertions, 108 deletions
diff --git a/documentation/bsp-guide/bsp.xml b/documentation/bsp-guide/bsp.xml index 0dcc65b767..9226e5cdd4 100644 --- a/documentation/bsp-guide/bsp.xml +++ b/documentation/bsp-guide/bsp.xml | |||
| @@ -98,7 +98,7 @@ | |||
| 98 | This root is what you add to the | 98 | This root is what you add to the |
| 99 | <ulink url='&YOCTO_DOCS_REF_URL;#var-BBLAYERS'><filename>BBLAYERS</filename></ulink> | 99 | <ulink url='&YOCTO_DOCS_REF_URL;#var-BBLAYERS'><filename>BBLAYERS</filename></ulink> |
| 100 | variable in the <filename>conf/bblayers.conf</filename> file found in the | 100 | variable in the <filename>conf/bblayers.conf</filename> file found in the |
| 101 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>, | 101 | <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>, |
| 102 | which is established after you run one of the OpenEmbedded build environment | 102 | which is established after you run one of the OpenEmbedded build environment |
| 103 | setup scripts (i.e. | 103 | setup scripts (i.e. |
| 104 | <ulink url='&YOCTO_DOCS_REF_URL;#structure-core-script'><filename>&OE_INIT_FILE;</filename></ulink> | 104 | <ulink url='&YOCTO_DOCS_REF_URL;#structure-core-script'><filename>&OE_INIT_FILE;</filename></ulink> |
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> |
diff --git a/documentation/dev-manual/dev-manual-model.xml b/documentation/dev-manual/dev-manual-model.xml index 0782f0acdb..068fd66893 100644 --- a/documentation/dev-manual/dev-manual-model.xml +++ b/documentation/dev-manual/dev-manual-model.xml | |||
| @@ -87,7 +87,8 @@ | |||
| 87 | 87 | ||
| 88 | <note> | 88 | <note> |
| 89 | For a brief list of terms used when describing the development process in the Yocto Project, | 89 | For a brief list of terms used when describing the development process in the Yocto Project, |
| 90 | see the "<link linkend='yocto-project-terms'>Yocto Project Terms</link>" section. | 90 | see the |
| 91 | "<ulink url='&YOCTO_DOCS_REF_URL;#yocto-project-terms'>Yocto Project Terms</ulink>" section. | ||
| 91 | </note> | 92 | </note> |
| 92 | 93 | ||
| 93 | <para> | 94 | <para> |
| @@ -431,8 +432,8 @@ | |||
| 431 | The following figure shows the temporary file structure | 432 | The following figure shows the temporary file structure |
| 432 | created on your host system when the build occurs. | 433 | created on your host system when the build occurs. |
| 433 | This | 434 | This |
| 434 | <link linkend='build-directory'>Build Directory</link> contains all the | 435 | <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink> |
| 435 | source files used during the build. | 436 | contains all the source files used during the build. |
| 436 | </para> | 437 | </para> |
| 437 | 438 | ||
| 438 | <para> | 439 | <para> |
| @@ -478,7 +479,7 @@ | |||
| 478 | </para></listitem> | 479 | </para></listitem> |
| 479 | <listitem><para><emphasis>Establish the temporary kernel source files</emphasis>: | 480 | <listitem><para><emphasis>Establish the temporary kernel source files</emphasis>: |
| 480 | Temporary kernel source files are kept in the | 481 | Temporary kernel source files are kept in the |
| 481 | <link linkend='build-directory'>Build Directory</link> | 482 | <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink> |
| 482 | created by the | 483 | created by the |
| 483 | OpenEmbedded build system when you run BitBake. | 484 | OpenEmbedded build system when you run BitBake. |
| 484 | If you have never built the kernel in which you are | 485 | If you have never built the kernel in which you are |
| @@ -1270,7 +1271,7 @@ | |||
| 1270 | <listitem><para><emphasis>Find the Source Code:</emphasis> | 1271 | <listitem><para><emphasis>Find the Source Code:</emphasis> |
| 1271 | Temporary source code used by the OpenEmbedded build system | 1272 | Temporary source code used by the OpenEmbedded build system |
| 1272 | is kept in the | 1273 | is kept in the |
| 1273 | <link linkend='build-directory'>Build Directory</link>. | 1274 | <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>. |
| 1274 | See the | 1275 | See the |
| 1275 | "<link linkend='finding-the-temporary-source-code'>Finding Temporary Source Code</link>" | 1276 | "<link linkend='finding-the-temporary-source-code'>Finding Temporary Source Code</link>" |
| 1276 | section to learn how to locate the directory that has the | 1277 | section to learn how to locate the directory that has the |
| @@ -1364,8 +1365,8 @@ | |||
| 1364 | experiment a bit to figure out your solution. | 1365 | experiment a bit to figure out your solution. |
| 1365 | After you have initially built the package, you can iteratively | 1366 | After you have initially built the package, you can iteratively |
| 1366 | tweak the source code, which is located in the | 1367 | tweak the source code, which is located in the |
| 1367 | <link linkend='build-directory'>Build Directory</link>, and then | 1368 | <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>, |
| 1368 | you can force a re-compile and quickly test your altered code. | 1369 | and then you can force a re-compile and quickly test your altered code. |
| 1369 | Once you settle on a solution, you can then preserve your changes | 1370 | Once you settle on a solution, you can then preserve your changes |
| 1370 | in the form of patches. | 1371 | in the form of patches. |
| 1371 | If you are using Quilt for development, see the | 1372 | If you are using Quilt for development, see the |
diff --git a/documentation/dev-manual/dev-manual-newbie.xml b/documentation/dev-manual/dev-manual-newbie.xml index 350c6e49a8..5a3e3ea107 100644 --- a/documentation/dev-manual/dev-manual-newbie.xml +++ b/documentation/dev-manual/dev-manual-newbie.xml | |||
| @@ -526,8 +526,8 @@ | |||
| 526 | <filename>meta/files/common-licenses</filename>. | 526 | <filename>meta/files/common-licenses</filename>. |
| 527 | Once the build completes, the list of all licenses found and used during that build are | 527 | Once the build completes, the list of all licenses found and used during that build are |
| 528 | kept in the | 528 | kept in the |
| 529 | <link linkend='build-directory'>Build Directory</link> at | 529 | <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink> |
| 530 | <filename>tmp/deploy/licenses</filename>. | 530 | at <filename>tmp/deploy/licenses</filename>. |
| 531 | </para> | 531 | </para> |
| 532 | 532 | ||
| 533 | <para> | 533 | <para> |
diff --git a/documentation/dev-manual/dev-manual-qemu.xml b/documentation/dev-manual/dev-manual-qemu.xml index 41c18298a5..80e4b24ccb 100644 --- a/documentation/dev-manual/dev-manual-qemu.xml +++ b/documentation/dev-manual/dev-manual-qemu.xml | |||
| @@ -252,7 +252,7 @@ qemux86" or "qemux86-64". | |||
| 252 | This example starts QEMU with | 252 | This example starts QEMU with |
| 253 | <replaceable>MACHINE</replaceable> set to "qemux86". | 253 | <replaceable>MACHINE</replaceable> set to "qemux86". |
| 254 | Assuming a standard | 254 | Assuming a standard |
| 255 | <link linkend='build-directory'>Build Directory</link>, | 255 | <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>, |
| 256 | <filename>runqemu</filename> automatically finds the | 256 | <filename>runqemu</filename> automatically finds the |
| 257 | <filename>bzImage-qemux86.bin</filename> image file and | 257 | <filename>bzImage-qemux86.bin</filename> image file and |
| 258 | the | 258 | the |
diff --git a/documentation/dev-manual/dev-manual-start.xml b/documentation/dev-manual/dev-manual-start.xml index 0e335e28fc..6b97c52ada 100644 --- a/documentation/dev-manual/dev-manual-start.xml +++ b/documentation/dev-manual/dev-manual-start.xml | |||
| @@ -309,7 +309,7 @@ | |||
| 309 | </para></listitem> | 309 | </para></listitem> |
| 310 | <listitem><para>Optionally ensure the <filename>conf/local.conf</filename> configuration file, | 310 | <listitem><para>Optionally ensure the <filename>conf/local.conf</filename> configuration file, |
| 311 | which is found in the | 311 | which is found in the |
| 312 | <link linkend='build-directory'>Build Directory</link>, | 312 | <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>, |
| 313 | is set up how you want it. | 313 | is set up how you want it. |
| 314 | This file defines many aspects of the build environment including | 314 | This file defines many aspects of the build environment including |
| 315 | the target machine architecture through the | 315 | the target machine architecture through the |
diff --git a/documentation/kernel-dev/kernel-dev-maint-appx.xml b/documentation/kernel-dev/kernel-dev-maint-appx.xml index 6bb0cf6fd0..7cfcb45c94 100644 --- a/documentation/kernel-dev/kernel-dev-maint-appx.xml +++ b/documentation/kernel-dev/kernel-dev-maint-appx.xml | |||
| @@ -209,7 +209,7 @@ | |||
| 209 | The files include the final <filename>.config</filename> file, all the <filename>.o</filename> | 209 | The files include the final <filename>.config</filename> file, all the <filename>.o</filename> |
| 210 | files, the <filename>.a</filename> files, and so forth. | 210 | files, the <filename>.a</filename> files, and so forth. |
| 211 | Since each machine or BSP has its own separate | 211 | Since each machine or BSP has its own separate |
| 212 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> | 212 | <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink> |
| 213 | in its own separate branch | 213 | in its own separate branch |
| 214 | of the Git repository, you can easily switch between different builds. | 214 | of the Git repository, you can easily switch between different builds. |
| 215 | </para> | 215 | </para> |
diff --git a/documentation/ref-manual/closer-look.xml b/documentation/ref-manual/closer-look.xml index c0f1747961..e4a2a022a7 100644 --- a/documentation/ref-manual/closer-look.xml +++ b/documentation/ref-manual/closer-look.xml | |||
| @@ -114,7 +114,7 @@ | |||
| 114 | 114 | ||
| 115 | <para> | 115 | <para> |
| 116 | Sourcing the build environment script creates a | 116 | Sourcing the build environment script creates a |
| 117 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> | 117 | <link linkend='build-directory'>Build Directory</link> |
| 118 | if one does not already exist. | 118 | if one does not already exist. |
| 119 | BitBake uses the Build Directory for all its work during builds. | 119 | BitBake uses the Build Directory for all its work during builds. |
| 120 | The Build Directory has a <filename>conf</filename> directory that | 120 | The Build Directory has a <filename>conf</filename> directory that |
| @@ -641,7 +641,7 @@ | |||
| 641 | <para> | 641 | <para> |
| 642 | When the OpenEmbedded build system generates an image or an SDK, | 642 | When the OpenEmbedded build system generates an image or an SDK, |
| 643 | it gets the packages from a package feed area located in the | 643 | it gets the packages from a package feed area located in the |
| 644 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. | 644 | <link linkend='build-directory'>Build Directory</link>. |
| 645 | The | 645 | The |
| 646 | <link linkend='general-yocto-environment-figure'>general Yocto Project Development Environment figure</link> | 646 | <link linkend='general-yocto-environment-figure'>general Yocto Project Development Environment figure</link> |
| 647 | shows this package feeds area in the upper-right corner. | 647 | shows this package feeds area in the upper-right corner. |
| @@ -770,7 +770,7 @@ | |||
| 770 | depend on it are re-executed. | 770 | depend on it are re-executed. |
| 771 | </note> | 771 | </note> |
| 772 | By default, everything is accomplished in the | 772 | By default, everything is accomplished in the |
| 773 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>, | 773 | <link linkend='build-directory'>Build Directory</link>, |
| 774 | which has a defined structure. | 774 | which has a defined structure. |
| 775 | For additional general information on the Build Directory, | 775 | For additional general information on the Build Directory, |
| 776 | see the | 776 | see the |
| @@ -1430,7 +1430,7 @@ | |||
| 1430 | 1430 | ||
| 1431 | <para> | 1431 | <para> |
| 1432 | Images are written out to the | 1432 | Images are written out to the |
| 1433 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> | 1433 | <link linkend='build-directory'>Build Directory</link> |
| 1434 | inside the <filename>tmp/deploy/images/<replaceable>machine</replaceable>/</filename> | 1434 | inside the <filename>tmp/deploy/images/<replaceable>machine</replaceable>/</filename> |
| 1435 | folder as shown in the figure. | 1435 | folder as shown in the figure. |
| 1436 | This folder contains any files expected to be loaded on the | 1436 | This folder contains any files expected to be loaded on the |
| @@ -1545,7 +1545,7 @@ | |||
| 1545 | <para> | 1545 | <para> |
| 1546 | Once built, the SDK installers are written out to the | 1546 | Once built, the SDK installers are written out to the |
| 1547 | <filename>deploy/sdk</filename> folder inside the | 1547 | <filename>deploy/sdk</filename> folder inside the |
| 1548 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> | 1548 | <link linkend='build-directory'>Build Directory</link> |
| 1549 | as shown in the figure at the beginning of this section. | 1549 | as shown in the figure at the beginning of this section. |
| 1550 | Depending on the type of SDK, several variables exist that help | 1550 | Depending on the type of SDK, several variables exist that help |
| 1551 | configure these files. | 1551 | configure these files. |
diff --git a/documentation/ref-manual/faq.xml b/documentation/ref-manual/faq.xml index cdbdd4da24..c4b860b1ce 100644 --- a/documentation/ref-manual/faq.xml +++ b/documentation/ref-manual/faq.xml | |||
| @@ -702,7 +702,8 @@ | |||
| 702 | <link linkend='structure-core-script'><filename>&OE_INIT_FILE;</filename></link> | 702 | <link linkend='structure-core-script'><filename>&OE_INIT_FILE;</filename></link> |
| 703 | or | 703 | or |
| 704 | <link linkend='structure-memres-core-script'><filename>oe-init-build-env-memres</filename></link>). | 704 | <link linkend='structure-memres-core-script'><filename>oe-init-build-env-memres</filename></link>). |
| 705 | By default, this <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> | 705 | By default, this |
| 706 | <link linkend='build-directory'>Build Directory</link> | ||
| 706 | is named <filename>build</filename> but can be named | 707 | is named <filename>build</filename> but can be named |
| 707 | anything you want. | 708 | anything you want. |
| 708 | </para> | 709 | </para> |
| @@ -765,7 +766,7 @@ | |||
| 765 | 766 | ||
| 766 | <para> | 767 | <para> |
| 767 | Meanwhile, <filename>DESTDIR</filename> is a path within the | 768 | Meanwhile, <filename>DESTDIR</filename> is a path within the |
| 768 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. | 769 | <link linkend='build-directory'>Build Directory</link>. |
| 769 | However, when the recipe builds a native program (i.e. one | 770 | However, when the recipe builds a native program (i.e. one |
| 770 | that is intended to run on the build machine), that program | 771 | that is intended to run on the build machine), that program |
| 771 | is never installed directly to the build machine's root | 772 | is never installed directly to the build machine's root |
diff --git a/documentation/ref-manual/introduction.xml b/documentation/ref-manual/introduction.xml index deaac033a3..7f6729db55 100644 --- a/documentation/ref-manual/introduction.xml +++ b/documentation/ref-manual/introduction.xml | |||
| @@ -953,7 +953,7 @@ | |||
| 953 | <filename>.sh</filename> file that installs | 953 | <filename>.sh</filename> file that installs |
| 954 | the tools in the <filename>tmp/deploy/sdk</filename> | 954 | the tools in the <filename>tmp/deploy/sdk</filename> |
| 955 | subdirectory of the | 955 | subdirectory of the |
| 956 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. | 956 | <link linkend='build-directory'>Build Directory</link>. |
| 957 | The installer file has the string "buildtools" | 957 | The installer file has the string "buildtools" |
| 958 | in the name. | 958 | in the name. |
| 959 | </para></listitem> | 959 | </para></listitem> |
diff --git a/documentation/ref-manual/migration.xml b/documentation/ref-manual/migration.xml index 0513b219cd..5c700bc5ea 100644 --- a/documentation/ref-manual/migration.xml +++ b/documentation/ref-manual/migration.xml | |||
| @@ -821,7 +821,7 @@ | |||
| 821 | <listitem><para> | 821 | <listitem><para> |
| 822 | When buildhistory is enabled, its output is now written | 822 | When buildhistory is enabled, its output is now written |
| 823 | under the | 823 | under the |
| 824 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> | 824 | <link linkend='build-directory'>Build Directory</link> |
| 825 | rather than | 825 | rather than |
| 826 | <link linkend='var-TMPDIR'><filename>TMPDIR</filename></link>. | 826 | <link linkend='var-TMPDIR'><filename>TMPDIR</filename></link>. |
| 827 | Doing so makes it easier to delete | 827 | Doing so makes it easier to delete |
diff --git a/documentation/ref-manual/ref-classes.xml b/documentation/ref-manual/ref-classes.xml index 2b5cb88efd..472215c25a 100644 --- a/documentation/ref-manual/ref-classes.xml +++ b/documentation/ref-manual/ref-classes.xml | |||
| @@ -2393,7 +2393,7 @@ This check was removed for YP 2.3 release | |||
| 2393 | <filename><link linkend='var-PACKAGE_CLASSES'>PACKAGE_CLASSES</link></filename> | 2393 | <filename><link linkend='var-PACKAGE_CLASSES'>PACKAGE_CLASSES</link></filename> |
| 2394 | variable defined in your <filename>conf/local.conf</filename> | 2394 | variable defined in your <filename>conf/local.conf</filename> |
| 2395 | configuration file, which is located in the | 2395 | configuration file, which is located in the |
| 2396 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. | 2396 | <link linkend='build-directory'>Build Directory</link>. |
| 2397 | When defining the variable, you can specify one or more package types. | 2397 | When defining the variable, you can specify one or more package types. |
| 2398 | Since images are generated from packages, a packaging class is | 2398 | Since images are generated from packages, a packaging class is |
| 2399 | needed to enable image generation. | 2399 | needed to enable image generation. |
| @@ -2988,7 +2988,7 @@ This check was removed for YP 2.3 release | |||
| 2988 | as the build progresses, you can enable <filename>rm_work</filename> | 2988 | as the build progresses, you can enable <filename>rm_work</filename> |
| 2989 | by adding the following to your <filename>local.conf</filename> file, | 2989 | by adding the following to your <filename>local.conf</filename> file, |
| 2990 | which is found in the | 2990 | which is found in the |
| 2991 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. | 2991 | <link linkend='build-directory'>Build Directory</link>. |
| 2992 | <literallayout class='monospaced'> | 2992 | <literallayout class='monospaced'> |
| 2993 | INHERIT += "rm_work" | 2993 | INHERIT += "rm_work" |
| 2994 | </literallayout> | 2994 | </literallayout> |
diff --git a/documentation/ref-manual/ref-devtool-reference.xml b/documentation/ref-manual/ref-devtool-reference.xml index 99d5a52a0f..64db00e714 100644 --- a/documentation/ref-manual/ref-devtool-reference.xml +++ b/documentation/ref-manual/ref-devtool-reference.xml | |||
| @@ -573,7 +573,7 @@ | |||
| 573 | <para> | 573 | <para> |
| 574 | Use the <filename>devtool create-workspace</filename> command to | 574 | Use the <filename>devtool create-workspace</filename> command to |
| 575 | create a new workspace layer in your | 575 | create a new workspace layer in your |
| 576 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. | 576 | <link linkend='build-directory'>Build Directory</link>. |
| 577 | When you create a new workspace layer, it is populated with the | 577 | When you create a new workspace layer, it is populated with the |
| 578 | <filename>README</filename> file and the | 578 | <filename>README</filename> file and the |
| 579 | <filename>conf</filename> directory only. | 579 | <filename>conf</filename> directory only. |
diff --git a/documentation/ref-manual/ref-structure.xml b/documentation/ref-manual/ref-structure.xml index b0c4bfeaa4..424b8cc003 100644 --- a/documentation/ref-manual/ref-structure.xml +++ b/documentation/ref-manual/ref-structure.xml | |||
| @@ -75,7 +75,8 @@ | |||
| 75 | This directory contains user configuration files and the output | 75 | This directory contains user configuration files and the output |
| 76 | generated by the OpenEmbedded build system in its standard configuration where | 76 | generated by the OpenEmbedded build system in its standard configuration where |
| 77 | the source tree is combined with the output. | 77 | the source tree is combined with the output. |
| 78 | The <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> | 78 | The |
| 79 | <link linkend='build-directory'>Build Directory</link> | ||
| 79 | is created initially when you <filename>source</filename> | 80 | is created initially when you <filename>source</filename> |
| 80 | the OpenEmbedded build environment setup script | 81 | the OpenEmbedded build environment setup script |
| 81 | (i.e. | 82 | (i.e. |
| @@ -212,7 +213,7 @@ | |||
| 212 | <para> | 213 | <para> |
| 213 | When you run this script, your Yocto Project environment is set | 214 | When you run this script, your Yocto Project environment is set |
| 214 | up, a | 215 | up, a |
| 215 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> | 216 | <link linkend='build-directory'>Build Directory</link> |
| 216 | is created, your working directory becomes the Build Directory, | 217 | is created, your working directory becomes the Build Directory, |
| 217 | and you are presented with a list of common BitBake targets. | 218 | and you are presented with a list of common BitBake targets. |
| 218 | Here is an example: | 219 | Here is an example: |
| @@ -246,7 +247,7 @@ | |||
| 246 | 247 | ||
| 247 | <para> | 248 | <para> |
| 248 | By default, running this script without a | 249 | By default, running this script without a |
| 249 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> | 250 | <link linkend='build-directory'>Build Directory</link> |
| 250 | argument creates the <filename>build</filename> directory | 251 | argument creates the <filename>build</filename> directory |
| 251 | in your current working directory. | 252 | in your current working directory. |
| 252 | If you provide a Build Directory argument when you | 253 | If you provide a Build Directory argument when you |
| @@ -330,7 +331,7 @@ | |||
| 330 | <listitem><para> | 331 | <listitem><para> |
| 331 | The script's parameters are positionally dependent. | 332 | The script's parameters are positionally dependent. |
| 332 | Consequently, you cannot run the script and provide a | 333 | Consequently, you cannot run the script and provide a |
| 333 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> | 334 | <link linkend='build-directory'>Build Directory</link> |
| 334 | name without also providing a port number. | 335 | name without also providing a port number. |
| 335 | In other words, the following syntax is illegal: | 336 | In other words, the following syntax is illegal: |
| 336 | <literallayout class='monospaced'> | 337 | <literallayout class='monospaced'> |
| @@ -386,7 +387,7 @@ | |||
| 386 | 387 | ||
| 387 | <para> | 388 | <para> |
| 388 | By default, running this script without a | 389 | By default, running this script without a |
| 389 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> | 390 | <link linkend='build-directory'>Build Directory</link> |
| 390 | argument creates a build directory named | 391 | argument creates a build directory named |
| 391 | <filename>build</filename>. | 392 | <filename>build</filename>. |
| 392 | If you provide a Build Directory argument and port number when you | 393 | If you provide a Build Directory argument and port number when you |
| @@ -443,7 +444,7 @@ | |||
| 443 | 444 | ||
| 444 | <para> | 445 | <para> |
| 445 | The OpenEmbedded build system creates the | 446 | The OpenEmbedded build system creates the |
| 446 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> | 447 | <link linkend='build-directory'>Build Directory</link> |
| 447 | when you run one of the build environment setup scripts (i.e. | 448 | when you run one of the build environment setup scripts (i.e. |
| 448 | <link linkend='structure-core-script'><filename>&OE_INIT_FILE;</filename></link> | 449 | <link linkend='structure-core-script'><filename>&OE_INIT_FILE;</filename></link> |
| 449 | or | 450 | or |
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml index bd9e517246..da4da8550d 100644 --- a/documentation/ref-manual/ref-variables.xml +++ b/documentation/ref-manual/ref-variables.xml | |||
| @@ -536,7 +536,7 @@ | |||
| 536 | <para role="glossdeffirst"> | 536 | <para role="glossdeffirst"> |
| 537 | <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> | 537 | <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> |
| 538 | The directory within the | 538 | The directory within the |
| 539 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> | 539 | <link linkend='build-directory'>Build Directory</link> |
| 540 | in which the OpenEmbedded build system places generated | 540 | in which the OpenEmbedded build system places generated |
| 541 | objects during a recipe's build process. | 541 | objects during a recipe's build process. |
| 542 | By default, this directory is the same as the <link linkend='var-S'><filename>S</filename></link> | 542 | By default, this directory is the same as the <link linkend='var-S'><filename>S</filename></link> |
| @@ -734,7 +734,7 @@ | |||
| 734 | variable to "1", "yes", or "true" | 734 | variable to "1", "yes", or "true" |
| 735 | in your <filename>local.conf</filename> file, which is | 735 | in your <filename>local.conf</filename> file, which is |
| 736 | located in the | 736 | located in the |
| 737 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>: | 737 | <link linkend='build-directory'>Build Directory</link>: |
| 738 | Here is an example: | 738 | Here is an example: |
| 739 | <literallayout class='monospaced'> | 739 | <literallayout class='monospaced'> |
| 740 | BB_DANGLINGAPPENDS_WARNONLY = "1" | 740 | BB_DANGLINGAPPENDS_WARNONLY = "1" |
| @@ -759,7 +759,7 @@ | |||
| 759 | Disk space monitoring is disabled by default. | 759 | Disk space monitoring is disabled by default. |
| 760 | To enable monitoring, add the <filename>BB_DISKMON_DIRS</filename> | 760 | To enable monitoring, add the <filename>BB_DISKMON_DIRS</filename> |
| 761 | variable to your <filename>conf/local.conf</filename> file found in the | 761 | variable to your <filename>conf/local.conf</filename> file found in the |
| 762 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. | 762 | <link linkend='build-directory'>Build Directory</link>. |
| 763 | Use the following form: | 763 | Use the following form: |
| 764 | <literallayout class='monospaced'> | 764 | <literallayout class='monospaced'> |
| 765 | BB_DISKMON_DIRS = "<replaceable>action</replaceable>,<replaceable>dir</replaceable>,<replaceable>threshold</replaceable> [...]" | 765 | BB_DISKMON_DIRS = "<replaceable>action</replaceable>,<replaceable>dir</replaceable>,<replaceable>threshold</replaceable> [...]" |
| @@ -852,7 +852,7 @@ | |||
| 852 | Defines the disk space and free inode warning intervals. | 852 | Defines the disk space and free inode warning intervals. |
| 853 | To set these intervals, define the variable in your | 853 | To set these intervals, define the variable in your |
| 854 | <filename>conf/local.conf</filename> file in the | 854 | <filename>conf/local.conf</filename> file in the |
| 855 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. | 855 | <link linkend='build-directory'>Build Directory</link>. |
| 856 | </para> | 856 | </para> |
| 857 | 857 | ||
| 858 | <para> | 858 | <para> |
| @@ -936,7 +936,7 @@ | |||
| 936 | </literallayout> | 936 | </literallayout> |
| 937 | Set this variable in your <filename>local.conf</filename> | 937 | Set this variable in your <filename>local.conf</filename> |
| 938 | file in the | 938 | file in the |
| 939 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. | 939 | <link linkend='build-directory'>Build Directory</link>. |
| 940 | </para> | 940 | </para> |
| 941 | </glossdef> | 941 | </glossdef> |
| 942 | </glossentry> | 942 | </glossentry> |
| @@ -1154,7 +1154,8 @@ | |||
| 1154 | <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> | 1154 | <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> |
| 1155 | Lists the layers to enable during the build. | 1155 | Lists the layers to enable during the build. |
| 1156 | This variable is defined in the <filename>bblayers.conf</filename> configuration | 1156 | This variable is defined in the <filename>bblayers.conf</filename> configuration |
| 1157 | file in the <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. | 1157 | file in the |
| 1158 | <link linkend='build-directory'>Build Directory</link>. | ||
| 1158 | Here is an example: | 1159 | Here is an example: |
| 1159 | <literallayout class='monospaced'> | 1160 | <literallayout class='monospaced'> |
| 1160 | BBLAYERS = " \ | 1161 | BBLAYERS = " \ |
| @@ -1250,7 +1251,7 @@ | |||
| 1250 | BBMULTIFONFIG = "configA configB configC" | 1251 | BBMULTIFONFIG = "configA configB configC" |
| 1251 | </literallayout> | 1252 | </literallayout> |
| 1252 | Each configuration file you use must reside in the | 1253 | Each configuration file you use must reside in the |
| 1253 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory's</ulink> | 1254 | <link linkend='build-directory'>Build Directory</link> |
| 1254 | <filename>conf/multiconfig</filename> directory | 1255 | <filename>conf/multiconfig</filename> directory |
| 1255 | (e.g. | 1256 | (e.g. |
| 1256 | <replaceable>build_directory</replaceable><filename>/conf/multiconfig/configA.conf</filename>). | 1257 | <replaceable>build_directory</replaceable><filename>/conf/multiconfig/configA.conf</filename>). |
| @@ -1280,7 +1281,7 @@ | |||
| 1280 | <filename>PATH</filename> variable. | 1281 | <filename>PATH</filename> variable. |
| 1281 | <note> | 1282 | <note> |
| 1282 | If you run BitBake from a directory outside of the | 1283 | If you run BitBake from a directory outside of the |
| 1283 | <ulink url='&YOCTO_DOCS_DEV_URL;build-directory'>Build Directory</ulink>, | 1284 | <link linkend='build-directory'>Build Directory</link>, |
| 1284 | you must be sure to set | 1285 | you must be sure to set |
| 1285 | <filename>BBPATH</filename> to point to the | 1286 | <filename>BBPATH</filename> to point to the |
| 1286 | Build Directory. | 1287 | Build Directory. |
| @@ -1626,7 +1627,7 @@ | |||
| 1626 | <para role="glossdeffirst"> | 1627 | <para role="glossdeffirst"> |
| 1627 | <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> | 1628 | <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> |
| 1628 | Points to the location of the | 1629 | Points to the location of the |
| 1629 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. | 1630 | <link linkend='build-directory'>Build Directory</link>. |
| 1630 | You can define this directory indirectly through the | 1631 | You can define this directory indirectly through the |
| 1631 | <link linkend='structure-core-script'><filename>&OE_INIT_FILE;</filename></link> | 1632 | <link linkend='structure-core-script'><filename>&OE_INIT_FILE;</filename></link> |
| 1632 | and | 1633 | and |
| @@ -2595,7 +2596,7 @@ | |||
| 2595 | You should only set this variable in the | 2596 | You should only set this variable in the |
| 2596 | <filename>local.conf</filename> configuration file found | 2597 | <filename>local.conf</filename> configuration file found |
| 2597 | in the | 2598 | in the |
| 2598 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. | 2599 | <link linkend='build-directory'>Build Directory</link>. |
| 2599 | </para> | 2600 | </para> |
| 2600 | 2601 | ||
| 2601 | <para> | 2602 | <para> |
| @@ -2805,7 +2806,8 @@ | |||
| 2805 | <para role="glossdeffirst"> | 2806 | <para role="glossdeffirst"> |
| 2806 | <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> | 2807 | <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> |
| 2807 | The destination directory. | 2808 | The destination directory. |
| 2808 | The location in the <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> | 2809 | The location in the |
| 2810 | <link linkend='build-directory'>Build Directory</link> | ||
| 2809 | where components are installed by the | 2811 | where components are installed by the |
| 2810 | <link linkend='ref-tasks-install'><filename>do_install</filename></link> | 2812 | <link linkend='ref-tasks-install'><filename>do_install</filename></link> |
| 2811 | task. | 2813 | task. |
| @@ -3116,7 +3118,7 @@ | |||
| 3116 | system uses to place images, packages, SDKs and other output | 3118 | system uses to place images, packages, SDKs and other output |
| 3117 | files that are ready to be used outside of the build system. | 3119 | files that are ready to be used outside of the build system. |
| 3118 | By default, this directory resides within the | 3120 | By default, this directory resides within the |
| 3119 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> | 3121 | <link linkend='build-directory'>Build Directory</link> |
| 3120 | as <filename>${TMPDIR}/deploy</filename>. | 3122 | as <filename>${TMPDIR}/deploy</filename>. |
| 3121 | </para> | 3123 | </para> |
| 3122 | 3124 | ||
| @@ -3189,7 +3191,7 @@ | |||
| 3189 | The directory is machine-specific as it contains the | 3191 | The directory is machine-specific as it contains the |
| 3190 | <filename>${MACHINE}</filename> name. | 3192 | <filename>${MACHINE}</filename> name. |
| 3191 | By default, this directory resides within the | 3193 | By default, this directory resides within the |
| 3192 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> | 3194 | <link linkend='build-directory'>Build Directory</link> |
| 3193 | as <filename>${DEPLOY_DIR}/images/${MACHINE}/</filename>. | 3195 | as <filename>${DEPLOY_DIR}/images/${MACHINE}/</filename>. |
| 3194 | </para> | 3196 | </para> |
| 3195 | 3197 | ||
| @@ -3794,7 +3796,7 @@ | |||
| 3794 | to touch it. | 3796 | to touch it. |
| 3795 | By default, the directory is <filename>downloads</filename> | 3797 | By default, the directory is <filename>downloads</filename> |
| 3796 | in the | 3798 | in the |
| 3797 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. | 3799 | <link linkend='build-directory'>Build Directory</link>. |
| 3798 | <literallayout class='monospaced'> | 3800 | <literallayout class='monospaced'> |
| 3799 | #DL_DIR ?= "${TOPDIR}/downloads" | 3801 | #DL_DIR ?= "${TOPDIR}/downloads" |
| 3800 | </literallayout> | 3802 | </literallayout> |
| @@ -4191,7 +4193,7 @@ | |||
| 4191 | <para> | 4193 | <para> |
| 4192 | Typically, you configure this variable in your | 4194 | Typically, you configure this variable in your |
| 4193 | <filename>local.conf</filename> file, which is found in the | 4195 | <filename>local.conf</filename> file, which is found in the |
| 4194 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. | 4196 | <link linkend='build-directory'>Build Directory</link>. |
| 4195 | Although you can use this variable from within a recipe, | 4197 | Although you can use this variable from within a recipe, |
| 4196 | best practices dictate that you do not. | 4198 | best practices dictate that you do not. |
| 4197 | <note> | 4199 | <note> |
| @@ -4761,7 +4763,7 @@ | |||
| 4761 | <para> | 4763 | <para> |
| 4762 | You define the <filename>FILESYSTEM_PERMS_TABLES</filename> variable in the | 4764 | You define the <filename>FILESYSTEM_PERMS_TABLES</filename> variable in the |
| 4763 | <filename>conf/local.conf</filename> file, which is found in the | 4765 | <filename>conf/local.conf</filename> file, which is found in the |
| 4764 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>, to | 4766 | <link linkend='build-directory'>Build Directory</link>, to |
| 4765 | point to your custom <filename>fs-perms.txt</filename>. | 4767 | point to your custom <filename>fs-perms.txt</filename>. |
| 4766 | You can specify more than a single file permissions setting table. | 4768 | You can specify more than a single file permissions setting table. |
| 4767 | The paths you specify to these files must be defined within the | 4769 | The paths you specify to these files must be defined within the |
| @@ -5613,7 +5615,7 @@ | |||
| 5613 | Typically, you configure this variable in an image recipe. | 5615 | Typically, you configure this variable in an image recipe. |
| 5614 | Although you can use this variable from your | 5616 | Although you can use this variable from your |
| 5615 | <filename>local.conf</filename> file, which is found in the | 5617 | <filename>local.conf</filename> file, which is found in the |
| 5616 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>, | 5618 | <link linkend='build-directory'>Build Directory</link>, |
| 5617 | best practices dictate that you do not. | 5619 | best practices dictate that you do not. |
| 5618 | <note> | 5620 | <note> |
| 5619 | To enable extra features from outside the image recipe, | 5621 | 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" | |||
| 6562 | The combined binary is deposited into the | 6564 | The combined binary is deposited into the |
| 6563 | <filename>tmp/deploy</filename> directory, which is part | 6565 | <filename>tmp/deploy</filename> directory, which is part |
| 6564 | of the | 6566 | of the |
| 6565 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. | 6567 | <link linkend='build-directory'>Build Directory</link>. |
| 6566 | </para> | 6568 | </para> |
| 6567 | 6569 | ||
| 6568 | <para> | 6570 | <para> |
| @@ -7941,7 +7943,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
| 7941 | Specifies the target device for which the image is built. | 7943 | Specifies the target device for which the image is built. |
| 7942 | You define <filename>MACHINE</filename> in the | 7944 | You define <filename>MACHINE</filename> in the |
| 7943 | <filename>local.conf</filename> file found in the | 7945 | <filename>local.conf</filename> file found in the |
| 7944 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. | 7946 | <link linkend='build-directory'>Build Directory</link>. |
| 7945 | By default, <filename>MACHINE</filename> is set to | 7947 | By default, <filename>MACHINE</filename> is set to |
| 7946 | "qemux86", which is an x86-based architecture machine to | 7948 | "qemux86", which is an x86-based architecture machine to |
| 7947 | be emulated using QEMU: | 7949 | be emulated using QEMU: |
| @@ -9085,7 +9087,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
| 9085 | This variable, which is set in the | 9087 | This variable, which is set in the |
| 9086 | <filename>local.conf</filename> configuration file found in | 9088 | <filename>local.conf</filename> configuration file found in |
| 9087 | the <filename>conf</filename> folder of the | 9089 | the <filename>conf</filename> folder of the |
| 9088 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>, | 9090 | <link linkend='build-directory'>Build Directory</link>, |
| 9089 | specifies the package manager the OpenEmbedded build system | 9091 | specifies the package manager the OpenEmbedded build system |
| 9090 | uses when packaging data. | 9092 | uses when packaging data. |
| 9091 | </para> | 9093 | </para> |
| @@ -10531,7 +10533,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
| 10531 | build system to attempt before any others by adding | 10533 | build system to attempt before any others by adding |
| 10532 | something like the following to the | 10534 | something like the following to the |
| 10533 | <filename>local.conf</filename> configuration file in the | 10535 | <filename>local.conf</filename> configuration file in the |
| 10534 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>: | 10536 | <link linkend='build-directory'>Build Directory</link>: |
| 10535 | <literallayout class='monospaced'> | 10537 | <literallayout class='monospaced'> |
| 10536 | PREMIRRORS_prepend = "\ | 10538 | PREMIRRORS_prepend = "\ |
| 10537 | git://.*/.* http://www.yoctoproject.org/sources/ \n \ | 10539 | 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" | |||
| 11493 | <para role="glossdeffirst"> | 11495 | <para role="glossdeffirst"> |
| 11494 | <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> | 11496 | <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> |
| 11495 | The location in the | 11497 | The location in the |
| 11496 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> | 11498 | <link linkend='build-directory'>Build Directory</link> |
| 11497 | where unpacked recipe source code resides. | 11499 | where unpacked recipe source code resides. |
| 11498 | By default, this directory is | 11500 | By default, this directory is |
| 11499 | <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>, | 11501 | <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" | |||
| 12411 | To enable file removal, set the variable to "1" in your | 12413 | To enable file removal, set the variable to "1" in your |
| 12412 | <filename>conf/local.conf</filename> configuration file | 12414 | <filename>conf/local.conf</filename> configuration file |
| 12413 | in your: | 12415 | in your: |
| 12414 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. | 12416 | <link linkend='build-directory'>Build Directory</link>. |
| 12415 | <literallayout class='monospaced'> | 12417 | <literallayout class='monospaced'> |
| 12416 | SKIP_FILEDEPS = "1" | 12418 | SKIP_FILEDEPS = "1" |
| 12417 | </literallayout> | 12419 | </literallayout> |
| @@ -14263,7 +14265,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
| 14263 | The suffix identifies the <filename>libc</filename> variant | 14265 | The suffix identifies the <filename>libc</filename> variant |
| 14264 | for building. | 14266 | for building. |
| 14265 | When you are building for multiple variants with the same | 14267 | When you are building for multiple variants with the same |
| 14266 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>, | 14268 | <link linkend='build-directory'>Build Directory</link>, |
| 14267 | this mechanism ensures that output for different | 14269 | this mechanism ensures that output for different |
| 14268 | <filename>libc</filename> variants is kept separate to | 14270 | <filename>libc</filename> variants is kept separate to |
| 14269 | avoid potential conflicts. | 14271 | avoid potential conflicts. |
| @@ -14421,7 +14423,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
| 14421 | <filename>ssh</filename>. | 14423 | <filename>ssh</filename>. |
| 14422 | You can set this variable to "1" in your | 14424 | You can set this variable to "1" in your |
| 14423 | <filename>local.conf</filename> file in the | 14425 | <filename>local.conf</filename> file in the |
| 14424 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> | 14426 | <link linkend='build-directory'>Build Directory</link> |
| 14425 | to have the OpenEmbedded build system automatically run | 14427 | to have the OpenEmbedded build system automatically run |
| 14426 | these tests after an image successfully builds: | 14428 | these tests after an image successfully builds: |
| 14427 | <literallayout class='monospaced'> | 14429 | <literallayout class='monospaced'> |
| @@ -14789,7 +14791,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
| 14789 | files (other than the shared state cache). | 14791 | files (other than the shared state cache). |
| 14790 | By default, the <filename>TMPDIR</filename> variable points | 14792 | By default, the <filename>TMPDIR</filename> variable points |
| 14791 | to <filename>tmp</filename> within the | 14793 | to <filename>tmp</filename> within the |
| 14792 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. | 14794 | <link linkend='build-directory'>Build Directory</link>. |
| 14793 | </para> | 14795 | </para> |
| 14794 | 14796 | ||
| 14795 | <para> | 14797 | <para> |
| @@ -14924,7 +14926,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
| 14924 | <para role="glossdeffirst"> | 14926 | <para role="glossdeffirst"> |
| 14925 | <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> | 14927 | <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> |
| 14926 | The top-level | 14928 | The top-level |
| 14927 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. | 14929 | <link linkend='build-directory'>Build Directory</link>. |
| 14928 | BitBake automatically sets this variable when you | 14930 | BitBake automatically sets this variable when you |
| 14929 | initialize your build environment using either | 14931 | initialize your build environment using either |
| 14930 | <link linkend='structure-core-script'><filename>&OE_INIT_FILE;</filename></link> | 14932 | <link linkend='structure-core-script'><filename>&OE_INIT_FILE;</filename></link> |
diff --git a/documentation/ref-manual/technical-details.xml b/documentation/ref-manual/technical-details.xml index 0c949880e7..b2f1048f2e 100644 --- a/documentation/ref-manual/technical-details.xml +++ b/documentation/ref-manual/technical-details.xml | |||
| @@ -172,7 +172,7 @@ | |||
| 172 | distribution configuration options, compiler tuning options, general common configuration | 172 | distribution configuration options, compiler tuning options, general common configuration |
| 173 | options, and user configuration options in <filename>local.conf</filename>, which is found | 173 | options, and user configuration options in <filename>local.conf</filename>, which is found |
| 174 | in the | 174 | in the |
| 175 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. | 175 | <link linkend='build-directory'>Build Directory</link>. |
| 176 | </para> | 176 | </para> |
| 177 | </section> | 177 | </section> |
| 178 | </section> | 178 | </section> |
| @@ -562,7 +562,7 @@ | |||
| 562 | code. | 562 | code. |
| 563 | However, there is still the question of a task's indirect inputs - the | 563 | However, there is still the question of a task's indirect inputs - the |
| 564 | things that were already built and present in the | 564 | things that were already built and present in the |
| 565 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. | 565 | <link linkend='build-directory'>Build Directory</link>. |
| 566 | The checksum (or signature) for a particular task needs to add the hashes | 566 | The checksum (or signature) for a particular task needs to add the hashes |
| 567 | of all the tasks on which the particular task depends. | 567 | of all the tasks on which the particular task depends. |
| 568 | Choosing which dependencies to add is a policy decision. | 568 | Choosing which dependencies to add is a policy decision. |
diff --git a/documentation/ref-manual/usingpoky.xml b/documentation/ref-manual/usingpoky.xml index d1ac18fb2f..9fb74172b5 100644 --- a/documentation/ref-manual/usingpoky.xml +++ b/documentation/ref-manual/usingpoky.xml | |||
| @@ -56,7 +56,8 @@ | |||
| 56 | <para> | 56 | <para> |
| 57 | The <replaceable>build_dir</replaceable> argument is optional and specifies the directory the | 57 | The <replaceable>build_dir</replaceable> argument is optional and specifies the directory the |
| 58 | OpenEmbedded build system uses for the build - | 58 | OpenEmbedded build system uses for the build - |
| 59 | the <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. | 59 | the |
| 60 | <link linkend='build-directory'>Build Directory</link>. | ||
| 60 | If you do not specify a Build Directory, it defaults to a directory | 61 | If you do not specify a Build Directory, it defaults to a directory |
| 61 | named <filename>build</filename> in your current working directory. | 62 | named <filename>build</filename> in your current working directory. |
| 62 | A common practice is to use a different Build Directory for different targets. | 63 | A common practice is to use a different Build Directory for different targets. |
| @@ -142,7 +143,7 @@ | |||
| 142 | <para> | 143 | <para> |
| 143 | Once an image has been built, it often needs to be installed. | 144 | Once an image has been built, it often needs to be installed. |
| 144 | The images and kernels built by the OpenEmbedded build system are placed in the | 145 | The images and kernels built by the OpenEmbedded build system are placed in the |
| 145 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> in | 146 | <link linkend='build-directory'>Build Directory</link> in |
| 146 | <filename class="directory">tmp/deploy/images</filename>. | 147 | <filename class="directory">tmp/deploy/images</filename>. |
| 147 | For information on how to run pre-built images such as <filename>qemux86</filename> | 148 | For information on how to run pre-built images such as <filename>qemux86</filename> |
| 148 | and <filename>qemuarm</filename>, see the | 149 | and <filename>qemuarm</filename>, see the |
| @@ -978,7 +979,7 @@ | |||
| 978 | Removing | 979 | Removing |
| 979 | <link linkend='var-TMPDIR'><filename>TMPDIR</filename></link> | 980 | <link linkend='var-TMPDIR'><filename>TMPDIR</filename></link> |
| 980 | (usually <filename>tmp/</filename>, within the | 981 | (usually <filename>tmp/</filename>, within the |
| 981 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>) | 982 | <link linkend='build-directory'>Build Directory</link>) |
| 982 | can often fix temporary build issues. | 983 | can often fix temporary build issues. |
| 983 | Removing <filename>TMPDIR</filename> is usually a | 984 | Removing <filename>TMPDIR</filename> is usually a |
| 984 | relatively cheap operation, because task output will be | 985 | relatively cheap operation, because task output will be |
| @@ -1101,7 +1102,7 @@ | |||
| 1101 | <link linkend='var-BUILDHISTORY_COMMIT'><filename>BUILDHISTORY_COMMIT</filename></link> | 1102 | <link linkend='var-BUILDHISTORY_COMMIT'><filename>BUILDHISTORY_COMMIT</filename></link> |
| 1102 | variable to "1" at the end of your | 1103 | variable to "1" at the end of your |
| 1103 | <filename>conf/local.conf</filename> file found in the | 1104 | <filename>conf/local.conf</filename> file found in the |
| 1104 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>: | 1105 | <link linkend='build-directory'>Build Directory</link>: |
| 1105 | <literallayout class='monospaced'> | 1106 | <literallayout class='monospaced'> |
| 1106 | INHERIT += "buildhistory" | 1107 | INHERIT += "buildhistory" |
| 1107 | BUILDHISTORY_COMMIT = "1" | 1108 | BUILDHISTORY_COMMIT = "1" |
| @@ -1359,7 +1360,7 @@ | |||
| 1359 | you can enable writing only image information without | 1360 | you can enable writing only image information without |
| 1360 | any history by adding the following to your | 1361 | any history by adding the following to your |
| 1361 | <filename>conf/local.conf</filename> file found in the | 1362 | <filename>conf/local.conf</filename> file found in the |
| 1362 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>: | 1363 | <link linkend='build-directory'>Build Directory</link>: |
| 1363 | <literallayout class='monospaced'> | 1364 | <literallayout class='monospaced'> |
| 1364 | INHERIT += "buildhistory" | 1365 | INHERIT += "buildhistory" |
| 1365 | BUILDHISTORY_COMMIT = "0" | 1366 | BUILDHISTORY_COMMIT = "0" |
| @@ -1645,7 +1646,7 @@ | |||
| 1645 | <filename>sync()</filename> calls into the | 1646 | <filename>sync()</filename> calls into the |
| 1646 | file system on the principle that if there was a significant | 1647 | file system on the principle that if there was a significant |
| 1647 | failure, the | 1648 | failure, the |
| 1648 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> | 1649 | <link linkend='build-directory'>Build Directory</link> |
| 1649 | contents could easily be rebuilt. | 1650 | contents could easily be rebuilt. |
| 1650 | </para></listitem> | 1651 | </para></listitem> |
| 1651 | <listitem><para> | 1652 | <listitem><para> |
diff --git a/documentation/sdk-manual/sdk-appendix-customizing.xml b/documentation/sdk-manual/sdk-appendix-customizing.xml index 965cccc2ca..1317a79ea8 100644 --- a/documentation/sdk-manual/sdk-appendix-customizing.xml +++ b/documentation/sdk-manual/sdk-appendix-customizing.xml | |||
| @@ -289,7 +289,7 @@ | |||
| 289 | for the SDK alone, create a | 289 | for the SDK alone, create a |
| 290 | <filename>conf/sdk-extra.conf</filename> either in | 290 | <filename>conf/sdk-extra.conf</filename> either in |
| 291 | your | 291 | your |
| 292 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> | 292 | <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink> |
| 293 | or within any layer and put your | 293 | or within any layer and put your |
| 294 | <filename>SSTATE_MIRRORS</filename> setting within | 294 | <filename>SSTATE_MIRRORS</filename> setting within |
| 295 | that file. | 295 | that file. |
diff --git a/documentation/sdk-manual/sdk-appendix-mars.xml b/documentation/sdk-manual/sdk-appendix-mars.xml index 9957057e99..d960b1009d 100644 --- a/documentation/sdk-manual/sdk-appendix-mars.xml +++ b/documentation/sdk-manual/sdk-appendix-mars.xml | |||
| @@ -392,7 +392,7 @@ | |||
| 392 | <filename>Build System Derived Toolchain:</filename></emphasis> | 392 | <filename>Build System Derived Toolchain:</filename></emphasis> |
| 393 | Select this type if you built the | 393 | Select this type if you built the |
| 394 | toolchain as part of the | 394 | toolchain as part of the |
| 395 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. | 395 | <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>. |
| 396 | When you select | 396 | When you select |
| 397 | <filename>Build system derived toolchain</filename>, | 397 | <filename>Build system derived toolchain</filename>, |
| 398 | you are using the toolchain built and | 398 | you are using the toolchain built and |
| @@ -418,7 +418,7 @@ | |||
| 418 | toolchain, the path you provide for the | 418 | toolchain, the path you provide for the |
| 419 | <filename>Toolchain Root Location</filename> | 419 | <filename>Toolchain Root Location</filename> |
| 420 | field is the | 420 | field is the |
| 421 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> | 421 | <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink> |
| 422 | from which you run the | 422 | from which you run the |
| 423 | <filename>bitbake</filename> command (e.g | 423 | <filename>bitbake</filename> command (e.g |
| 424 | <filename>/home/scottrif/poky/build</filename>).</para> | 424 | <filename>/home/scottrif/poky/build</filename>).</para> |
| @@ -438,7 +438,7 @@ | |||
| 438 | <ulink url='https://wiki.yoctoproject.org/wiki/TipsAndTricks/RunningEclipseAgainstBuiltImage'>wiki</ulink>. | 438 | <ulink url='https://wiki.yoctoproject.org/wiki/TipsAndTricks/RunningEclipseAgainstBuiltImage'>wiki</ulink>. |
| 439 | If so, the <filename>MY_QEMU_ROOTFS</filename> | 439 | If so, the <filename>MY_QEMU_ROOTFS</filename> |
| 440 | directory is found in the | 440 | directory is found in the |
| 441 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> | 441 | <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink> |
| 442 | and you would browse to and select that directory | 442 | and you would browse to and select that directory |
| 443 | (e.g. <filename>/home/scottrif/build/MY_QEMU_ROOTFS</filename>). | 443 | (e.g. <filename>/home/scottrif/build/MY_QEMU_ROOTFS</filename>). |
| 444 | </para> | 444 | </para> |
| @@ -487,7 +487,7 @@ | |||
| 487 | <filename>Build system derived toolchain</filename>, | 487 | <filename>Build system derived toolchain</filename>, |
| 488 | the target kernel you built will be located in | 488 | the target kernel you built will be located in |
| 489 | the | 489 | the |
| 490 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> | 490 | <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink> |
| 491 | in | 491 | in |
| 492 | <filename>tmp/deploy/images/<replaceable>machine</replaceable></filename> | 492 | <filename>tmp/deploy/images/<replaceable>machine</replaceable></filename> |
| 493 | directory. | 493 | directory. |
diff --git a/documentation/sdk-manual/sdk-intro.xml b/documentation/sdk-manual/sdk-intro.xml index 68401690de..47b9bc7ba1 100644 --- a/documentation/sdk-manual/sdk-intro.xml +++ b/documentation/sdk-manual/sdk-intro.xml | |||
| @@ -215,7 +215,7 @@ | |||
| 215 | built-in <filename>devtool</filename> functionality. | 215 | built-in <filename>devtool</filename> functionality. |
| 216 | This toolchain is created by running a SDK installer script | 216 | This toolchain is created by running a SDK installer script |
| 217 | or through a | 217 | or through a |
| 218 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> | 218 | <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink> |
| 219 | that is based on your Metadata configuration or extension for | 219 | that is based on your Metadata configuration or extension for |
| 220 | your targeted device. | 220 | your targeted device. |
| 221 | The cross-toolchain works with a matching target sysroot. | 221 | The cross-toolchain works with a matching target sysroot. |
diff --git a/documentation/sdk-manual/sdk-working-projects.xml b/documentation/sdk-manual/sdk-working-projects.xml index 54bc4d739d..526d9208a3 100644 --- a/documentation/sdk-manual/sdk-working-projects.xml +++ b/documentation/sdk-manual/sdk-working-projects.xml | |||
| @@ -894,7 +894,7 @@ | |||
| 894 | </emphasis> | 894 | </emphasis> |
| 895 | Select this type if you built the | 895 | Select this type if you built the |
| 896 | toolchain as part of the | 896 | toolchain as part of the |
| 897 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. | 897 | <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>. |
| 898 | When you select | 898 | When you select |
| 899 | <filename>Build system derived toolchain</filename>, | 899 | <filename>Build system derived toolchain</filename>, |
| 900 | you are using the toolchain built | 900 | you are using the toolchain built |
| @@ -925,7 +925,7 @@ | |||
| 925 | the | 925 | the |
| 926 | <filename>Toolchain Root Location</filename> | 926 | <filename>Toolchain Root Location</filename> |
| 927 | field is the | 927 | field is the |
| 928 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> | 928 | <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink> |
| 929 | from which you run the | 929 | from which you run the |
| 930 | <filename>bitbake</filename> command (e.g | 930 | <filename>bitbake</filename> command (e.g |
| 931 | <filename>/home/scottrif/poky/build</filename>). | 931 | <filename>/home/scottrif/poky/build</filename>). |
| @@ -949,7 +949,7 @@ | |||
| 949 | If so, the | 949 | If so, the |
| 950 | <filename>MY_QEMU_ROOTFS</filename> | 950 | <filename>MY_QEMU_ROOTFS</filename> |
| 951 | directory is found in the | 951 | directory is found in the |
| 952 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> | 952 | <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink> |
| 953 | and you would browse to and select that | 953 | and you would browse to and select that |
| 954 | directory (e.g. | 954 | directory (e.g. |
| 955 | <filename>/home/scottrif/poky/build/MY_QEMU_ROOTFS</filename>). | 955 | <filename>/home/scottrif/poky/build/MY_QEMU_ROOTFS</filename>). |
| @@ -1003,7 +1003,7 @@ | |||
| 1003 | <filename>Build system derived toolchain</filename>, | 1003 | <filename>Build system derived toolchain</filename>, |
| 1004 | the target kernel you built will be located | 1004 | the target kernel you built will be located |
| 1005 | in the | 1005 | in the |
| 1006 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> | 1006 | <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink> |
| 1007 | in | 1007 | in |
| 1008 | <filename>tmp/deploy/images/<replaceable>machine</replaceable></filename> | 1008 | <filename>tmp/deploy/images/<replaceable>machine</replaceable></filename> |
| 1009 | directory. | 1009 | directory. |
diff --git a/documentation/toaster-manual/toaster-manual-reference.xml b/documentation/toaster-manual/toaster-manual-reference.xml index 3a46b61b73..9bd6127f3c 100644 --- a/documentation/toaster-manual/toaster-manual-reference.xml +++ b/documentation/toaster-manual/toaster-manual-reference.xml | |||
| @@ -879,7 +879,7 @@ | |||
| 879 | When using <filename>manage.py</filename> commands given | 879 | When using <filename>manage.py</filename> commands given |
| 880 | a default configuration, you must be sure that your | 880 | a default configuration, you must be sure that your |
| 881 | working directory is set to the | 881 | working directory is set to the |
| 882 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. | 882 | <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>. |
| 883 | Using <filename>manage.py</filename> commands from the | 883 | Using <filename>manage.py</filename> commands from the |
| 884 | Build Directory allows Toaster to find the | 884 | Build Directory allows Toaster to find the |
| 885 | <filename>toaster.sqlite</filename> file, which is located | 885 | <filename>toaster.sqlite</filename> file, which is located |
diff --git a/documentation/toaster-manual/toaster-manual-setup-and-use.xml b/documentation/toaster-manual/toaster-manual-setup-and-use.xml index 966c35d4d3..77291c1eea 100644 --- a/documentation/toaster-manual/toaster-manual-setup-and-use.xml +++ b/documentation/toaster-manual/toaster-manual-setup-and-use.xml | |||
| @@ -145,7 +145,7 @@ | |||
| 145 | <listitem><para> | 145 | <listitem><para> |
| 146 | From the directory containing the Toaster database, | 146 | From the directory containing the Toaster database, |
| 147 | which by default is the | 147 | which by default is the |
| 148 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>, | 148 | <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>, |
| 149 | invoke the <filename>createsuperuser</filename> command | 149 | invoke the <filename>createsuperuser</filename> command |
| 150 | from <filename>manage.py</filename>: | 150 | from <filename>manage.py</filename>: |
| 151 | <literallayout class='monospaced'> | 151 | <literallayout class='monospaced'> |
| @@ -378,7 +378,7 @@ | |||
| 378 | <para> | 378 | <para> |
| 379 | This line also runs the <filename>checksettings</filename> | 379 | This line also runs the <filename>checksettings</filename> |
| 380 | command, which configures the location of the Toaster | 380 | command, which configures the location of the Toaster |
| 381 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build directory</ulink>. | 381 | <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build directory</ulink>. |
| 382 | The Toaster root directory <filename>TOASTER_DIR</filename> | 382 | The Toaster root directory <filename>TOASTER_DIR</filename> |
| 383 | determines where the Toaster build directory | 383 | determines where the Toaster build directory |
| 384 | is created on the file system. | 384 | is created on the file system. |
diff --git a/documentation/yocto-project-qs/yocto-project-qs.xml b/documentation/yocto-project-qs/yocto-project-qs.xml index 5b64e0f6fe..1d9bd9f2e8 100644 --- a/documentation/yocto-project-qs/yocto-project-qs.xml +++ b/documentation/yocto-project-qs/yocto-project-qs.xml | |||
| @@ -528,7 +528,7 @@ | |||
| 528 | $ source &OE_INIT_FILE; | 528 | $ source &OE_INIT_FILE; |
| 529 | </literallayout> | 529 | </literallayout> |
| 530 | Among other things, the script creates the | 530 | Among other things, the script creates the |
| 531 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>, | 531 | <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>, |
| 532 | which is <filename>build</filename> in this case | 532 | which is <filename>build</filename> in this case |
| 533 | and is located in the | 533 | and is located in the |
| 534 | <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>. | 534 | <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>. |
