Bug 1949 - Need information on the various "clean" tasks and when to use them
Summary: Need information on the various "clean" tasks and when to use them
Status: RESOLVED FIXED
Alias: None
Product: Quick Start
Classification: Documentation
Component: quick-start (show other bugs)
Version: unspecified
Hardware: x86 Multiple
: Low enhancement
Target Milestone: Future
Assignee: Scott Rifenbark
QA Contact:
URL:
Whiteboard: 5 Sept 2014: RESOLVED
Depends on:
Blocks:
 
Reported: 2012-02-01 12:42 UTC by Scott Rifenbark
Modified: 2014-09-05 08:25 UTC (History)
5 users (show)

See Also:
OS type for building Yocto: ---
Type of Regression: ---
Verified:
Documentation change: Done (doc changes complete)


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Scott Rifenbark 2012-02-01 12:42:28 UTC
The documentation needs to provide some guidance on using the various clean tasks with bitbake.  At this point I don't know where to place this information.  

Here is some fundamental information from Richard.

--------- PURDIE EMAIL ---------------

There are several "clean" tasks:

"clean" - This removes the output from the unpack task onwards
(unpack/patch/configure/compile/install/package)"

"cleansstate" - This removes everything clean would but also includes
any sstate data. This means that when the task reruns, there would no
longer be any sstate to use and a build from scratch of the recipe is
guaranteed.

"cleanall" - This is "cleansstate" plus removing all data related to the
downloads. This effectively causes the fetch task to run from scratch.

In general, most users would use "clean". "cleansstate" is a belt and
braces to ensure any existing sstate package isn't reused. Its unlikely
most users would need "cleanall" but the option exists if they did want
to remove all downloaded sources as well.
Comment 1 Scott Rifenbark 2012-04-24 22:47:35 UTC
Accepted:  Needs to be categorized under "Development Manual" when that category is set up.
Comment 2 Scott Rifenbark 2013-09-19 00:43:40 UTC
Pushing out past 1.5.
Comment 3 Scott Rifenbark 2013-10-31 19:30:32 UTC
I need to be sure this information gets into the re-written BitBake manual.
Comment 4 Scott Rifenbark 2014-06-16 09:11:46 UTC
Hi, 

I have updated the following sections to provide a bit more information on these clean tasks.

  http://www.yoctoproject.org/docs/1.7/ref-manual/ref-manual.html#ref-tasks-clean

  http://www.yoctoproject.org/docs/1.7/ref-manual/ref-manual.html#ref-tasks-cleanall

  http://www.yoctoproject.org/docs/1.7/ref-manual/ref-manual.html#ref-tasks-cleansstate

In addition to this, I made sure the manual set references these sections appropriately when discussing use of these tasks from the BB command line.

I am marking as IN PROGRESS REVIEW.  Please look this over and let me know if it is good.

Thanks, 
Scott
Comment 5 Richard Purdie 2014-06-17 10:31:11 UTC
Need to add do_populate_sysroot and do_deploy to the list of clean tasks although its still not a complete list (nor is it possible to give one).

Add a caveat to do_cleansstate that highlights that it cannot remove sstate from a remote sstate mirror. If a try from scratch build is required with remote sstate mirrors, the -f option should be used.

Maybe also highlight that do_cleanall removes files from DL_DIR?
Comment 7 Scott Rifenbark 2014-07-29 06:43:40 UTC
Hi, 

I still need a review of these sections. 

thanks,
Scott
Comment 8 Scott Rifenbark 2014-09-05 08:25:58 UTC
No feedback on this in five weeks.  I am marking it RESOLVED and setting the Doc flag to "Done."

Scott