summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRichard Purdie <richard.purdie@linuxfoundation.org>2014-01-18 14:33:33 +0000
committerRichard Purdie <richard.purdie@linuxfoundation.org>2014-01-27 21:03:22 +0000
commitac576f40ac855eeef3fff38a863c2fd93d4030cf (patch)
tree191a936ee80564c85a6b8a2c5421b40a15164f7b
parent7b99bc04acd6a2e3805dd592daff18fb0ecba164 (diff)
downloadpoky-ac576f40ac855eeef3fff38a863c2fd93d4030cf.tar.gz
bitbake: user-manual-metadata: Clean up task flag section
(Bitbake rev: b2e8c56d0f554e3b118f23b42858319110501180) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
-rw-r--r--bitbake/doc/user-manual/user-manual-metadata.xml36
1 files changed, 26 insertions, 10 deletions
diff --git a/bitbake/doc/user-manual/user-manual-metadata.xml b/bitbake/doc/user-manual/user-manual-metadata.xml
index 239390ac8d..0ce2549daf 100644
--- a/bitbake/doc/user-manual/user-manual-metadata.xml
+++ b/bitbake/doc/user-manual/user-manual-metadata.xml
@@ -568,17 +568,33 @@
568 568
569 <para> 569 <para>
570 Tasks support a number of flags which control various 570 Tasks support a number of flags which control various
571 functionality of the task. These are as follows: 571 functionality of the task.
572 These are as follows:
573 <itemizedlist>
574 <listitem><para><emphasis>dirs:</emphasis>
575 Directories which should be created before the task runs.
576 </para></listitem>
577 <listitem><para><emphasis>cleandirs:</emphasis>
578 Directories which should created before the task runs
579 but should be empty.</para></listitem>
580 <listitem><para><emphasis>noexec:</emphasis>
581 Marks the tasks as being empty and no execution required.
582 These are used as dependency placeholders or used when added tasks
583 need to be subsequently disabled.</para></listitem>
584 <listitem><para><emphasis>nostamp:</emphasis>
585 Do not generate a stamp file for a task.
586 This means the task is always executed.</para></listitem>
587 <listitem><para><emphasis>fakeroot:</emphasis>
588 This task needs to be run in a fakeroot environment,
589 obtained by adding the variables in <filename>FAKEROOTENV</filename>
590 to the environment.</para></listitem>
591 <listitem><para><emphasis>umask:</emphasis>
592 The umask to run the task under.</para></listitem>
593 </itemizedlist>
594 For the 'deptask', 'rdeptask', 'depends', 'rdepends'and
595 'recrdeptask' flags, please see the dependencies section.
572 </para> 596 </para>
573 <para>'dirs' - directories which should be created before the task runs</para> 597 </section>
574 <para>'cleandirs' - directories which should be created before the task runs but should be empty</para>
575 <para>'noexec' - marks the tasks as being empty and no execution required. These are used as dependency placeholders or used when added tasks need to be subsequently disabled.</para>
576 <para>'nostamp' - don't generate a stamp file for a task. This means the task is always rexecuted.</para>
577 <para>'fakeroot' - this task needs to be run in a fakeroot environment, obtained by adding the variables in FAKEROOTENV to the environment.</para>
578 <para>'umask' - the umask to run the task under.</para>
579 <para> For the 'deptask', 'rdeptask', 'depends', 'rdepends' and 'recrdeptask' flags please see the dependencies section.</para>
580 </section>
581
582 598
583 <section id='parsing-and-execution'> 599 <section id='parsing-and-execution'>
584 <title>Parsing and Execution</title> 600 <title>Parsing and Execution</title>