| Summary: | Add an illustration showing "source" and "destination" directories | ||
|---|---|---|---|
| Product: | [Documentation] Quick Start | Reporter: | Dave Stewart <david.c.stewart> |
| Component: | quick-start | Assignee: | Scott Rifenbark <srifenbark> |
| Status: | VERIFIED FIXED | QA Contact: | |
| Severity: | normal | ||
| Priority: | Medium | CC: | bluelightning, corneliux.stoicescu, david.c.stewart, jessica.zhang, poky.doc.watcher, poky.watcher, richard.purdie, sgw, srifenbark |
| Version: | unspecified | ||
| Target Milestone: | 1.5 | ||
| Hardware: | x86 | ||
| OS: | Multiple | ||
| Whiteboard: | 27 September 2013: RESOLVED | ||
| OS type for building Yocto: | --- | Type of Regression: | --- |
| Verified: | Documentation change: | Done (doc changes complete) | |
|
Description
Dave Stewart
2012-07-20 15:40:44 UTC
Adding Richard Purdie and Paul Eggleton to the CC list. Can someone provide me with the basic "from" and "to" directories used during a typical image build? I would like to create this illustration that shows the user where things come from and where they go to during a build. Scott The inputs you can't really delete would only be the metadata (layers containing recipes, classes, configuration etc.), and conf/* under the build directory; and, if you have any recipes pointing to local source files or repositories then those would be in the inputs as well - you wouldn't have any of those out of the box, but if you were developing your own software to be built by the build system as most people building a product would be, then you would have. Everything else (TMPDIR, SSTATEDIR, DL_DIR, ...) is output. One thought that comes to mind however is that we should also answer the related question "what should I keep if I want to be able to reproduce the build at a later date?" In answering that I would suggest keeping the contents of the aforementioned inputs as well as at least SSTATEDIR and DL_DIR, although there are circumstances under which those won't completely result in the same output - e.g. we now have a default setting which keeps the sstate files for native recipes separated by the host distribution; thus if you moved these to a new machine with a different distro they at least will be rebuilt by default. We need to specifically resolve and document this topic IMO. Scott, do you need any more information on this subject? I will take the information from Paul's comment and create a rough drawing and then include it in a further comment for this bug. We can assess it and build on it from there. Scott Hi, I am marking this extensive section for review now. I have been working on it for a long time closely with Paul Eggleton. It is complete now and there probably is time for changes if they are communicated to me fairly quickly. The figures and some of the flow have been previously reviewed by Dave Stewart and I took action on that review. The idea of the section is a mid-level, detailed look at the overall BitBake process when generating an image or SDK. The section does not delve overly deep into the bowels of the system but tries for a depth that would help the user grasp the overall process better with regard to output directories, variables, and input sources. Here is the link: http://www.yoctoproject.org/docs/latest/ref-manual/ref-manual.html#closer-look Thanks, Scott Completed this new chapter for the Yocto Project Reference Manual. You can view it at http://www.yoctoproject.org/docs/1.5/ref-manual/ref-manual.html#closer-look. Marking as RESOLVED. Scottsection The new section looks good. Great addition to the manual. Setting to VERIFIED. |