summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual/ref-variables.xml
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2014-05-09 14:19:48 +0300
committerRichard Purdie <richard.purdie@linuxfoundation.org>2014-05-13 07:50:58 +0100
commite867967d606a9742008a94d16f81e365e6371ec3 (patch)
treeb433593b9b310e7203dd6ededd735f7c40bf916c /documentation/ref-manual/ref-variables.xml
parent2f4d0722ce42e6381228b335d2bbd5a5901bb594 (diff)
downloadpoky-e867967d606a9742008a94d16f81e365e6371ec3.tar.gz
ref-manual: Added links to new do_* sections.
With the creation of the new chapter that documents the 51 tasks defined by the OpenEmbedded build system, the remainder of the ref-manual had many first-instance occurrences of do_* task names that could be cross-referenced to the new sections. I have added these links. (From yocto-docs rev: 2ff39bd226a1d8f11924283bbaa3542a9d936ba3) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/ref-manual/ref-variables.xml')
-rw-r--r--documentation/ref-manual/ref-variables.xml67
1 files changed, 42 insertions, 25 deletions
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml
index 4ff1a21323..9a027375fa 100644
--- a/documentation/ref-manual/ref-variables.xml
+++ b/documentation/ref-manual/ref-variables.xml
@@ -189,7 +189,8 @@
189 Finally, if the file referenced has not been 189 Finally, if the file referenced has not been
190 renamed, the alternatives system will rename it to 190 renamed, the alternatives system will rename it to
191 avoid the need to rename alternative files in the 191 avoid the need to rename alternative files in the
192 <filename>do_install</filename> task while 192 <link linkend='ref-tasks-install'><filename>do_install</filename></link>
193 task while
193 retaining support for the command if necessary. 194 retaining support for the command if necessary.
194 </para> 195 </para>
195 </note> 196 </note>
@@ -1434,7 +1435,9 @@
1434 <para> 1435 <para>
1435 The destination directory. 1436 The destination directory.
1436 The location in the <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> 1437 The location in the <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>
1437 where components are installed by the <filename>do_install</filename> task. 1438 where components are installed by the
1439 <link linkend='ref-tasks-install'><filename>do_install</filename></link>
1440 task.
1438 This location defaults to: 1441 This location defaults to:
1439 <literallayout class='monospaced'> 1442 <literallayout class='monospaced'>
1440 ${WORKDIR}/image 1443 ${WORKDIR}/image
@@ -1518,8 +1521,9 @@
1518 DEPENDS = "b" 1521 DEPENDS = "b"
1519 </literallayout> 1522 </literallayout>
1520 Here, the dependency is such that the 1523 Here, the dependency is such that the
1521 <filename>do_configure</filename> task for recipe "a" 1524 <link linkend='ref-tasks-configure'><filename>do_configure</filename></link>
1522 depends on the <filename>do_populate_sysroot</filename> 1525 task for recipe "a" depends on the
1526 <link linkend='ref-tasks-populate_sysroot'><filename>do_populate_sysroot</filename></link>
1523 task of recipe "b". 1527 task of recipe "b".
1524 This means anything that recipe "b" puts into sysroot 1528 This means anything that recipe "b" puts into sysroot
1525 is available when recipe "a" is configuring itself. 1529 is available when recipe "a" is configuring itself.
@@ -1750,8 +1754,9 @@
1750 In most cases, the presence or absence of a feature in 1754 In most cases, the presence or absence of a feature in
1751 <filename>DISTRO_FEATURES</filename> is translated to the 1755 <filename>DISTRO_FEATURES</filename> is translated to the
1752 appropriate option supplied to the configure script 1756 appropriate option supplied to the configure script
1753 during <filename>do_configure</filename> for recipes that 1757 during the
1754 optionally support the feature. 1758 <link linkend='ref-tasks-configure'><filename>do_configure</filename></link>
1759 task for recipes that optionally support the feature.
1755 For example, specifying "x11" in 1760 For example, specifying "x11" in
1756 <filename>DISTRO_FEATURES</filename>, causes 1761 <filename>DISTRO_FEATURES</filename>, causes
1757 every piece of software built for the target that can 1762 every piece of software built for the target that can
@@ -2763,8 +2768,9 @@
2763 <glossdef> 2768 <glossdef>
2764 <para> 2769 <para>
2765 Extra options passed to the <filename>make</filename> 2770 Extra options passed to the <filename>make</filename>
2766 command during the <filename>do_compile</filename> task 2771 command during the
2767 that specify parallel compilation. 2772 <link linkend='ref-tasks-compile'><filename>do_compile</filename></link>
2773 task that specify parallel compilation.
2768 This variable usually takes the form of 2774 This variable usually takes the form of
2769 <filename>-j 4</filename>, where the number 2775 <filename>-j 4</filename>, where the number
2770 represents the maximum number of parallel threads 2776 represents the maximum number of parallel threads
@@ -3222,7 +3228,9 @@
3222 <glossdef> 3228 <glossdef>
3223 <para> 3229 <para>
3224 The location of the root filesystem while it is under 3230 The location of the root filesystem while it is under
3225 construction (i.e. during <filename>do_rootfs</filename>). 3231 construction (i.e. during the
3232 <link linkend='ref-tasks-rootfs'><filename>do_rootfs</filename></link>
3233 task).
3226 This variable is not configurable. 3234 This variable is not configurable.
3227 Do not change it. 3235 Do not change it.
3228 </para> 3236 </para>
@@ -5395,7 +5403,9 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
5395 produced, then the other package will be broken. 5403 produced, then the other package will be broken.
5396 Thus, if you attempt to include that package in an image, 5404 Thus, if you attempt to include that package in an image,
5397 you will get a dependency failure from the packaging system 5405 you will get a dependency failure from the packaging system
5398 during <filename>do_rootfs</filename>. 5406 during the
5407 <link linkend='ref-tasks-rootfs'><filename>do_rootfs</filename></link>
5408 task.
5399 </para> 5409 </para>
5400 <para> 5410 <para>
5401 Typically, if there is a chance that such a situation can 5411 Typically, if there is a chance that such a situation can
@@ -5419,8 +5429,9 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
5419 <glossdef> 5429 <glossdef>
5420 <para> 5430 <para>
5421 Extra options passed to the <filename>make</filename> 5431 Extra options passed to the <filename>make</filename>
5422 command during the <filename>do_compile</filename> task 5432 command during the
5423 in order to specify parallel compilation on the local 5433 <link linkend='ref-tasks-compile'><filename>do_compile</filename></link>
5434 task in order to specify parallel compilation on the local
5424 build host. 5435 build host.
5425 This variable is usually in the form "-j &lt;x&gt;", 5436 This variable is usually in the form "-j &lt;x&gt;",
5426 where x represents the maximum number of parallel threads 5437 where x represents the maximum number of parallel threads
@@ -5447,8 +5458,8 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
5447 <para> 5458 <para>
5448 Extra options passed to the 5459 Extra options passed to the
5449 <filename>make install</filename> command during the 5460 <filename>make install</filename> command during the
5450 <filename>do_install</filename> task in order to specify 5461 <link linkend='ref-tasks-install'><filename>do_install</filename></link>
5451 parallel installation. 5462 task in order to specify parallel installation.
5452 This variable defaults to the value of 5463 This variable defaults to the value of
5453 <link linkend='var-PARALLEL_MAKE'><filename>PARALLEL_MAKE</filename></link>. 5464 <link linkend='var-PARALLEL_MAKE'><filename>PARALLEL_MAKE</filename></link>.
5454 <note> 5465 <note>
@@ -5488,7 +5499,9 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
5488 <glossdef> 5499 <glossdef>
5489 <para> 5500 <para>
5490 Specifies the utility used to apply patches for a recipe 5501 Specifies the utility used to apply patches for a recipe
5491 during <filename>do_patch</filename>. 5502 during the
5503 <link linkend='ref-tasks-patch'><filename>do_patch</filename></link>
5504 task.
5492 You can specify one of three utilities: "patch", "quilt", or 5505 You can specify one of three utilities: "patch", "quilt", or
5493 "git". 5506 "git".
5494 The default utility used is "quilt" except for the 5507 The default utility used is "quilt" except for the
@@ -5587,9 +5600,9 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
5587 Points to a shared, global-state directory that holds data 5600 Points to a shared, global-state directory that holds data
5588 generated during the packaging process. 5601 generated during the packaging process.
5589 During the packaging process, the 5602 During the packaging process, the
5590 <filename>do_packagedata</filename> task packages 5603 <link linkend='ref-tasks-packagedata'><filename>do_packagedata</filename></link>
5591 data for each recipe and installs it into this temporary, 5604 task packages data for each recipe and installs it into
5592 shared area. 5605 this temporary, shared area.
5593 This directory defaults to the following: 5606 This directory defaults to the following:
5594 <literallayout class='monospaced'> 5607 <literallayout class='monospaced'>
5595 ${STAGING_DIR_HOST}/pkgdata 5608 ${STAGING_DIR_HOST}/pkgdata
@@ -5620,8 +5633,10 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
5620 <glossdef> 5633 <glossdef>
5621 <para> 5634 <para>
5622 Points to a temporary work area used by the 5635 Points to a temporary work area used by the
5623 <filename>do_package</filename> task to write output 5636 <link linkend='ref-tasks-package'><filename>do_package</filename></link>
5624 from the <filename>do_packagedata</filename> task. 5637 task to write output from the
5638 <link linkend='ref-tasks-packagedata'><filename>do_packagedata</filename></link>
5639 task.
5625 The <filename>PKGDESTWORK</filename> location defaults to 5640 The <filename>PKGDESTWORK</filename> location defaults to
5626 the following: 5641 the following:
5627 <literallayout class='monospaced'> 5642 <literallayout class='monospaced'>
@@ -6069,8 +6084,8 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
6069 <para> 6084 <para>
6070 When you use the <filename>RDEPENDS</filename> variable 6085 When you use the <filename>RDEPENDS</filename> variable
6071 in a recipe, you are essentially stating that the recipe's 6086 in a recipe, you are essentially stating that the recipe's
6072 <filename>do_build</filename> task depends on the existence 6087 <link linkend='ref-tasks-build'><filename>do_build</filename></link>
6073 of a specific package. 6088 task depends on the existence of a specific package.
6074 Consider this simple example for two recipes named "a" and 6089 Consider this simple example for two recipes named "a" and
6075 "b" that produce similarly named IPK packages. 6090 "b" that produce similarly named IPK packages.
6076 In this example, the <filename>RDEPENDS</filename> 6091 In this example, the <filename>RDEPENDS</filename>
@@ -6080,8 +6095,9 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
6080 </literallayout> 6095 </literallayout>
6081 Here, the dependency is such that the 6096 Here, the dependency is such that the
6082 <filename>do_build</filename> task for recipe "a" depends 6097 <filename>do_build</filename> task for recipe "a" depends
6083 on the <filename>do_package_write_ipk</filename> task 6098 on the
6084 of recipe "b". 6099 <link linkend='ref-tasks-package_write_ipk'><filename>do_package_write_ipk</filename></link>
6100 task of recipe "b".
6085 This means the package file for "b" must be available when 6101 This means the package file for "b" must be available when
6086 the output for recipe "a" has been completely built. 6102 the output for recipe "a" has been completely built.
6087 More importantly, package "a" will be marked as depending 6103 More importantly, package "a" will be marked as depending
@@ -6126,7 +6142,8 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
6126 <filename>RDEPENDS</filename> variable must appear 6142 <filename>RDEPENDS</filename> variable must appear
6127 as it would in the <filename>PACKAGES</filename> 6143 as it would in the <filename>PACKAGES</filename>
6128 namespace before any renaming of the output package by 6144 namespace before any renaming of the output package by
6129 classes like <filename>debian.bbclass</filename>. 6145 classes like
6146 <link linkend='ref-classes-debian'><filename>debian.bbclass</filename></link>.
6130 </para> 6147 </para>
6131 6148
6132 <para> 6149 <para>