aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorBill Traynor <wmat@alphatroop.com>2013-04-15 20:47:14 -0400
committerRichard Purdie <richard.purdie@linuxfoundation.org>2014-01-13 22:00:27 +0000
commit313712c8db8c070f16344a357d71bb02a9d3e789 (patch)
tree7255b4d520d707471303dc3444f4151f54276821
parent5f80311d73e45cfed035e7e52c5ca24bc896a82c (diff)
downloadbitbake-313712c8db8c070f16344a357d71bb02a9d3e789.tar.gz
bitbake-313712c8db8c070f16344a357d71bb02a9d3e789.tar.bz2
bitbake-313712c8db8c070f16344a357d71bb02a9d3e789.zip
user-manual-metadata: Updated the Tasks section.
Update the Tasks section with information provided through feedback. Signed-off-by: Bill Traynor <wmat@alphatroop.com>
-rw-r--r--doc/user-manual/user-manual-metadata.xml31
1 files changed, 18 insertions, 13 deletions
diff --git a/doc/user-manual/user-manual-metadata.xml b/doc/user-manual/user-manual-metadata.xml
index ce3517cf..d2d20fe7 100644
--- a/doc/user-manual/user-manual-metadata.xml
+++ b/doc/user-manual/user-manual-metadata.xml
@@ -549,23 +549,28 @@ need to import them.</para>
<emphasis>NOTE:</emphasis>
This is only supported in .bb and .bbclass files.
</para>
- <para>In BitBake, each step that needs to be run for a given .bb is
- known as a task.
- There is a command <literal>addtask</literal> to add new
- tasks (must be a defined Python executable metadata and must
- start with <quote>do_</quote>) and describe intertask
- dependencies.
+ <para>A shell or python function executable through exec_func can be promoted
+ to become a task.
+ Tasks are the execution unit Bitbake uses and each step that needs to be run
+ for a given .bb is known as a task.
+ There is a addtask command to add new tasks and promote functions which by
+ convention must start with “do_”.
+ The addtask command is also used to describe intertask dependencies.
</para>
<para>
- <screen>python do_printdate () { import time print
- time.strftime('%Y%m%d', time.gmtime()) } addtask printdate
- before do_build
+ <screen>
+ python do_printdate () {
+ import time print
+ time.strftime('%Y%m%d', time.gmtime())
+ }
+ addtask printdate after do_fetch before do_build
</screen>
</para>
- <para>This defines the necessary Python function and adds it as a task
- which is now a dependency of do_build, the default task.
- If anyone executes the do_build task, that will result in
- do_printdate being run first.
+ <para>The above example defined a python function, then adds it as a task
+ which is now a dependency of do_build, the default task and states it
+ has to happen after do_fetch.
+ If anyone executes the do_build task, that will result in do_printdate
+ being run first.
</para>
</section>