diff options
author | Scott Rifenbark <scott.m.rifenbark@intel.com> | 2014-05-09 14:37:53 +0300 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2014-05-13 07:50:58 +0100 |
commit | 8e90933d3d4c97043de457f03b1fb28bc37d4a29 (patch) | |
tree | ed547940d57b97018753bf4ae2a7167500da29ed /documentation | |
parent | e867967d606a9742008a94d16f81e365e6371ec3 (diff) | |
download | ast2050-yocto-poky-8e90933d3d4c97043de457f03b1fb28bc37d4a29.zip ast2050-yocto-poky-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')
-rw-r--r-- | documentation/dev-manual/dev-manual-common-tasks.xml | 37 | ||||
-rw-r--r-- | documentation/dev-manual/dev-manual-newbie.xml | 5 |
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 01add16..aad8fb7 100644 --- a/documentation/dev-manual/dev-manual-common-tasks.xml +++ b/documentation/dev-manual/dev-manual-common-tasks.xml @@ -1650,13 +1650,17 @@ </para> <para> - The <filename>do_fetch</filename> task uses the prefix of - each entry in the <filename>SRC_URI</filename> variable value - to determine what fetcher to use to get your source files. + The + <ulink url='&YOCTO_DOCS_REF_URL;#ref-tasks-fetch'><filename>do_fetch</filename></ulink> + task uses the prefix of each entry in the + <filename>SRC_URI</filename> variable value to determine what + fetcher to use to get your source files. It is the <filename>SRC_URI</filename> variable that triggers the fetcher. - The <filename>do_patch</filename> task uses the variable after - source is fetched to apply patches. + The + <ulink url='&YOCTO_DOCS_REF_URL;#ref-tasks-patch'><filename>do_patch</filename></ulink> + task uses the variable after source is fetched to apply + patches. The OpenEmbedded build system uses <ulink url='&YOCTO_DOCS_REF_URL;#var-FILESOVERRIDES'><filename>FILESOVERRIDES</filename></ulink> for scanning directory locations for local files in @@ -1694,7 +1698,9 @@ in a typical archive extension (e.g. <filename>.tar</filename>, <filename>.tar.gz</filename>, <filename>.tar.bz2</filename>, <filename>.zip</filename>, and so forth), are automatically - extracted during the <filename>do_unpack</filename> task. + extracted during the + <ulink url='&YOCTO_DOCS_REF_URL;#ref-tasks-unpack'><filename>do_unpack</filename></ulink> + task. For another example that specifies these types of files, see the "<link linkend='new-recipe-autotooled-package'>Autotooled Package</link>" @@ -1811,8 +1817,9 @@ <title>Unpacking Code</title> <para> - During the build, the <filename>do_unpack</filename> task - unpacks the source with + During the build, the + <ulink url='&YOCTO_DOCS_REF_URL;#ref-tasks-unpack'><filename>do_unpack</filename></ulink> + task unpacks the source with <filename>${</filename><ulink url='&YOCTO_DOCS_REF_URL;#var-S'><filename>S</filename></ulink><filename>}</filename> pointing to where it is unpacked. </para> @@ -1846,8 +1853,9 @@ Any files mentioned in <filename>SRC_URI</filename> whose names end in <filename>.patch</filename> or <filename>.diff</filename> are treated as patches. - The <filename>do_patch</filename> task automatically applies - these patches. + The + <ulink url='&YOCTO_DOCS_REF_URL;#ref-tasks-patch'><filename>do_patch</filename></ulink> + task automatically applies these patches. </para> <para> @@ -2021,7 +2029,8 @@ the <ulink url='&YOCTO_DOCS_REF_URL;#ref-classes-autotools'><filename>autotools</filename></ulink> class and your recipe does not have to contain a - <filename>do_configure</filename> task. + <ulink url='&YOCTO_DOCS_REF_URL;#ref-tasks-configure'><filename>do_configure</filename></ulink> + task. However, you might still want to make some adjustments. For example, you can set <ulink url='&YOCTO_DOCS_REF_URL;#var-EXTRA_OECONF'><filename>EXTRA_OECONF</filename></ulink> @@ -2037,7 +2046,8 @@ the <ulink url='&YOCTO_DOCS_REF_URL;#ref-classes-cmake'><filename>cmake</filename></ulink> class and your recipe does not have to contain a - <filename>do_configure</filename> task. + <ulink url='&YOCTO_DOCS_REF_URL;#ref-tasks-configure'><filename>do_configure</filename></ulink> + task. You can make some adjustments by setting <ulink url='&YOCTO_DOCS_REF_URL;#var-EXTRA_OECMAKE'><filename>EXTRA_OECMAKE</filename></ulink> to pass any needed configure options that are specific @@ -2049,7 +2059,8 @@ software is built using some method other than Autotools or CMake. If this is the case, you normally need to provide a - <filename>do_configure</filename> task in your recipe + <ulink url='&YOCTO_DOCS_REF_URL;#ref-tasks-configure'><filename>do_configure</filename></ulink> + task in your recipe unless, of course, there is nothing to configure. </para> <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 37fa5af..434a7d1 100644 --- a/documentation/dev-manual/dev-manual-newbie.xml +++ b/documentation/dev-manual/dev-manual-newbie.xml @@ -804,8 +804,9 @@ section.</para></listitem> <listitem><para><emphasis>Task:</emphasis> A unit of execution for BitBake (e.g. - <filename>do_compile</filename>, - <filename>do_fetch</filename>, <filename>do_patch</filename>, + <ulink url='&YOCTO_DOCS_REF_URL;#ref-tasks-compile'><filename>do_compile</filename></ulink>, + <ulink url='&YOCTO_DOCS_REF_URL;#ref-tasks-fetch'><filename>do_fetch</filename></ulink>, + <ulink url='&YOCTO_DOCS_REF_URL;#ref-tasks-patch'><filename>do_patch</filename></ulink>, and so forth). </para></listitem> <listitem><para><emphasis>Upstream:</emphasis> A reference to source code or repositories |