aboutsummaryrefslogtreecommitdiffstats
path: root/doc/user-manual
AgeCommit message (Collapse)Author
2014-04-02user-manual-metadata.xml: Added new section on mapping functions.Scott Rifenbark
Fixes [YOCTO #5472] Fixes [YOCTO #1973] Created a new section called "Automatically Mapping Functions Within the Context of a Class". This section addresses the EXPORT_FUNCTIONS "operator", which was the last of the adjustments to the variables bug against the BB manual (1973). The related bug (5472) is a general bug against enhancing the BB manual, which this change caps off. The section here was reviewed and approved by Richard Purdie. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-03-30user-manual-execution.xml: Added how BB processes curly braces.Scott Rifenbark
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-03-30user-manual-execution.xml: Updated "Checksum (Signatures) section.Scott Rifenbark
Fixes [YOCTO #5357] Added a paragraph at the end of this section to address the fact that the user can now debug Bitbake's processing of signatures. This introduces the -S bitbake option and the fact that the user can provide a couple parameters with it: "none" and "printdiff". Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-03-30user-manual-intro.xml: updated bitbake -h outputScott Rifenbark
The new -S syntax is in there now. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-03-25user-manual-metadata.xml: Added varflag for vardepvalueexclude.Scott Rifenbark
Fixes [YOCTO #5897] Added several new varflags to the existing list in the "Variable Flags" section. The key one being the "vardepvalueexclude" flag. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2014-03-25user-manual-metadata.xml: Edits to "Basic Variable Setting"Scott Rifenbark
Fixes [YOCTO #5507] I applied some edits from Richard's review to the fix for handling variable setting. Moved the new section I created into the existing "Basic Variable Setting" section. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2014-03-25user-manual-metadata.xml: Sections to handle variable setting added.Scott Rifenbark
Fixes [YOCTO #5507] I provided further explanation in the "Basic Variable Setting" section to note that trailing and leading blanks are not stripped from a value when set (e.g. VARIABLE = " value"). I added a new section "Null and Blank Setting" explaning that setting a variable to "" and " " are two different things. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2014-03-09user-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. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2014-03-09user-manual: Review edits applied from Paul Eggleton.Scott Rifenbark
Review of the entire manual by Paul. I have implemented his suggestions throughout. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2014-03-09user-manual: removed SVK references - all types.Scott Rifenbark
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2014-03-09user-manual-ref-variables.xml: Edits to BB_GENERATE_MIRROR_TARBALLS variableScott Rifenbark
Added some clarification around who would like to set this variable and why. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2014-03-09user-manual-metadata.xml: Added BB_ORIGENV example.Scott Rifenbark
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2014-03-09user-manual-metadata.xml: Grammar fix.Scott Rifenbark
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2014-03-09user-manual-execution.xml: Review edits for "Execution" chapter.Scott Rifenbark
Applied various changes from Richard Purdie's review of the "Execution" chapter. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2014-03-09user-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. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2014-03-09user-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. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2014-03-09user-manual-fetching.xml: Re-write of the Fetching chapter.Scott Rifenbark
Based on a Richard Purdie re-write. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2014-03-09user-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. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2014-03-09user-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. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2014-03-09user-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. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2014-03-09user-manual-intro.xml: Review edits to Introduction chapter.Scott Rifenbark
Applied review edits to the introduction chapter as suggested by Richard Purdie. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2014-03-09user-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. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2014-03-09user-manual-intro.xml: Added sectionsScott Rifenbark
Added the append files and layer subsections. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2014-03-09user-manual-bitbakecommand.xml: Added anchor tag for the chapter.Scott Rifenbark
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2014-03-09user-manual-fetching.xml: Re-write of "File Download Support" chapter.Scott Rifenbark
Basic re-write to clean up text and flow. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2014-03-09user-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. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2014-03-09user-manual-intro.xml: Added an introduction to the manual.Scott Rifenbark
Describes purpose and qualifies some stuff. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2014-03-09user-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. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2014-03-09user-manual-metadata.xml: WIP - Some edits in the checksum area.Scott Rifenbark
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2014-03-09user-manual-metadata.xml: Rewrite "Accessing Datastore Variables Using Python"Scott Rifenbark
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" Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2014-03-09user-manual-metadata.xml: Re-write the "Dependencies" section.Scott Rifenbark
General edits and dumping of the useless "Overview" section. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2014-03-09user-manual-metadata.xml: Re-write of "Variants - Class Extension Mechanism" ↵Scott Rifenbark
section. Some general rewrites here. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2014-03-09user-manual-ref-variables.xml: Added BBVERSIONS variable.Scott Rifenbark
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2014-03-09user-manual-metadata.xml: Re-write of "Events" section.Scott Rifenbark
General cleanup of the text. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2014-03-09user-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. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2014-03-09user-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. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2014-03-09user-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". Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2014-03-09user-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. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2014-03-09user-manual-ref-variables.xml: Edits to SRC_URI.Scott Rifenbark
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2014-03-09user-manual-ref-variables.xml: Edits to BBCLASSEXTEND.Scott Rifenbark
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2014-03-09user-manual-metadata.xml: Edits to "Sharing Functionality"Scott Rifenbark
Applied some review edits from Paul to the section. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2014-03-09user-manual-metadata.xml: Add bare bones of a scheduler sectionRichard Purdie
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-03-09user-manual-metadata.xml: Add details about general variables used by BitBakeRichard Purdie
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-03-09user-manual-metadata.xml: Add details about environment variables used by ↵Richard Purdie
BitBake Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-02-11user-manual-metadata.xml: Edits to the "Sharing Functionality" section.Scott Rifenbark
Applied some review edits from Paul to the section. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2014-02-11user-manual-metadata.xml: Edits to "Conditional Syntax (Overrides)"Scott Rifenbark
Re-wrote this section to use clearer more described examples. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2014-02-11user-manual-metadata.xml: Edits to "Defining Pure Python Functions"Scott Rifenbark
Made a review edit here to the section per Paul Eggleton. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2014-02-11user-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. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2014-02-11user-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. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2014-02-11user-manual-metadata.xml: Added "Checksums (Signatures)" section.Scott Rifenbark
Added this section to the end of the Metadata chapter. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>