summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual
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/ref-manual
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/ref-manual')
-rw-r--r--documentation/ref-manual/closer-look.xml10
-rw-r--r--documentation/ref-manual/faq.xml5
-rw-r--r--documentation/ref-manual/introduction.xml2
-rw-r--r--documentation/ref-manual/migration.xml2
-rw-r--r--documentation/ref-manual/ref-classes.xml4
-rw-r--r--documentation/ref-manual/ref-devtool-reference.xml2
-rw-r--r--documentation/ref-manual/ref-structure.xml13
-rw-r--r--documentation/ref-manual/ref-variables.xml56
-rw-r--r--documentation/ref-manual/technical-details.xml4
-rw-r--r--documentation/ref-manual/usingpoky.xml13
10 files changed, 58 insertions, 53 deletions
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>