summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual/closer-look.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/closer-look.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/closer-look.xml')
-rw-r--r--documentation/ref-manual/closer-look.xml47
1 files changed, 35 insertions, 12 deletions
diff --git a/documentation/ref-manual/closer-look.xml b/documentation/ref-manual/closer-look.xml
index c223bbb0ce..7546215ae6 100644
--- a/documentation/ref-manual/closer-look.xml
+++ b/documentation/ref-manual/closer-look.xml
@@ -568,7 +568,9 @@
568 Another place the build system can get source files from is 568 Another place the build system can get source files from is
569 through an SCM such as Git or Subversion. 569 through an SCM such as Git or Subversion.
570 In this case, a repository is cloned or checked out. 570 In this case, a repository is cloned or checked out.
571 The <filename>do_fetch</filename> task inside BitBake uses 571 The
572 <link linkend='ref-tasks-fetch'><filename>do_fetch</filename></link>
573 task inside BitBake uses
572 the <link linkend='var-SRC_URI'><filename>SRC_URI</filename></link> 574 the <link linkend='var-SRC_URI'><filename>SRC_URI</filename></link>
573 variable and the argument's prefix to determine the correct 575 variable and the argument's prefix to determine the correct
574 fetcher module. 576 fetcher module.
@@ -664,9 +666,16 @@
664 </para> 666 </para>
665 667
666 <para> 668 <para>
667 BitBake uses the <filename>do_package_write_*</filename> task to 669 BitBake uses the <filename>do_package_write_*</filename> tasks to
668 place generated packages into the package holding area (e.g. 670 place generated packages into the package holding area (e.g.
669 <filename>do_package_write_ipk</filename> for IPK packages). 671 <filename>do_package_write_ipk</filename> for IPK packages).
672 See the
673 "<link linkend='ref-tasks-package_write_deb'><filename>do_package_write_deb</filename></link>",
674 "<link linkend='ref-tasks-package_write_ipk'><filename>do_package_write_ipk</filename></link>",
675 "<link linkend='ref-tasks-package_write_rpm'><filename>do_package_write_rpm</filename></link>",
676 and
677 "<link linkend='ref-tasks-package_write_tar'><filename>do_package_write_tar</filename></link>"
678 sections for additional information.
670 </para> 679 </para>
671 </section> 680 </section>
672 681
@@ -700,8 +709,11 @@
700 </para> 709 </para>
701 710
702 <para> 711 <para>
703 The <filename>do_fetch</filename> and 712 The
704 <filename>do_unpack</filename> tasks fetch the source files 713 <link linkend='ref-tasks-fetch'><filename>do_fetch</filename></link>
714 and
715 <link linkend='ref-tasks-unpack'><filename>do_unpack</filename></link>
716 tasks fetch the source files
705 and unpack them into the work directory. 717 and unpack them into the work directory.
706 By default, everything is accomplished in the 718 By default, everything is accomplished in the
707 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>, 719 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>,
@@ -762,7 +774,9 @@
762 </para> 774 </para>
763 775
764 <para> 776 <para>
765 The <filename>do_patch</filename> task processes recipes by 777 The
778 <link linkend='ref-tasks-patch'><filename>do_patch</filename></link>
779 task processes recipes by
766 using the 780 using the
767 <link linkend='var-SRC_URI'><filename>SRC_URI</filename></link> 781 <link linkend='var-SRC_URI'><filename>SRC_URI</filename></link>
768 variable to locate applicable patch files, which by default 782 variable to locate applicable patch files, which by default
@@ -810,7 +824,8 @@
810 </para> 824 </para>
811 825
812 <para>The configurations handled by the 826 <para>The configurations handled by the
813 <filename>do_configure</filename> task are specific 827 <link linkend='ref-tasks-configure'><filename>do_configure</filename></link>
828 task are specific
814 to source code configuration for the source code 829 to source code configuration for the source code
815 being built by the recipe.</para> 830 being built by the recipe.</para>
816 831
@@ -827,7 +842,8 @@
827 <listitem><para><emphasis><filename>do_compile</filename>:</emphasis> 842 <listitem><para><emphasis><filename>do_compile</filename>:</emphasis>
828 Once a configuration task has been satisfied, BitBake 843 Once a configuration task has been satisfied, BitBake
829 compiles the source using the 844 compiles the source using the
830 <filename>do_compile</filename> task. 845 <link linkend='ref-tasks-compile'><filename>do_compile</filename></link>
846 task.
831 Compilation occurs in the directory pointed to by the 847 Compilation occurs in the directory pointed to by the
832 <link linkend='var-B'><filename>B</filename></link> 848 <link linkend='var-B'><filename>B</filename></link>
833 variable. 849 variable.
@@ -837,7 +853,8 @@
837 directory.</para></listitem> 853 directory.</para></listitem>
838 <listitem><para><emphasis><filename>do_install</filename>:</emphasis> 854 <listitem><para><emphasis><filename>do_install</filename>:</emphasis>
839 Once compilation is done, BitBake executes the 855 Once compilation is done, BitBake executes the
840 <filename>do_install</filename> task. 856 <link linkend='ref-tasks-install'><filename>do_install</filename></link>
857 task.
841 This task copies files from the <filename>B</filename> 858 This task copies files from the <filename>B</filename>
842 directory and places them in a holding area pointed to 859 directory and places them in a holding area pointed to
843 by the 860 by the
@@ -858,8 +875,11 @@
858 </para> 875 </para>
859 876
860 <para> 877 <para>
861 The <filename>do_package</filename> and 878 The
862 <filename>do_packagedata</filename> tasks combine to analyze 879 <link linkend='ref-tasks-package'><filename>do_package</filename></link>
880 and
881 <link linkend='ref-tasks-packagedata'><filename>do_packagedata</filename></link>
882 tasks combine to analyze
863 the files found in the 883 the files found in the
864 <link linkend='var-D'><filename>D</filename></link> directory 884 <link linkend='var-D'><filename>D</filename></link> directory
865 and split them into subsets based on available packages and 885 and split them into subsets based on available packages and
@@ -935,7 +955,9 @@
935 <para> 955 <para>
936 The image generation process consists of several stages and 956 The image generation process consists of several stages and
937 depends on many variables. 957 depends on many variables.
938 The <filename>do_rootfs</filename> task uses these key variables 958 The
959 <link linkend='ref-tasks-rootfs'><filename>do_rootfs</filename></link>
960 task uses these key variables
939 to help create the list of packages to actually install: 961 to help create the list of packages to actually install:
940 <itemizedlist> 962 <itemizedlist>
941 <listitem><para><link linkend='var-IMAGE_INSTALL'><filename>IMAGE_INSTALL</filename></link>: 963 <listitem><para><link linkend='var-IMAGE_INSTALL'><filename>IMAGE_INSTALL</filename></link>:
@@ -1046,7 +1068,8 @@
1046 section. 1068 section.
1047 For information on advantages gained when building a 1069 For information on advantages gained when building a
1048 cross-development toolchain using the 1070 cross-development toolchain using the
1049 <filename>do_populate_sdk</filename> task, see the 1071 <link linkend='ref-tasks-populate_sdk'><filename>do_populate_sdk</filename></link>
1072 task, see the
1050 "<ulink url='&YOCTO_DOCS_ADT_URL;#optionally-building-a-toolchain-installer'>Optionally Building a Toolchain Installer</ulink>" 1073 "<ulink url='&YOCTO_DOCS_ADT_URL;#optionally-building-a-toolchain-installer'>Optionally Building a Toolchain Installer</ulink>"
1051 section in the Yocto Project Application Developer's Guide. 1074 section in the Yocto Project Application Developer's Guide.
1052 </note> 1075 </note>