Bug 8800 - Flesh out the do_populate_sysroot documentation
Summary: Flesh out the do_populate_sysroot documentation
Status: RESOLVED FIXED
Alias: None
Product: Reference
Classification: Documentation
Component: handbook (show other bugs)
Version: 2.1
Hardware: x86 Multiple
: Medium normal
Target Milestone: 2.1 M4
Assignee: Scott Rifenbark
QA Contact:
URL:
Whiteboard: 21 March 2016: RESOLVED
Depends on:
Blocks:
 
Reported: 2015-12-13 01:03 UTC by ulfalizer
Modified: 2016-03-22 16:22 UTC (History)
4 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 ulfalizer 2015-12-13 01:03:40 UTC
The documentation for do_populate_sysroot seems a bit terse at the moment. I suggest writing something like the following, which also makes staging.bbclass easier to find:

"Copies a subset of the files installed by the do_install task into the sysroot to make them available to other recipes. Files that would typically not be needed by other recipes at build time are skipped, including files installed into /etc. See [staging.bbclass] for exactly which files are copied."
Comment 1 Scott Rifenbark 2016-02-06 00:32:47 UTC
Hi, 

See http://www.yoctoproject.org/docs/2.1/ref-manual/ref-manual.html#ref-tasks-populate_sysroot for the updated explanation of do_populate_sysroot.  

Also, I noticed that the staging class description (http://www.yoctoproject.org/docs/2.1/ref-manual/ref-manual.html#ref-classes-staging) really doesn't say much about it.  Do you have any suggestions for this class?

Thanks,
Scott
Comment 2 ulfalizer 2016-02-06 09:51:29 UTC
Looks good - thanks!

Maybe staging.bbclass could be rephrased like this, though I don't think it's that bad as is:

"The staging class provides the do_populate_sysroot task, which stages files into the sysroot to make them available to other recipes at build time."

With that wording it's clearer that do_populate_sysroot is from staging.bbclass.
Comment 3 Scott Rifenbark 2016-02-15 18:49:25 UTC
Thanks, 

Your wording is fine.  I updated the section.  See http://www.yoctoproject.org/docs/2.1/ref-manual/ref-manual.html#ref-classes-staging.

Scott
Comment 4 Scott Rifenbark 2016-03-22 16:22:21 UTC
Closing this one out.