summaryrefslogtreecommitdiffstats
path: root/bitbake/doc
Commit message (Collapse)AuthorAgeFilesLines
* bitbake: user-manual: Fix issue with previous revertRichard Purdie2014-01-281-1/+1
| | | | | | (Bitbake rev: 2d052690d46506ba3f4180ad5cdfa835ce85e59a) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: Revert "usermanual: Updated CC License to version 3.0"Richard Purdie2014-01-281-1/+1
| | | | | | | | | This reverts commit 0546bc19557de9263b448ceb1707884543d2de56. This change was not discussed with the copyright holders so the license needs to remain at version 2.5. Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: user-manual-ref-variables.xml: Added 10 new variables to the glossary.Scott Rifenbark2014-01-271-5/+158
| | | | | | | | | | | | | | | | | | | | Fixes [YOCTO #5472] 1. ASSUME_PROVIDED 2. BB_CURRENTTASK 3. BB_FETCH_PREMIRRORONLY 4. BB_FILENAME 5. BB_NICE_LEVEL 6. BB_HASHCONFIG_WHITELIST 7. BB_TASK_NICE_LEVEL 8. BB_NO_NETWORK 9. BB_NUMBER_PARSE_THREADS 10. STAMPCLEAN (Bitbake rev: 72a01a54c4786a7a82ae8b86b8e2beedd07f7f21) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: user-manual-ref-variables.xml: Fixed references to "Build Directory".Scott Rifenbark2014-01-271-5/+4
| | | | | | | | | | | I made sure that these are lower-cased. Also, removed the tags for cross-referencing into the term section of the YP Development Manual. (Bitbake rev: f9e3de2bb3e73204ef35d102ff26ee7393056ede) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: user-manual-ref-variables.xml: Editing pass.Scott Rifenbark2014-01-271-46/+47
| | | | | | | | | | Corrected grammar and applied active voice where possible. Also removed several cross-reference tags to the YP manual set. (Bitbake rev: 17cbad436c97e904a04596237022e84853b10a21) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: template/titlepage.templates.xml: Suppress Title Text.Scott Rifenbark2014-01-271-3/+22
| | | | | | | | | | | | | | | | I commented out two blocks of code that are responsible for getting the book's title to format onto the title page. Commenting the code out suppresses the title from the PDF version's title page yet retains the title text for the HTML tab space of the browser. The reason this is necessary is because the BitBake User Manual uses an image file for the title. Thus, it is not necessary to print the title again. (Bitbake rev: d7f15880c5423d91fd786e291f3e062545342184) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: user-manual-customization.xsl: Updated param list to passScott Rifenbark2014-01-271-1/+7
| | | | | | | | | | I added five parameters here to match the build process used for the YP manual set. (Bitbake rev: f95994be26986098c2603ef6d4cb10f06422b790) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: user-manual-metadata.xml: Renamed section tagScott Rifenbark2014-01-271-1/+1
| | | | | | | | | | | | | There were two section tags that used the same id name "classes". One was in the intro chapter and one was in the metadata chapter. This was causing an exception in the PDF creation process and breaking it. I renamed the tag in the metadata chapter "metadata-classes". (Bitbake rev: d5f405586f7c50c602241519d32d02b1c7b1f345) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: user-manual-ref-variavbles.xml: Added new glossary chapter.Scott Rifenbark2014-01-272-0/+1323
| | | | | | | | | | | Added a scrubbed copy of the YP ref-manual glossary. The content was scrubbed to contain BB variables only. Removed broken cross-references, made sure the PDF file built. (Bitbake rev: aae6bcb7fb6e056eb7b1027a8054f6ea5f8ab2b2) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: user-manual-bitbakecommand: Various edits/cleanupsRichard Purdie2014-01-271-74/+88
| | | | | | (Bitbake rev: f079e0886b1b191d84621057f9752cc32bfabb44) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: user-manual-bitbakecommand: Standardise on section tags, not exampleRichard Purdie2014-01-271-27/+34
| | | | | | (Bitbake rev: c85a035608b7c862d964f45bb1b767fde072a1de) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: user-manual-bitbakecommand: Replace screen tags with literallayoutRichard Purdie2014-01-271-39/+68
| | | | | | (Bitbake rev: 4fffe48ab607fd0d2f884186006ee168874b8414) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: user-manual-bitbakecommand: Reform whitespaceRichard Purdie2014-01-271-108/+245
| | | | | | (Bitbake rev: f1a6d7029e7adc147655809dca71782a143c5ac5) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: user-manual-bitbakecommand: Update help text output with that from ↵Richard Purdie2014-01-271-38/+60
| | | | | | | | bitbake master (Bitbake rev: bd1da5001c03cba17a4c61cfb854ab394c50e732) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: user-manual-fetching: Editing pass over the manual chapterRichard Purdie2014-01-271-44/+53
| | | | | | (Bitbake rev: b0fc79e6405b7070a42cfda035e87edc832f8334) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: user-manual-fetching: Change varname/emphasis tags to filenameRichard Purdie2014-01-271-50/+50
| | | | | | (Bitbake rev: 3b04c18212f3f0c22a1167dc6f62210e54ed2002) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: user-manual-fetching: Change screen -> literallayoutRichard Purdie2014-01-271-39/+37
| | | | | | (Bitbake rev: e0474be77c954cac3bb9b403d6c854ff447cc02d) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: user-manual-fetching: Change the file whitespaceRichard Purdie2014-01-271-59/+190
| | | | | | (Bitbake rev: 7e32068d1ab4e1f342f70a8338bb8a51fc783da9) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: user-manual-metadata: Clean up task documentationRichard Purdie2014-01-271-4/+24
| | | | | | (Bitbake rev: 55158ce6c5435544a62a60c0055724619bafde27) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: user-manual-metadata: Clean up task flag sectionRichard Purdie2014-01-271-10/+26
| | | | | | (Bitbake rev: b2e8c56d0f554e3b118f23b42858319110501180) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: user-manual-metadata: Expand parsing process docuemtnationRichard Purdie2014-01-271-1/+87
| | | | | | (Bitbake rev: 2596dd2b42c06ef258032356294cc345a6e25fed) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: user-manual-metadata: Add section about layersRichard Purdie2014-01-271-0/+40
| | | | | | (Bitbake rev: 0a99fe01dc273c548f7f83f9a7695c21184e7331) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: user-manual-metadata: Add section about INHERITRichard Purdie2014-01-271-0/+9
| | | | | | (Bitbake rev: f2ffe0365df7aa9c7d6c57b6bff8a5bbed198bfb) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: user-manual-metadata: Add section about running tasks and the ↵Richard Purdie2014-01-271-0/+74
| | | | | | | | environment (Bitbake rev: b32524643c125c78848630a5ce18d1df36313bc7) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: user-manual-metadata: Rework section about shell/python functionsRichard Purdie2014-01-271-12/+49
| | | | | | (Bitbake rev: c2bcb5364ff7c702bc1ec2726169f608b445f979) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: user-manual-metadata: Add section about data store operationsRichard Purdie2014-01-271-0/+69
| | | | | | (Bitbake rev: 85ffd05f292386de1b098debb6a3d3fe18c6b6b7) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: user-manual-metadata: Add lists of common eventsRichard Purdie2014-01-271-0/+27
| | | | | | (Bitbake rev: 240d3f0439e7c1f12e06fa738acc20fbcac8ae65) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: user-manual-metadata: Editing pass over the manual chapterRichard Purdie2014-01-271-105/+137
| | | | | | (Bitbake rev: 6f326f2f2785d6d48d7753abee6e8162852d8702) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: user-manual-metadata: Use filename tags instead of literal and ↵Richard Purdie2014-01-271-103/+110
| | | | | | | | varname tags (Bitbake rev: 56f8c4ad09c244522d68e203fe4cb76d593a9f2f) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: user-manual-metadata: Replace screen tags with literallayout tagsRichard Purdie2014-01-271-178/+142
| | | | | | (Bitbake rev: be3967f9f088e414c679e72a947817b60bab82d7) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: user-manual-metadata: Update whitespace (no content changes)Richard Purdie2014-01-271-247/+621
| | | | | | (Bitbake rev: 7eb1e340321ab4a5baa23e83eebf65ba13d23aef) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: user-manual-metadata: Reorder sections to more logical orderRichard Purdie2014-01-271-92/+95
| | | | | | (Bitbake rev: 6f2bed62bde5cd20f91c336b158f60f4a6bcb82f) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: user-manual-metadata: Add section ids for most sectionsRichard Purdie2014-01-271-33/+59
| | | | | | (Bitbake rev: 4ad94fb161d5fe24869696187e01004bff61d569) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: user-manual-hello.xml: Added new chapter for "Hello World Example"Scott Rifenbark2014-01-271-0/+321
| | | | | | | | | | | | | | | This file was evidently a "working" file and not included in the manual at the point Bill left off. The wmat branch, however, had a load of commits dedicated to this file. Rather than attempt to replay them all one-by-one, I simply copied the file from the wmat branch and hand-inserted the changes to make it equal to what was there. Note also that I re-formatted the file to have the same formatting standards I use in the YP manuals. (Bitbake rev: 9ddbf31ba7d05a596ca53b8ed78d94221850894b) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: user-manual.xml: Cleanup on the title page.Scott Rifenbark2014-01-271-7/+60
| | | | | | | | | | 1. Added commented out manual revision history. 2. Cleaned up the author stuff. (Bitbake rev: df92da67ddbb2bcc672911626b9abd1a168cf436) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: user-manual-intro.xml: Re-write of BitBake introduction.Bill Traynor2014-01-271-15/+40
| | | | | | | (Bitbake rev: afc998a73f09f3d1a0d7e22425badfa5b7001aa1) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: user-manual-intro: Various minor cleanups/improvementsRichard Purdie2014-01-271-23/+20
| | | | | | (Bitbake rev: 5e22c0c5d4bb9e63142a13618f5f87e53c83d9f2) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: user-manual-intro: Add obtaining bitbake and summary sectionsRichard Purdie2014-01-271-0/+83
| | | | | | | | Add new obtaining bitbake and summary sections from Bill Traynor (Bitbake rev: 083e4e44f52ffdfca68ce6c56eae85ce3b719e1b) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: user-manual-intro.xml: Added "Concepts" section.Scott Rifenbark2014-01-271-1/+89
| | | | | | | | | | Provided initial text for recipes, configuration files, and classes. (Bitbake rev: 55875bcf682979ce538845a8118452425ff96cfc) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: user-manual-intro: Update/improve whitespaceRichard Purdie2014-01-271-33/+95
| | | | | | (Bitbake rev: fb74a1926c3a603a4c1ebe0325b27fb2c3aec3ee) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: user-manual-intro: Expand introduction and fix spelling mistakesRichard Purdie2014-01-271-14/+45
| | | | | | | | | | | Expand the introduction section, fill out the section ids and fix some spelling mistakes. Wording from Bill Traynor/Scott Rifenbark (Bitbake rev: 780f61da6a59c52555de8574093a264d565b2a75) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: documentation: Add README based off the YP docs oneBill Traynor2014-01-271-0/+39
| | | | | | | | | | | Reusing the README file from the Yocto Project Documentation directory but removed the YP specific content and changed to be specific to BitBake. (Bitbake rev: 67b6e9c54676e979c546c0d350b2d01443f13f36) Signed-off-by: Bill Traynor <wmat@alphatroop.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: user-manual: Separate out chapters into individual filesRichard Purdie2014-01-276-627/+642
| | | | | | | | | Splitting the manual into a chapter per file makes the content a little more managable. (Bitbake rev: 020178eba958d2d5142ee0909fc0fd133b97cd92) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: user-manual: Import YP Docs templates for usermanual improvementsBill Traynor2014-01-2717-56/+2538
| | | | | | | | | | | | Import the necessary pieces to be able to build the BitBake User Manual using make in a similar way that the Yocto Documentation is built. The Makefile has been edited to remove Yocto Project specific content and adapt for bitbake's needs. (Bitbake rev: d4199078692f86341ed5b42a7c2dd4b34819aead) Signed-off-by: Bill Traynor <wmat@alphatroop.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: usermanual: Renamed manual dir to user-manual to be consistent.Bill Traynor2014-01-273-0/+0
| | | | | | | | | | | Renaming the manual directory to user-manual in order to allow for future additions of specific manual types, such as a dev-manual. (Bitbake rev: 4617aa5e8491067f7825062ed3baee27cf697e88) Signed-off-by: Bill Traynor <wmat@alphatroop.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: usermanual: Updated CC License to version 3.0Bill Traynor2014-01-271-1/+1
| | | | | | | | | | Updated the Creative Commons License to the most current version, version 3.0. Also updated the Creative Commons mailing address. (Bitbake rev: 0546bc19557de9263b448ceb1707884543d2de56) Signed-off-by: Bill Traynor <wmat@alphatroop.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: bitbake: usermanual.xml: fix a typoRobert Yang2014-01-071-1/+1
| | | | | | | | | | | | Fixed: "should created" -> "should be created" [YOCTO #5703] (Bitbake rev: 146318729dbeeee4136bcb4832e6f8f69f9a2489) Signed-off-by: Robert Yang <liezhi.yang@windriver.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: usermanual.xml: Two new sections added to BitBake "Description"Scott Rifenbark2013-09-171-1/+19
| | | | | | | | | | | | | | 1. Added a new section "Appending and Prepending (override style syntax)". This section shows how the append and prepend operators work using the override style syntax. 2. Added a new section "Removing (override style syntax)". This section describes the new "_remove" operator. (Bitbake rev: 6983afab0ce8d82d102142636d5a570f7d86a844) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: doc/bitbake.1: Update with missing parametersRichard Purdie2013-03-251-0/+18
| | | | | | | | | | | Patch from Nobuhiro Iwamatsu <nobuhiro.iwamatsu.yj@renesas.com> to add missing parameters to bitbake man page. Added hob to ui list too. [YCOTO #4049] (Bitbake rev: ca7cd6c1318e0ef066f9e12e7516a47b2af3a7d1) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: usermanual: Fix missing markupRobert P. J. Day2012-07-061-1/+1
| | | | | | (Bitbake rev: 68af2b09315ba35eae24933a599014a662789c2c) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>