From 552d54f2ecadfc6b8af5c2cc8c44d15c23928bef Mon Sep 17 00:00:00 2001
From: Richard Purdie <richard.purdie@linuxfoundation.org>
Date: Sat, 18 Jan 2014 14:34:14 +0000
Subject: bitbake: user-manual-metadata: Clean up task documentation

(Bitbake rev: 55158ce6c5435544a62a60c0055724619bafde27)

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
---
 bitbake/doc/user-manual/user-manual-metadata.xml | 28 ++++++++++++++++++++----
 1 file changed, 24 insertions(+), 4 deletions(-)

(limited to 'bitbake/doc/user-manual/user-manual-metadata.xml')

diff --git a/bitbake/doc/user-manual/user-manual-metadata.xml b/bitbake/doc/user-manual/user-manual-metadata.xml
index 0ce2549daf..69d103dcac 100644
--- a/bitbake/doc/user-manual/user-manual-metadata.xml
+++ b/bitbake/doc/user-manual/user-manual-metadata.xml
@@ -474,10 +474,24 @@
         </para>
     </section>
 
-    <section>
+    <section id='tasks'>
         <title>Tasks</title>
-        <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 <filename>addtask</filename> to add new tasks (must be a defined Python executable metadata and must start with <quote>do_</quote>) and describe intertask dependencies.
+
+        <note>
+            This is only supported in <filename>.bb</filename>
+            and <filename>.bbclass</filename> files.
+        </note>
+
+        <para>
+            A shell or Python function executable through the
+            <filename>exec_func</filename> 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 <filename>.bb</filename> is known as
+            a task.
+            There is an <filename>addtask</filename> command to add new tasks
+            and promote functions which by convention must start with “do_”.
+            The <filename>addtask</filename> command is also used to describe
+            intertask dependencies.
             <literallayout class='monospaced'>
      python do_printdate () {
          import time print
@@ -485,7 +499,13 @@
      }
      addtask printdate after do_fetch before do_build
             </literallayout>
-            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.
+            The above example defined a Python function, then adds
+            it as a task which is now a dependency of
+            <filename>do_build</filename>, the default task and states it
+            has to happen after <filename>do_fetch</filename>.
+            If anyone executes the <filename>do_build</filename>
+            task, that will result in <filename>do_printdate</filename>
+            being run first.
         </para>
     </section>
 
-- 
cgit v1.2.3-54-g00ecf