summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual/technical-details.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/technical-details.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/technical-details.xml')
-rw-r--r--documentation/ref-manual/technical-details.xml25
1 files changed, 17 insertions, 8 deletions
diff --git a/documentation/ref-manual/technical-details.xml b/documentation/ref-manual/technical-details.xml
index d34be750e3..8560e9aa4f 100644
--- a/documentation/ref-manual/technical-details.xml
+++ b/documentation/ref-manual/technical-details.xml
@@ -442,7 +442,10 @@
442 works on a per-task basis rather than a per-recipe basis. 442 works on a per-task basis rather than a per-recipe basis.
443 You might wonder why using a per-task basis is preferred over a per-recipe basis. 443 You might wonder why using a per-task basis is preferred over a per-recipe basis.
444 To help explain, consider having the IPK packaging backend enabled and then switching to DEB. 444 To help explain, consider having the IPK packaging backend enabled and then switching to DEB.
445 In this case, <filename>do_install</filename> and <filename>do_package</filename> 445 In this case,
446 <link linkend='ref-tasks-install'><filename>do_install</filename></link>
447 and
448 <link linkend='ref-tasks-package'><filename>do_package</filename></link>
446 outputs are still valid. 449 outputs are still valid.
447 However, with a per-recipe approach, the build would not include the 450 However, with a per-recipe approach, the build would not include the
448 <filename>.deb</filename> files. 451 <filename>.deb</filename> files.
@@ -643,8 +646,10 @@
643 <para> 646 <para>
644 There are two types of output, one is just about creating a directory 647 There are two types of output, one is just about creating a directory
645 in <link linkend='var-WORKDIR'><filename>WORKDIR</filename></link>. 648 in <link linkend='var-WORKDIR'><filename>WORKDIR</filename></link>.
646 A good example is the output of either <filename>do_install</filename> or 649 A good example is the output of either
647 <filename>do_package</filename>. 650 <link linkend='ref-tasks-install'><filename>do_install</filename></link>
651 or
652 <link linkend='ref-tasks-package'><filename>do_package</filename></link>.
648 The other type of output occurs when a set of data is merged into a shared directory 653 The other type of output occurs when a set of data is merged into a shared directory
649 tree such as the sysroot. 654 tree such as the sysroot.
650 </para> 655 </para>
@@ -653,8 +658,9 @@
653 The Yocto Project team has tried to keep the details of the 658 The Yocto Project team has tried to keep the details of the
654 implementation hidden in <filename>sstate</filename> class. 659 implementation hidden in <filename>sstate</filename> class.
655 From a user's perspective, adding shared state wrapping to a task 660 From a user's perspective, adding shared state wrapping to a task
656 is as simple as this <filename>do_deploy</filename> example taken 661 is as simple as this
657 from the 662 <link linkend='ref-tasks-deploy'><filename>do_deploy</filename></link>
663 example taken from the
658 <link linkend='ref-classes-deploy'><filename>deploy</filename></link> 664 <link linkend='ref-classes-deploy'><filename>deploy</filename></link>
659 class: 665 class:
660 <literallayout class='monospaced'> 666 <literallayout class='monospaced'>
@@ -737,7 +743,9 @@
737 743
738 <para> 744 <para>
739 As a real world example, the aim is when building an IPK-based image, 745 As a real world example, the aim is when building an IPK-based image,
740 only the <filename>do_package_write_ipk</filename> tasks would have their 746 only the
747 <link linkend='ref-tasks-package_write_ipk'><filename>do_package_write_ipk</filename></link>
748 tasks would have their
741 shared state packages fetched and extracted. 749 shared state packages fetched and extracted.
742 Since the sysroot is not used, it would never get extracted. 750 Since the sysroot is not used, it would never get extracted.
743 This is another reason why a task-based approach is preferred over a 751 This is another reason why a task-based approach is preferred over a
@@ -834,8 +842,9 @@
834 The steps you can take are as simple as changing a function's 842 The steps you can take are as simple as changing a function's
835 comments in the source code. 843 comments in the source code.
836 For example, to invalidate package shared state files, change 844 For example, to invalidate package shared state files, change
837 the comment statements of <filename>do_package</filename> or 845 the comment statements of
838 the comments of one of the functions it calls. 846 <link linkend='ref-tasks-package'><filename>do_package</filename></link>
847 or the comments of one of the functions it calls.
839 Even though the change is purely cosmetic, it causes the 848 Even though the change is purely cosmetic, it causes the
840 checksum to be recalculated and forces the OpenEmbedded build 849 checksum to be recalculated and forces the OpenEmbedded build
841 system to run the task again. 850 system to run the task again.