summaryrefslogtreecommitdiffstats
path: root/bitbake/doc
AgeCommit message (Collapse)Author
2014-03-09bitbake: user-manual: Review edits applied throughout from Paul Eggleton.Scott Rifenbark
Applied review edits from Paul Eggleton spanning the entire book. Small areas affected in all chapters except the "Hello World" Appendix. Noteworthy changes in the variables chapter where I added two new variables: BBINCLUDELOGS_LINES and BB_CONSOLELOG. (Bitbake rev: 2d4b09be70c6df0c1605f7e291149c682999cf50) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-03-09bitbake: user-manual: Review edits applied from Paul Eggleton.Scott Rifenbark
Review of the entire manual by Paul. I have implemented his suggestions throughout. (Bitbake rev: 5cd310d1df194cd171691a4bcfb98024e2bc66b8) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-03-09bitbake: user-manual: removed SVK references - all types.Scott Rifenbark
(Bitbake rev: fbbd4cd54753a5d91b5c342d60d007bd2b172570) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-03-09bitbake: user-manual-ref-variables.xml: Edits to BB_GENERATE_MIRROR_TARBALLS ↵Scott Rifenbark
variable Added some clarification around who would like to set this variable and why. (Bitbake rev: 97acce37528ed11165e37996c7076de46c349b0a) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-03-09bitbake: user-manual-metadata.xml: Added BB_ORIGENV example.Scott Rifenbark
(Bitbake rev: d4328e2df355252870c3bf01031538a77795cedb) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-03-09bitbake: user-manual-metadata.xml: Grammar fix.Scott Rifenbark
(Bitbake rev: 71e314b86957ecc01d77262d0a000f6f31db2bcc) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-03-09bitbake: user-manual-execution.xml: Review edits for "Execution" chapter.Scott Rifenbark
Applied various changes from Richard Purdie's review of the "Execution" chapter. (Bitbake rev: 714c0e93bc2d1ae6227991a1c6e4c88504c1870c) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-03-09bitbake: user-manual: Review edits from Richard (second draft)Scott Rifenbark
Applied the comprehensive set of review comments from Richard Purdie. All files affected. One major point here was that the "BitBake Command" chapter was eliminated. This information was folded into various areas of the book. Consequently, the bits including the file for make had to be updated. (Bitbake rev: 8ec38c6b456a92a0e0b9b04c2793a5b148be5027) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-03-09bitbake: user-manual: Added "Hello World" Appendix.Scott Rifenbark
I took Bill's chapter and made it into an appendix. I did some re-writing to make it not so much like a getting-started feel, although it still leans way that way for an appendix. The content is not complete. Had to add in a line to the user-manual.xml file so that the new appendix would be part of the book. Had to use a different form of the command in the user-manual-cusomization.xsl file in order to not through a bunch of errors for an unrecognized parameter value. I commented out the existing one. (Bitbake rev: 80e9306c288ca2ab42585f99fb0f396253cb8253) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-03-09bitbake: user-manual-fetching.xml: Re-write of the Fetching chapter.Scott Rifenbark
Based on a Richard Purdie re-write. (Bitbake rev: fad9a6258f8c04bbe0168e46898dd27b86c39ee0) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-03-09bitbake: user-manual-metadata.xml: Title change, sections lifted.Scott Rifenbark
Changed the title of the chapter to "Syntax and Operators". It was called "Metadata". Removed the bulk the "Checksums (Signatures)" section and the placeholder for "Setscene". These are now in the "Execution" chapter. Created a more appropriate overview blurb to start the chapter. (Bitbake rev: f955171d8468ed987f92146d39f52d9af4a03dbb) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-03-09bitbake: user-manual-fetching.xml: Removed a link.Scott Rifenbark
The link no longer applied as it was linking to a removed section from the "Execution" chapter. (Bitbake rev: de1c316a3f5f382c66b58ad2539b4fadb0f000db) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-03-09bitbake: user-manual-execution.xml: Review edits applied.Scott Rifenbark
Significant review changes implemented from Richard Purdie. * Eliminated the lifted text from the "Closer Look" chapter of the YP ref-manual. * Added the "BitBake" chapter in from the YP ref-manual. * Significant re-writes and suggestions throughout the entire chapter. (Bitbake rev: 4a740385a4720e040af3d329d9c7cc77b03e7f46) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-03-09bitbake: user-manual-intro.xml: Review edits to Introduction chapter.Scott Rifenbark
Applied review edits to the introduction chapter as suggested by Richard Purdie. (Bitbake rev: c6c912cf875766036b91af785f257f64ff07146c) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-03-09bitbake: user-manual-execution.xml: Draft of "Execution" chapterScott Rifenbark
This is a rough draft of the chapter. Major sections are in place. We need to scrub content now. Seems like the discussion of BBFILES fit better in this execution flow chapter. So, I moved it above the parsing section. (Bitbake rev: 6c4c6fb689b88dbefe63f0062b78d8403fb80d41) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-03-09bitbake: user-manual-intro.xml: Added sectionsScott Rifenbark
Added the append files and layer subsections. (Bitbake rev: 38c3ead4ac8036ac88e83a938aa4ce484d4a6a84) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-03-09bitbake: user-manual-bitbakecommand.xml: Added anchor tag for the chapter.Scott Rifenbark
(Bitbake rev: 5aa6679aa8b5b6b8bf4b43cabde04072498ccea4) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-03-09bitbake: user-manual-fetching.xml: Re-write of "File Download Support" chapter.Scott Rifenbark
Basic re-write to clean up text and flow. (Bitbake rev: 0f82dc4c22ce015bef87fd5aae0b6fa3e429016e) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-03-09bitbake: user-manual: Added new chapter to cover BB execution.Scott Rifenbark
This commit added need files, cleaned up bogus links, and adjusted the build file, which is user-manual.xml. The new chapter file is "user-manual-execution.xml". The file has base text from the bitbake section from the "Closer Look" chapter of the YP ref-manual. This means that I had to initially include some figures from that book for now. I am not including them as part of this commit though as they will likely get renamed. I made sure that all links were removed that were specific to the YP ref-manual. Another change was in the user-manual.xml file to include the new chapter as part of the build. Another block of text for the new chapter was the "Running a Task" section from the user-manual-metadata.xml file. Consequently, that section was deleted from the "Metafile" chapter. Another block of text for the new chapter was the "Parsing and Execution" section from the user-manual-metadata.xml file. Consequently, that section was deleted from the "Metafile chapter. (Bitbake rev: f3b21d1fb711f9625d2ac92d4f4fe0f269242bd7) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-03-09bitbake: user-manual-intro.xml: Added an introduction to the manual.Scott Rifenbark
Describes purpose and qualifies some stuff. (Bitbake rev: b9704a367cccd85931fa4fb779d273a27361d503) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-03-09bitbake: user-manual-ref-variables.xml: Added a note qualifying the variables.Scott Rifenbark
The note provides some information in general about the variables that are part of the glossary. (Bitbake rev: 8bcc6d1f1ef4e647ad6153ed7a9e0bd5bc62cf0b) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-03-09bitbake: user-manual-metadata.xml: WIP - Some edits in the checksum area.Scott Rifenbark
(Bitbake rev: f74045d9ac88aece1d6f8d6a95389d01971ffdac) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-03-09bitbake: user-manual-metadata.xml: Rewrite "Accessing Datastore Variables ↵Scott Rifenbark
Using Python" Rewrote this section. Used a table instead of the funky list that was there. I still need to format it some. Also fixed up the term "datastore". It should not be "data store" (Bitbake rev: ee23839596102ccd58e028c10471438f2eb37feb) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-03-09bitbake: user-manual-metadata.xml: Re-write the "Dependencies" section.Scott Rifenbark
General edits and dumping of the useless "Overview" section. (Bitbake rev: b11ad97b9334a86b2f3b10bdf5597910854475bd) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-03-09bitbake: user-manual-metadata.xml: Re-write of "Variants - Class Extension ↵Scott Rifenbark
Mechanism" section. Some general rewrites here. (Bitbake rev: 7149ab6f6e936c19d681f05aa64b123c10f2f3da) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-03-09bitbake: user-manual-ref-variables.xml: Added BBVERSIONS variable.Scott Rifenbark
(Bitbake rev: 0ee8e8db8475903754d519c5e6d7ec8e52ba9c85) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-03-09bitbake: user-manual-metadata.xml: Re-write of "Events" section.Scott Rifenbark
General cleanup of the text. (Bitbake rev: 112dd4279826dc7587e1b8acb4a107374b5bd0fd) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-03-09bitbake: user-manual-metadata.xml: General cleanup to "Parsing and Execution"Scott Rifenbark
I went through and created links for variables we reference that are in the glossary. I also re-wrote much of the text to just clean it up. (Bitbake rev: dd9a4422d387da45f6de945eb4944c2a06bc98a0) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-03-09bitbake: user-manual-metadata.xml: Edits to "Variable Flags" sectionScott Rifenbark
Worked through this section with Richard providing an interactive review. The changes are after the review. There was also a small edit to the "Tasks" section. (Bitbake rev: cba57f8d900d7c3ed8da9fcab0697e3047476325) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-03-09bitbake: user-manual-metadata.xml: Rewrite of the "Tasks" section.Scott Rifenbark
I cleaned up this section with some general improvements. I also broke this up into a couple sub-sections where it seemed to logically fall. Also, stole some metadata concept from the next section ("Running Tasks") that really should be lumped under "Tasks". (Bitbake rev: 9673acda2239807e31f4fcda1574b3e5e2d013a6) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-03-09bitbake: user-manual-metadata.xml: Rewrite of the "Functions" section.Scott Rifenbark
Re-organized this around the 3 types of functions that we seem to be show-casing here. The original organization was not very good. (Bitbake rev: 77ef63e5c4a9ea633a1be0f9f90366e0ecf555fa) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-03-09bitbake: user-manual-ref-variables.xml: Edits to SRC_URI.Scott Rifenbark
(Bitbake rev: b8472f81387f8b8110cd560d61a4563d53d26859) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-03-09bitbake: user-manual-ref-variables.xml: Edits to BBCLASSEXTEND.Scott Rifenbark
(Bitbake rev: bc2a13ba86a5e01b457209b72608403e6aa12003) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-03-09bitbake: user-manual-metadata.xml: Edits to "Sharing Functionality"Scott Rifenbark
Applied some review edits from Paul to the section. (Bitbake rev: f4dc71a3ff2c7f2ca6093b751883a1244f8d3847) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-03-09bitbake: user-manual-metadata.xml: Add bare bones of a scheduler sectionRichard Purdie
(Bitbake rev: cf0ccb26cc7af9f29704bb4c7ada6bf8ef5b0ee6) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-03-09bitbake: user-manual-metadata.xml: Add details about general variables used ↵Richard Purdie
by BitBake (Bitbake rev: 7e78785a53e259225b632c161a70d82fe66eb672) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-03-09bitbake: user-manual-metadata.xml: Add details about environment variables ↵Richard Purdie
used by BitBake (Bitbake rev: 91d3e60a48d2269adfd0084eb6f1bcdb211dbce1) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-02-11bitbake: user-manual-metadata.xml: Edits to the "Sharing Functionality" section.Scott Rifenbark
Applied some review edits from Paul to the section. (Bitbake rev: 56321b18808f5ed932543d907b9ebcfbf4420233) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-02-11bitbake: user-manual-metadata.xml: Edits to "Conditional Syntax (Overrides)"Scott Rifenbark
Re-wrote this section to use clearer more described examples. (Bitbake rev: 6eea23c4783c591c2d2c7f0b2a98e7a0cc8aa3c3) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-02-11bitbake: user-manual-metadata.xml: Edits to "Defining Pure Python Functions"Scott Rifenbark
Made a review edit here to the section per Paul Eggleton. (Bitbake rev: 3b6ab095862367bc0101b995b002f62e7968ccf3) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-02-11bitbake: user-manual-metadata.xml: Edits through syntax sectionScott Rifenbark
I made some general improvements in the "Overview" and "Basic Syntax" sections. Additionally, I added a blank section for "Variable Flags" that will eventually hold general information on this concept. Finally, come review edits to the "Defining Pure Python Functions" section per Paul Eggleton. (Bitbake rev: 665d655f436f1a353f5fe467c5d97588f7b121c5) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-02-11bitbake: user-manual-intro.xml: General edits to Introduction chapter.Scott Rifenbark
I performed a general edit to this chapter. Some significant changes include changing the chapter's title to "Overview" when it was titled "BitBake User Manual", doing some consolidation of text to eliminate a couple sections that described methods to obtain a copy of BitBake, and various improvements as needed. (Bitbake rev: f635c4b36af79b8572095083a392fb58c11198c9) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-02-11bitbake: user-manual-metadata.xml: Added "Checksums (Signatures)" section.Scott Rifenbark
Added this section to the end of the Metadata chapter. (Bitbake rev: b653c58284cafd0b79991520543ca6239705d36b) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-02-11bitbake: user-manual-ref-variables.xml: Review edits to several variables in ↵Scott Rifenbark
glossary. ASSUME_PROVIDED BBCLASSEXTEND SRC_URI PACKAGES_DYNAMIC BB_NUMBER_THREADS BB_DANGLINGAPPENDS_WARNONLY (Bitbake rev: 8e586ccee6d5e78070d28cda67058578e1fe91d7) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-02-11bitbake: user-manual-ref-variables.xml: Added 11 new variables to glossary.Scott Rifenbark
SRCREV_FORMAT BUILDNAME BB_ENV_WHITELIST BB_PRESERVE_ENV BB_ENV_EXTRAWHITE BB_ORIGENV BB_TASKHASH BITBAKE_UI BBDUBUG BB_DEFAULT_TASK BBINCLUDED (Bitbake rev: 0e3106bfdebfa255b2db08a8a4585516d8bebe20) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-02-11bitbake: user-manual-ref-variables.xml: Edits to FILESPATH.Scott Rifenbark
(Bitbake rev: 64bdd3ba6fe90ed6e0338ad053c8117db0acfe2e) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-02-11bitbake: user-manual-ref-variables.xml: Added 6 new variables to glossary:Scott Rifenbark
MULTI_PROVIDER_WHITELIST CACHE PERSISTENT_DIR FETCHCMD FILE FILESDIR (Bitbake rev: 4aa8c2f93cc126778f7e99229d99b398d603fcac) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-02-11bitbake: user-manual-ref-variables.xml: Edits to PREFERRED_PROVIDER.Scott Rifenbark
(Bitbake rev: 9232cca08ec3f099475ad8dfc10e4fa3c2b39366) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-02-11bitbake: user-manual-ref-variables.xml: Added PREFERRED_PROVIDERS to glossary.Scott Rifenbark
(Bitbake rev: 86cacad8129502088011ebb622dd4d3d3663d39e) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-02-11bitbake: user-manual-ref-variables.xml: Added FAKEROOT* variables to glossary.Scott Rifenbark
FAKEROOT FAKEROOTCMD FAKEROOTBASEENV FAKEROOTDIRS FAKEROOTENV FAKEROOTNOENV (Bitbake rev: 8480db0fa7d0363741e7075bb8169a9c1b6a71dd) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>