diff options
authorScott Rifenbark <srifenbark@gmail.com>2016-07-12 13:41:12 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2016-07-21 07:47:53 +0100
commit8c55a9cf882eb7edd1ebfbcdfc66a330b401926a (patch)
parentd918df7e8e6adc022a261608242b5750859a0bbc (diff)
bitbake: 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. (Bitbake rev: c2e72928fbd21d622860a54a55f4239ba27c07a2) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
1 files changed, 34 insertions, 0 deletions
diff --git a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-metadata.xml b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-metadata.xml
index 646f6744e6f..857f8b279cd 100644
--- a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-metadata.xml
+++ b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-metadata.xml
@@ -1670,6 +1670,40 @@
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>