summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2014-06-17 16:54:31 +0300
committerRichard Purdie <richard.purdie@linuxfoundation.org>2014-06-18 10:30:50 +0100
commit3d9723240384f7a7dd250d6926887661d199793a (patch)
tree227c4f64a8c0630a969fe0bb68861373361c6621 /documentation
parentd785a16dffd7788ea82ef71898b2f508fc15344c (diff)
downloadpoky-3d9723240384f7a7dd250d6926887661d199793a.tar.gz
ref-manual: Edits to several tasks that do a bit of "cleaning"
Fixes [YOCTO #1949] Updated the following tasks to note that they "clean" out some areas when run: do_populate_sysroot do_deploy Also made some notes to the do_cleansstate task about attempting to clean remote mirrors. And, made a change to do_cleanall to specifically mention that DL_DIR is cleaned. (From yocto-docs rev: 7e532b17ccd89e43d3661c733ce1f06a52066c29) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
-rw-r--r--documentation/ref-manual/ref-tasks.xml30
1 files changed, 28 insertions, 2 deletions
diff --git a/documentation/ref-manual/ref-tasks.xml b/documentation/ref-manual/ref-tasks.xml
index d6d287b435..fc23a7ba0d 100644
--- a/documentation/ref-manual/ref-tasks.xml
+++ b/documentation/ref-manual/ref-tasks.xml
@@ -77,6 +77,14 @@
77 <link linkend='var-DEPLOYDIR'><filename>DEPLOYDIR</filename></link> 77 <link linkend='var-DEPLOYDIR'><filename>DEPLOYDIR</filename></link>
78 variable. 78 variable.
79 </para> 79 </para>
80
81 <para>
82 The <filename>do_deploy</filename> task is a
83 shared state (sstate) task, which means that the task can
84 be accelerated through sstate use.
85 Realize also that if the task is re-executed, any previous output
86 is removed (i.e. "cleaned").
87 </para>
80 </section> 88 </section>
81 89
82 <section id='ref-tasks-fetch'> 90 <section id='ref-tasks-fetch'>
@@ -210,6 +218,14 @@
210 task into the sysroot in order to make them available to other 218 task into the sysroot in order to make them available to other
211 recipes. 219 recipes.
212 </para> 220 </para>
221
222 <para>
223 The <filename>do_populate_sysroot</filename> task is a
224 shared state (sstate) task, which means that the task can
225 be accelerated through sstate use.
226 Realize also that if the task is re-executed, any previous output
227 is removed (i.e. "cleaned").
228 </para>
213 </section> 229 </section>
214 230
215 <section id='ref-tasks-rm_work'> 231 <section id='ref-tasks-rm_work'>
@@ -321,7 +337,8 @@
321 <para> 337 <para>
322 Removes all output files, shared state 338 Removes all output files, shared state
323 (<link linkend='shared-state-cache'>sstate</link>) cache, and 339 (<link linkend='shared-state-cache'>sstate</link>) cache, and
324 downloaded source files for a target. 340 downloaded source files for a target (i.e. the contents of
341 <link linkend='var-DL_DIR'><filename>DL_DIR</filename></link>).
325 Essentially, the <filename>do_cleanall</filename> task is 342 Essentially, the <filename>do_cleanall</filename> task is
326 identical to the 343 identical to the
327 <link linkend='ref-tasks-cleansstate'><filename>do_cleansstate</filename></link> 344 <link linkend='ref-tasks-cleansstate'><filename>do_cleansstate</filename></link>
@@ -366,10 +383,19 @@
366 </para> 383 </para>
367 384
368 <para> 385 <para>
369 When you run the <filename>do_cleanstate</filename> task, 386 When you run the <filename>do_cleansstate</filename> task,
370 the OpenEmbedded build system no longer uses any 387 the OpenEmbedded build system no longer uses any
371 sstate. 388 sstate.
372 Consequently, building the recipe from scratch is guaranteed. 389 Consequently, building the recipe from scratch is guaranteed.
390 <note>
391 The <filename>do_cleansstate</filename> task cannot remove
392 sstate from a remote sstate mirror.
393 If you need to build a target from scratch using remote
394 mirrors, use the "-f" option as follows:
395 <literallayout class='monospaced'>
396 $ bitbake -f -c do_cleansstate &lt;target&gt;
397 </literallayout>
398 </note>
373 </para> 399 </para>
374 </section> 400 </section>
375 401