diff options
Diffstat (limited to 'documentation/ref-manual/ref-tasks.xml')
-rw-r--r-- | documentation/ref-manual/ref-tasks.xml | 64 |
1 files changed, 60 insertions, 4 deletions
diff --git a/documentation/ref-manual/ref-tasks.xml b/documentation/ref-manual/ref-tasks.xml index a62b7ce9a6..d6d287b435 100644 --- a/documentation/ref-manual/ref-tasks.xml +++ b/documentation/ref-manual/ref-tasks.xml | |||
@@ -283,10 +283,28 @@ | |||
283 | <title><filename>do_clean</filename></title> | 283 | <title><filename>do_clean</filename></title> |
284 | 284 | ||
285 | <para> | 285 | <para> |
286 | Removes all output files for a target. | 286 | Removes all output files for a target from the |
287 | When this task is run, the | 287 | <link linkend='ref-tasks-unpack'><filename>do_unpack</filename></link> |
288 | task forward (i.e. | ||
289 | <link linkend='ref-tasks-patch'><filename>do_unpack</filename></link>, | ||
290 | <link linkend='ref-tasks-configure'><filename>do_configure</filename></link>, | ||
291 | <link linkend='ref-tasks-compile'><filename>do_compile</filename></link>, | ||
292 | <link linkend='ref-tasks-install'><filename>do_install</filename></link>, | ||
293 | and | ||
294 | <link linkend='ref-tasks-package'><filename>do_package</filename></link>). | ||
295 | </para> | ||
296 | |||
297 | <para> | ||
298 | You can run this task using BitBake as follows: | ||
299 | <literallayout class='monospaced'> | ||
300 | $ bitbake -c clean <recipe> | ||
301 | </literallayout> | ||
302 | </para> | ||
303 | |||
304 | <para> | ||
305 | Running this task does not remove the | ||
288 | <link linkend='shared-state-cache'>sstate</link>) cache | 306 | <link linkend='shared-state-cache'>sstate</link>) cache |
289 | files are not deleted. | 307 | files. |
290 | Consequently, if no changes have been made and the recipe is | 308 | Consequently, if no changes have been made and the recipe is |
291 | rebuilt after cleaning, output files are simply restored from the | 309 | rebuilt after cleaning, output files are simply restored from the |
292 | sstate cache. | 310 | sstate cache. |
@@ -304,6 +322,25 @@ | |||
304 | Removes all output files, shared state | 322 | Removes all output files, shared state |
305 | (<link linkend='shared-state-cache'>sstate</link>) cache, and | 323 | (<link linkend='shared-state-cache'>sstate</link>) cache, and |
306 | downloaded source files for a target. | 324 | downloaded source files for a target. |
325 | Essentially, the <filename>do_cleanall</filename> task is | ||
326 | identical to the | ||
327 | <link linkend='ref-tasks-cleansstate'><filename>do_cleansstate</filename></link> | ||
328 | task with the added removal of downloaded source files. | ||
329 | </para> | ||
330 | |||
331 | <para> | ||
332 | You can run this task using BitBake as follows: | ||
333 | <literallayout class='monospaced'> | ||
334 | $ bitbake -c cleanall <recipe> | ||
335 | </literallayout> | ||
336 | </para> | ||
337 | |||
338 | <para> | ||
339 | Typically, you would not normally use the | ||
340 | <filename>cleanall</filename> task. | ||
341 | Do so only if you want to start fresh with the | ||
342 | <link linkend='ref-tasks-fetch'><filename>do_fetch</filename></link> | ||
343 | task. | ||
307 | </para> | 344 | </para> |
308 | </section> | 345 | </section> |
309 | 346 | ||
@@ -314,8 +351,27 @@ | |||
314 | Removes all output files and shared state | 351 | Removes all output files and shared state |
315 | (<link linkend='shared-state-cache'>sstate</link>) | 352 | (<link linkend='shared-state-cache'>sstate</link>) |
316 | cache for a target. | 353 | cache for a target. |
354 | Essentially, the <filename>do_cleansstate</filename> task is | ||
355 | identical to the | ||
356 | <link linkend='ref-tasks-clean'><filename>do_clean</filename></link> | ||
357 | task with the added removal of shared state | ||
358 | (<link linkend='shared-state-cache'>sstate</link>) cache. | ||
317 | </para> | 359 | </para> |
318 | </section> | 360 | |
361 | <para> | ||
362 | You can run this task using BitBake as follows: | ||
363 | <literallayout class='monospaced'> | ||
364 | $ bitbake -c cleansstate <recipe> | ||
365 | </literallayout> | ||
366 | </para> | ||
367 | |||
368 | <para> | ||
369 | When you run the <filename>do_cleanstate</filename> task, | ||
370 | the OpenEmbedded build system no longer uses any | ||
371 | sstate. | ||
372 | Consequently, building the recipe from scratch is guaranteed. | ||
373 | </para> | ||
374 | </section> | ||
319 | 375 | ||
320 | <section id='ref-tasks-devshell'> | 376 | <section id='ref-tasks-devshell'> |
321 | <title><filename>do_devshell</filename></title> | 377 | <title><filename>do_devshell</filename></title> |