aboutsummaryrefslogtreecommitdiffstats
path: root/doc/bitbake-user-manual/bitbake-user-manual-metadata.xml
diff options
context:
space:
mode:
authorScott Rifenbark <srifenbark@gmail.com>2016-07-12 13:41:12 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2016-07-21 07:47:35 +0100
commitc2e72928fbd21d622860a54a55f4239ba27c07a2 (patch)
treeacc529bc666a6a79fe01e66d07888e078df34be7 /doc/bitbake-user-manual/bitbake-user-manual-metadata.xml
parent231deeb2b0b3847cba971ca30c16e29357100ae6 (diff)
downloadbitbake-c2e72928fbd21d622860a54a55f4239ba27c07a2.tar.gz
bitbake-c2e72928fbd21d622860a54a55f4239ba27c07a2.tar.bz2
bitbake-c2e72928fbd21d622860a54a55f4239ba27c07a2.zip
bitbake-user-manual: Added a note providing examples of task dependencies
Fixes [YOCTO #9861] In the "Dependencies internal to the .bb File" section, I placed a note providing more detail on how recipes are built regarding task dependency. Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Diffstat (limited to 'doc/bitbake-user-manual/bitbake-user-manual-metadata.xml')
-rw-r--r--doc/bitbake-user-manual/bitbake-user-manual-metadata.xml34
1 files changed, 34 insertions, 0 deletions
diff --git a/doc/bitbake-user-manual/bitbake-user-manual-metadata.xml b/doc/bitbake-user-manual/bitbake-user-manual-metadata.xml
index 646f6744..857f8b27 100644
--- a/doc/bitbake-user-manual/bitbake-user-manual-metadata.xml
+++ b/doc/bitbake-user-manual/bitbake-user-manual-metadata.xml
@@ -1670,6 +1670,40 @@
task.
And, the <filename>do_build</filename> depends on the completion
of the <filename>printdate</filename> task.
+ <note>
+ Recipes are built by having their
+ <filename>do_build</filename> (not to be confused with
+ <filename>do_compile</filename>) tasks executed.
+ For a task to run when a recipe is built, the task must
+ therefore be a direct or indirect dependency of
+ <filename>do_build</filename>.
+ For illustration, here are some examples:
+ <itemizedlist>
+ <listitem><para>
+ The directive
+ <filename>addtask mytask before do_build</filename>
+ causes <filename>mytask</filename> to run when the
+ recipe is built.
+ In this example, <filename>mytask</filename> is run
+ at an unspecified time relative to other tasks within
+ the recipe, since "after" is not used.
+ </para></listitem>
+ <listitem><para>
+ The directive
+ <filename>addtask mytask after do_configure</filename>
+ by itself does not cause <filename>mytask</filename>
+ to run when the recipe is built.
+ The task can still be run manually using the following:
+ <literallayout class='monospaced'>
+ $ bitbake <replaceable>recipe</replaceable> -c mytask
+ </literallayout>
+ <filename>mytask</filename> could also be declared as
+ a dependency of some other task.
+ Regardless, the task is run after
+ <filename>do_configure</filename>.
+ </para></listitem>
+ </itemizedlist>
+ </note>
</para>
</section>