| Summary: | Enhance BitBake manual | ||
|---|---|---|---|
| Product: | [Build System, Metadata & Runtime] BitBake | Reporter: | Joshua Lock - Disabled <josh> |
| Component: | bitbake | Assignee: | Scott Rifenbark <srifenbark> |
| Status: | RESOLVED FIXED | QA Contact: | |
| Severity: | enhancement | ||
| Priority: | Medium | CC: | btraynor, jefro, jessica.zhang, poky.bs.watcher, poky.watcher, richard.purdie, srifenbark |
| Version: | unspecified | ||
| Target Milestone: | 1.6 | ||
| Hardware: | x86 | ||
| OS: | Multiple | ||
| Whiteboard: | 10 April 2014: RESOLVED | ||
| OS type for building Yocto: | --- | Type of Regression: | --- |
| Verified: | Documentation change: | Done (doc changes complete) | |
|
Description
Joshua Lock - Disabled
2012-02-09 14:45:21 UTC
Scott, this probably should go to Bill but he doesn't have a bugzilla account? Bill Traynor has been rewriting the BitBake manual. I don't know whether it will be finished in time for 1.4 but I believe that is the plan. Joshua, should we add you to the review committee? I believe the plan also is to host the manual on the YP servers and mirror it for OE. Scott, does that sound ok to you? Yes - we can host the built versions of the manual alongside all the other YP documents. Are the plans to provide the manual files inside poky/bitbake/doc/manual as they are now? poky/documentation has actual .XML source files for the YP manuals. Bitbake manual does not follow this model. Scott Here is how we will distribute the revised BB manual. * the "made" manuals will live alongside the current YP manuals on the yoctoproject.org server. Before release time I will make a current version and an in progress version from the OE git repository. I will publish these to the server, respectively. Users will be able to access the manuals from the list of YP documentation. * the repository for the BB manual will continue to live where it does with OE so that will not disrupt people that understand where it is. * when Bill Traynor has Richard Purdie pull his area (wmat) into the OE repo, the result will be a yocto-ized structure that has multiple chapters, make file, etc. this will be done before the 1.4 release at some point. Bill is targeting end of March 2013 to lock it up. At that point, he will tag the repo so we have a good 1.4 commit for the manual. Work can continue on the tip where it can be incorporated into the "in progress" result just as we do with the YP manuals. Scott Added Richard to the CC list. Unfortunately, this did not happen for 1.5. I think we are going to have to do it ourselves. I am pushing to post 1.5. Setting the target to 1.6. This re-write needs to happen for 1.6. I will need to work with Richard and Paul to get this revision completed. Changing the state on this to REVIEW. We are pretty far along on it and have just one last section to look at on EXPORT_FUNCTIONS. Also, I don't think the "Hello World" appendix is going to make it. Scott Hi, Here is a link to the manual that is still in progress. The final appendix, which is the "hello world" example is not complete and might not make it into the final version. http://www.yoctoproject.org/docs/1.6/user-manual/user-manual.html Thanks, Scott Hi, I am marking this one RESOLVED and the documentation flag to "Done." I think we have enhanced the manual. Scott |