summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual/ref-tasks.xml
diff options
context:
space:
mode:
authorScott Rifenbark <srifenbark@gmail.com>2016-03-22 12:10:18 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2016-03-23 21:56:10 +0000
commitb44d9e553a84e07e34c2c1a74523473631e8e1d5 (patch)
tree9d833dc43a4b3086b2d61a2ff0a44e5d4b5c4573 /documentation/ref-manual/ref-tasks.xml
parent54050ffceb96b8ad8c089f6612e094a367a4edc8 (diff)
downloadopenembedded-core-contrib-b44d9e553a84e07e34c2c1a74523473631e8e1d5.tar.gz
ref-manual: Created distrodata and checkpkg tasks, updated distrodata class
Fixes [YOCTO #7894] I created two new task reference sections: distrodata and checkpkg. Also, updated the distrodata class description to reflect the presence of these new tasks. (From yocto-docs rev: 3896cbf640d296dafb5eda37f89bba31a47ca8a5) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/ref-manual/ref-tasks.xml')
-rw-r--r--documentation/ref-manual/ref-tasks.xml56
1 files changed, 56 insertions, 0 deletions
diff --git a/documentation/ref-manual/ref-tasks.xml b/documentation/ref-manual/ref-tasks.xml
index b2ecc66269..c46debb55b 100644
--- a/documentation/ref-manual/ref-tasks.xml
+++ b/documentation/ref-manual/ref-tasks.xml
@@ -31,6 +31,36 @@
</para>
</section>
+ <section id='ref-tasks-checkpkg'>
+ <title><filename>do_checkpkg</filename></title>
+
+ <para>
+ Provides information about the recipe including its upstream
+ version and status.
+ The upstream version and status reveals whether or not a version
+ of the recipe exists upstream and a status of not updated, updated,
+ or unknown.
+ </para>
+
+ <para>
+ The <filename>checkpkg</filename> task is included as part of the
+ <link linkend='ref-classes-distrodata'><filename>distrodata</filename></link>
+ class.
+ </para>
+
+ <para>
+ To build the <filename>checkpkg</filename> task, use the
+ <filename>bitbake</filename> command with the "-c" option and
+ task name:
+ <literallayout class='monospaced'>
+ $ bitbake core-image-minimal -c checkpkg
+ </literallayout>
+ By default, the results are stored in
+ <link linkend='var-LOG_DIR'><filename>$LOG_DIR</filename></link>
+ (e.g. <filename>$BUILD_DIR/tmp/log</filename>).
+ </para>
+ </section>
+
<section id='ref-tasks-compile'>
<title><filename>do_compile</filename></title>
@@ -87,6 +117,32 @@
</para>
</section>
+ <section id='ref-tasks-distrodata'>
+ <title><filename>do_distrodata</filename></title>
+
+ <para>
+ Provides information about the recipe.
+ </para>
+
+ <para>
+ The <filename>distrodata</filename> task is included as part of the
+ <link linkend='ref-classes-distrodata'><filename>distrodata</filename></link>
+ class.
+ </para>
+
+ <para>
+ To build the <filename>distrodata</filename> task, use the
+ <filename>bitbake</filename> command with the "-c" option and
+ task name:
+ <literallayout class='monospaced'>
+ $ bitbake core-image-minimal -c distrodata
+ </literallayout>
+ By default, the results are stored in
+ <link linkend='var-LOG_DIR'><filename>$LOG_DIR</filename></link>
+ (e.g. <filename>$BUILD_DIR/tmp/log</filename>).
+ </para>
+ </section>
+
<section id='ref-tasks-fetch'>
<title><filename>do_fetch</filename></title>