summaryrefslogtreecommitdiffstats
path: root/documentation/dev-manual
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2014-05-09 14:37:53 +0300
committerRichard Purdie <richard.purdie@linuxfoundation.org>2014-05-13 07:50:58 +0100
commit8e90933d3d4c97043de457f03b1fb28bc37d4a29 (patch)
treeed547940d57b97018753bf4ae2a7167500da29ed /documentation/dev-manual
parente867967d606a9742008a94d16f81e365e6371ec3 (diff)
downloadpoky-8e90933d3d4c97043de457f03b1fb28bc37d4a29.tar.gz
dev-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 dev-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: 78f91987b0ad9906571ec7888334301492361822) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/dev-manual')
-rw-r--r--documentation/dev-manual/dev-manual-common-tasks.xml37
-rw-r--r--documentation/dev-manual/dev-manual-newbie.xml5
2 files changed, 27 insertions, 15 deletions
diff --git a/documentation/dev-manual/dev-manual-common-tasks.xml b/documentation/dev-manual/dev-manual-common-tasks.xml
index 01add16a60..aad8fb7787 100644
--- a/documentation/dev-manual/dev-manual-common-tasks.xml
+++ b/documentation/dev-manual/dev-manual-common-tasks.xml
@@ -1650,13 +1650,17 @@
1650 </para> 1650 </para>
1651 1651
1652 <para> 1652 <para>
1653 The <filename>do_fetch</filename> task uses the prefix of 1653 The
1654 each entry in the <filename>SRC_URI</filename> variable value 1654 <ulink url='&YOCTO_DOCS_REF_URL;#ref-tasks-fetch'><filename>do_fetch</filename></ulink>
1655 to determine what fetcher to use to get your source files. 1655 task uses the prefix of each entry in the
1656 <filename>SRC_URI</filename> variable value to determine what
1657 fetcher to use to get your source files.
1656 It is the <filename>SRC_URI</filename> variable that triggers 1658 It is the <filename>SRC_URI</filename> variable that triggers
1657 the fetcher. 1659 the fetcher.
1658 The <filename>do_patch</filename> task uses the variable after 1660 The
1659 source is fetched to apply patches. 1661 <ulink url='&YOCTO_DOCS_REF_URL;#ref-tasks-patch'><filename>do_patch</filename></ulink>
1662 task uses the variable after source is fetched to apply
1663 patches.
1660 The OpenEmbedded build system uses 1664 The OpenEmbedded build system uses
1661 <ulink url='&YOCTO_DOCS_REF_URL;#var-FILESOVERRIDES'><filename>FILESOVERRIDES</filename></ulink> 1665 <ulink url='&YOCTO_DOCS_REF_URL;#var-FILESOVERRIDES'><filename>FILESOVERRIDES</filename></ulink>
1662 for scanning directory locations for local files in 1666 for scanning directory locations for local files in
@@ -1694,7 +1698,9 @@
1694 in a typical archive extension (e.g. <filename>.tar</filename>, 1698 in a typical archive extension (e.g. <filename>.tar</filename>,
1695 <filename>.tar.gz</filename>, <filename>.tar.bz2</filename>, 1699 <filename>.tar.gz</filename>, <filename>.tar.bz2</filename>,
1696 <filename>.zip</filename>, and so forth), are automatically 1700 <filename>.zip</filename>, and so forth), are automatically
1697 extracted during the <filename>do_unpack</filename> task. 1701 extracted during the
1702 <ulink url='&YOCTO_DOCS_REF_URL;#ref-tasks-unpack'><filename>do_unpack</filename></ulink>
1703 task.
1698 For another example that specifies these types of files, see 1704 For another example that specifies these types of files, see
1699 the 1705 the
1700 "<link linkend='new-recipe-autotooled-package'>Autotooled Package</link>" 1706 "<link linkend='new-recipe-autotooled-package'>Autotooled Package</link>"
@@ -1811,8 +1817,9 @@
1811 <title>Unpacking Code</title> 1817 <title>Unpacking Code</title>
1812 1818
1813 <para> 1819 <para>
1814 During the build, the <filename>do_unpack</filename> task 1820 During the build, the
1815 unpacks the source with 1821 <ulink url='&YOCTO_DOCS_REF_URL;#ref-tasks-unpack'><filename>do_unpack</filename></ulink>
1822 task unpacks the source with
1816 <filename>${</filename><ulink url='&YOCTO_DOCS_REF_URL;#var-S'><filename>S</filename></ulink><filename>}</filename> 1823 <filename>${</filename><ulink url='&YOCTO_DOCS_REF_URL;#var-S'><filename>S</filename></ulink><filename>}</filename>
1817 pointing to where it is unpacked. 1824 pointing to where it is unpacked.
1818 </para> 1825 </para>
@@ -1846,8 +1853,9 @@
1846 Any files mentioned in <filename>SRC_URI</filename> whose 1853 Any files mentioned in <filename>SRC_URI</filename> whose
1847 names end in <filename>.patch</filename> or 1854 names end in <filename>.patch</filename> or
1848 <filename>.diff</filename> are treated as patches. 1855 <filename>.diff</filename> are treated as patches.
1849 The <filename>do_patch</filename> task automatically applies 1856 The
1850 these patches. 1857 <ulink url='&YOCTO_DOCS_REF_URL;#ref-tasks-patch'><filename>do_patch</filename></ulink>
1858 task automatically applies these patches.
1851 </para> 1859 </para>
1852 1860
1853 <para> 1861 <para>
@@ -2021,7 +2029,8 @@
2021 the 2029 the
2022 <ulink url='&YOCTO_DOCS_REF_URL;#ref-classes-autotools'><filename>autotools</filename></ulink> 2030 <ulink url='&YOCTO_DOCS_REF_URL;#ref-classes-autotools'><filename>autotools</filename></ulink>
2023 class and your recipe does not have to contain a 2031 class and your recipe does not have to contain a
2024 <filename>do_configure</filename> task. 2032 <ulink url='&YOCTO_DOCS_REF_URL;#ref-tasks-configure'><filename>do_configure</filename></ulink>
2033 task.
2025 However, you might still want to make some adjustments. 2034 However, you might still want to make some adjustments.
2026 For example, you can set 2035 For example, you can set
2027 <ulink url='&YOCTO_DOCS_REF_URL;#var-EXTRA_OECONF'><filename>EXTRA_OECONF</filename></ulink> 2036 <ulink url='&YOCTO_DOCS_REF_URL;#var-EXTRA_OECONF'><filename>EXTRA_OECONF</filename></ulink>
@@ -2037,7 +2046,8 @@
2037 the 2046 the
2038 <ulink url='&YOCTO_DOCS_REF_URL;#ref-classes-cmake'><filename>cmake</filename></ulink> 2047 <ulink url='&YOCTO_DOCS_REF_URL;#ref-classes-cmake'><filename>cmake</filename></ulink>
2039 class and your recipe does not have to contain a 2048 class and your recipe does not have to contain a
2040 <filename>do_configure</filename> task. 2049 <ulink url='&YOCTO_DOCS_REF_URL;#ref-tasks-configure'><filename>do_configure</filename></ulink>
2050 task.
2041 You can make some adjustments by setting 2051 You can make some adjustments by setting
2042 <ulink url='&YOCTO_DOCS_REF_URL;#var-EXTRA_OECMAKE'><filename>EXTRA_OECMAKE</filename></ulink> 2052 <ulink url='&YOCTO_DOCS_REF_URL;#var-EXTRA_OECMAKE'><filename>EXTRA_OECMAKE</filename></ulink>
2043 to pass any needed configure options that are specific 2053 to pass any needed configure options that are specific
@@ -2049,7 +2059,8 @@
2049 software is built using some method other than Autotools 2059 software is built using some method other than Autotools
2050 or CMake. 2060 or CMake.
2051 If this is the case, you normally need to provide a 2061 If this is the case, you normally need to provide a
2052 <filename>do_configure</filename> task in your recipe 2062 <ulink url='&YOCTO_DOCS_REF_URL;#ref-tasks-configure'><filename>do_configure</filename></ulink>
2063 task in your recipe
2053 unless, of course, there is nothing to configure. 2064 unless, of course, there is nothing to configure.
2054 </para> 2065 </para>
2055 <para>Even if your software is not being built by 2066 <para>Even if your software is not being built by
diff --git a/documentation/dev-manual/dev-manual-newbie.xml b/documentation/dev-manual/dev-manual-newbie.xml
index 37fa5afdd5..434a7d15a5 100644
--- a/documentation/dev-manual/dev-manual-newbie.xml
+++ b/documentation/dev-manual/dev-manual-newbie.xml
@@ -804,8 +804,9 @@
804 section.</para></listitem> 804 section.</para></listitem>
805 <listitem><para><emphasis>Task:</emphasis> 805 <listitem><para><emphasis>Task:</emphasis>
806 A unit of execution for BitBake (e.g. 806 A unit of execution for BitBake (e.g.
807 <filename>do_compile</filename>, 807 <ulink url='&YOCTO_DOCS_REF_URL;#ref-tasks-compile'><filename>do_compile</filename></ulink>,
808 <filename>do_fetch</filename>, <filename>do_patch</filename>, 808 <ulink url='&YOCTO_DOCS_REF_URL;#ref-tasks-fetch'><filename>do_fetch</filename></ulink>,
809 <ulink url='&YOCTO_DOCS_REF_URL;#ref-tasks-patch'><filename>do_patch</filename></ulink>,
809 and so forth). 810 and so forth).
810 </para></listitem> 811 </para></listitem>
811 <listitem><para><emphasis>Upstream:</emphasis> A reference to source code or repositories 812 <listitem><para><emphasis>Upstream:</emphasis> A reference to source code or repositories