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)
downloadpoky-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 @@
31 </para> 31 </para>
32 </section> 32 </section>
33 33
34 <section id='ref-tasks-checkpkg'>
35 <title><filename>do_checkpkg</filename></title>
36
37 <para>
38 Provides information about the recipe including its upstream
39 version and status.
40 The upstream version and status reveals whether or not a version
41 of the recipe exists upstream and a status of not updated, updated,
42 or unknown.
43 </para>
44
45 <para>
46 The <filename>checkpkg</filename> task is included as part of the
47 <link linkend='ref-classes-distrodata'><filename>distrodata</filename></link>
48 class.
49 </para>
50
51 <para>
52 To build the <filename>checkpkg</filename> task, use the
53 <filename>bitbake</filename> command with the "-c" option and
54 task name:
55 <literallayout class='monospaced'>
56 $ bitbake core-image-minimal -c checkpkg
57 </literallayout>
58 By default, the results are stored in
59 <link linkend='var-LOG_DIR'><filename>$LOG_DIR</filename></link>
60 (e.g. <filename>$BUILD_DIR/tmp/log</filename>).
61 </para>
62 </section>
63
34 <section id='ref-tasks-compile'> 64 <section id='ref-tasks-compile'>
35 <title><filename>do_compile</filename></title> 65 <title><filename>do_compile</filename></title>
36 66
@@ -87,6 +117,32 @@
87 </para> 117 </para>
88 </section> 118 </section>
89 119
120 <section id='ref-tasks-distrodata'>
121 <title><filename>do_distrodata</filename></title>
122
123 <para>
124 Provides information about the recipe.
125 </para>
126
127 <para>
128 The <filename>distrodata</filename> task is included as part of the
129 <link linkend='ref-classes-distrodata'><filename>distrodata</filename></link>
130 class.
131 </para>
132
133 <para>
134 To build the <filename>distrodata</filename> task, use the
135 <filename>bitbake</filename> command with the "-c" option and
136 task name:
137 <literallayout class='monospaced'>
138 $ bitbake core-image-minimal -c distrodata
139 </literallayout>
140 By default, the results are stored in
141 <link linkend='var-LOG_DIR'><filename>$LOG_DIR</filename></link>
142 (e.g. <filename>$BUILD_DIR/tmp/log</filename>).
143 </para>
144 </section>
145
90 <section id='ref-tasks-fetch'> 146 <section id='ref-tasks-fetch'>
91 <title><filename>do_fetch</filename></title> 147 <title><filename>do_fetch</filename></title>
92 148