aboutsummaryrefslogtreecommitdiffstats
path: root/bitbake/doc/bitbake-user-manual
AgeCommit message (Collapse)Author
2018-01-17bitbake: bitbake-user-manual: Fixed porno hack for hello world exampleScott Rifenbark
Someone hacked the http://hambedded site or it was moved and some links to that site in the BB manual had been hijacked to point to an entry portal for a pornography site. Replaced the link with an archived version that restores the integrity of the links. (Bitbake rev: d0a4652fec6d3968b65b4a2776948a7b9e19407e) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-04-18bitbake: bitbake-user-manual: Updated the 'bitbake -h' output example.Scott Rifenbark
(Bitbake rev: 4ca651d32d9e5fbf7f932b4167804905969f4c3a) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-04-18bitbake: bitbake-user-manual: Updated "Conditional Metadata" sectionScott Rifenbark
Added information about using lower-case characters and no underscore characters when using OVERRIDES. (Bitbake rev: 4397a023f8bf738913d71a38b3e06503207311e2) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-04-15bitbake: bitbake-user-manual: Updated discussion about using "inherit"Scott Rifenbark
Fixes [YOCTO #9343] I updated the inherit directive section to note that you can inherit multiple classes using a single line. (Bitbake rev: 3f29ebec593f20894f7a2a0b6d50ee22474aee75) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-23bitbake: bitbake-user-manual: include/require checks current directoryScott Rifenbark
I added wording to note that include/require checks the current directory in addition to BBPATH Fixes [YOCTO #8566] (Bitbake rev: bdad45ebe551912b055ffa349d254ae5947a3ba6) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-23bitbake: bitbake-user-manual: Updated the "inherit Directive" section.Scott Rifenbark
Fixes [YOCTO #9283] Updated the description to document conditional inherits. Provided several examples. (Bitbake rev: 07f97f4d913cf1c8233995152105fff6c6c7b9a0) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-23bitbake: bitbake-user-manual: Updated the copyright year to 2016Scott Rifenbark
(Bitbake rev: ea6d31a569d18b07cfc977d994a320a588c4f9c2) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-03bitbake: bitbake-user-manual: Added expand() function to list.Scott Rifenbark
Fixes [YOCTO #9147] Added the d.expand(expression) fuction to the list of functions in the "Accessing Datastore Variables Using Python" section. (Bitbake rev: 19507b80f35d37dc4b1614bd390b8e261dd4a2bd) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-03bitbake: bitbake-user-manual: Added note for Python variable ref expansion.Scott Rifenbark
Fixes [YOCTO #9148] Added a note about Variable expressions (e.g. ${X}) are no longer expanded within Python functions. (Bitbake rev: 4ebe55cb8c8db1c5cf5d127e213487c5a453a68a) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-03bitbake: bitbake-user-manual: Enhance environment variable discussion.Scott Rifenbark
Fixes [YOCTO #8567] Updated the variable list describing the variables that affect how environment variables are handled. Also updated the section on how those variables are passed. (Bitbake rev: 91cb52b1e77bba9d046239933b5c0513d01e6824) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-01-29bitbake: bitbake-user-manual-ref-variables: Update the help for BBMASKPeter Kjellerstedt
Update the help for BBMASK to reflect that it is now allowed to contain multiple regular expressions. Also changed the examples for BBMASK to be a bit more diverse. (Bitbake rev: 023a5b69df05adce0ed192b393b45eb879c096a0) Signed-off-by: Peter Kjellerstedt <peter.kjellerstedt@axis.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-01-29bitbake: bitbake-user-manual-metadata: Updated 'dir' flagMartin Samuelsson
Added more detail to the 'dir' flag to state the last directory listed will be used as the work directory for the task. (Bitbake rev: 2fbd9e4e44f6b491cccca81fd34586fcfdeea3d3) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-01-29bitbake: bitbake-user-manual: Updated the example BitBake directoryScott Rifenbark
This directory no longer has setup.py as part of the directory. I removed that line from the example in the "Obtaining BitBake" section. Fixes YOCTO #8623 (Bitbake rev: 6a82f6432022debe48830db98b3fb16424411a87) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-10-29bitbake: bitbake-user-manual: Added new description for BB_TASK_IONICE_LEVELScott Rifenbark
Added a new variable description here for this variable. (Bitbake rev: 4e0da1ef4a58a7ba4b92d4e07ef79cf7bd90abf0) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-10-29bitbake: bitbake-user-manual: Added BBTARGETS variable description.Scott Rifenbark
(Bitbake rev: 0f0c205b9d6c24bee334eabb359973e0368ce931) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-08-01bitbake: bitbake-user-manual-fetching.xml: note about URLs with semi-colonsJuro Bystricky
Some URLs contain semi-colons. Unfortunatelly, bitbake uses semi-colons in SRC_URI as delimiters for various parameters. It may still be possible to use such URLs, providing the user replaces semi-colons ';' with '&' characters. For example: http://abc123.com/git/?p=gcc/gcc.git;a=snapshot;h=a5dd47 and http://abc123.com/git/?p=gcc/gcc.git&a=snapshot&h=a5dd47 should be equivalent, as W3C recommends treating ';' in queries identically to '&'. See http://www.w3.org/TR/1999/REC-html401-19991224/appendix/notes.html#h-B.2.2 Kudos to Olof Johansson (Bitbake rev: d8953c16c52c6e5de879f4a32ec8aeee396bb410) Signed-off-by: Juro Bystricky <juro.bystricky@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-06-23bitbake: bitbake: Add explict getVar param for (non) expansionRichard Purdie
Rather than just use d.getVar(X), use the more explict d.getVar(X, False) since at some point in the future, having the default of expansion would be nice. This is the first step towards that. This patch was mostly made using the command: sed -e 's:\(getVar([^,()]*\)\s*):\1, False):g' -i `grep -ril getVar *` (Bitbake rev: 659ef95c9b8aced3c4ded81c48bcc0fbde4d429f) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-06-23bitbake: bitbake-user-manual-ref-variables: Added BBLAYERS_FETCH_DIR ↵Trevor Woerner
glossary item. Add BBLAYERS_FETCH_DIR to the Variables Glossary. (Bitbake rev: 5ecd6a671c088f270d5f49093f8da83278fc0aa9) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-06-16bitbake: bitbake-user-manual-ref-variables.xml: Added BB_ALLOWED_NETWORKS desc.Scott Rifenbark
Added a new variable description for the BB_ALLOWED_NETWORKS variable. (Bitbake rev: 1408654e6d8f5ae962744c6cc2d8a49df34c5101) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-05-22bitbake: bitbake-user-manual: Updated "Delete a Task" section for broken depsScott Rifenbark
Fixes [YOCTO #7803] I added information for the scenario where deleting a task using the deltask command could "break" implicit dependencies. (Bitbake rev: 5ea3a206bb5beef4c12d56d9e42e29d324a08e16) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-05-19bitbake: bitbake-user-manual-customization.xsl: Pointing to mirrors for XSL ↵Scott Rifenbark
files. Instead of pointing to the Sourceforge area, which seems to flake out every so often, we are now pointing to a mirror to get the XSL files needed to build the manual. (Bitbake rev: d9811231b4c8211446bd9275084c26a4718cd175) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-05-12bitbake: bitbake-user-manual-metadata.xml: Alphabetized varflag list.Scott Rifenbark
This list should have been in alphabetical order. It is now. (Bitbake rev: 9b7fae5c36c7b48237ce7903434602ebc1a07b20) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-05-12bitbake: bitbake-user-manual-metadata.xml: Added two new varflag descriptionsScott Rifenbark
Added brief descriptions for recideptask and lockfiles. Reported-by: Robert P. J. Day <rpjday@crashcourse.ca> (Bitbake rev: ee52aa304680a27529264cb186df6936b0375118) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-04-17bitbake: bitbake-user-manual: Cleaned up parallelism note and formatted user ↵Scott Rifenbark
input I updated the note in the second chapter that discusses the role for BB_NUMBER_THREADS. The updates make it a bit clearer. Also scrubbed the manual for instances of user-supplied values to check how they are being formatted. I fixed the formatting to use the <replaceable></replaceable> tags so they are in italics. (Bitbake rev: e2879c60e905d7566091d40eab330372fa001313) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-02-10bitbake: bitbake-user-manual: Removed errant writer note line.Scott Rifenbark
Removed a note to myself in the BB_ORIGENV example. Reported-by: Paul Eggleton <paul.eggleton@intel.com> (Bitbake rev: 27848725316ddae619c1b86f8adc0bfecfadf413) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-02-10bitbake: bitbake-user-manual: Added some links to some new variables.Scott Rifenbark
(Bitbake rev: 5b8249acabad3eeedcf564590e6ab71588aec89c) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-02-10bitbake: bitbake-user-manual: Added five new repo variables and links.Scott Rifenbark
Added the following variables to the glossary: CVSDIR GITDIR SVNDIR HGDIR BZRDIR Several areas in the main manual mentioned these variables. For each, I added the appropriate link to the glossary term. (Bitbake rev: 5b797c758bf0499646e4e0256f03fbbdfb3ea080) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-12-09bitbake: bitbake-user-manual-metadata.xml: Updated do_package_write exampleRobert P. J. Day
Given that the "do_package_write" task doesn't exist in OE anymore, steal another, existing example to demonstrate the "rdeptask" flag. (Bitbake rev: 9e27bb2869e8ec6781d2f68d0585ebbf9ca6f3d8) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-12-09bitbake: bitbake-user-manual-metadata.xml: Added [eventmask] flag information.Scott Rifenbark
Reported-by: Laszlo Papp <lpapp@kde.org> (Bitbake rev: 38150bc53c6bda5be7194f9acd112d362506d2ea) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-12-09bitbake: bitbake-user-manual: Updated copyright to 2015.Scott Rifenbark
(Bitbake rev: be8f0076667f17587dbcff4b6b6467a7ec29d2b8) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-11-06bitbake: bitbake: Make printed 'runqueue' be consistently capitalizedGary Thomas
This has always bothered me: NOTE: Preparing runqueue NOTE: Executing RunQueue Tasks This patch changes the messages to be consistent. (Bitbake rev: 72ac9f9227fbfb4dc8b933b357d21aa0e4060959) Signed-off-by: Gary Thomas <gary@mlbassoc.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-08-02bitbake: bitbake-user-manual-metadata.xml: Fixed variable flags example.Scott Rifenbark
(Bitbake rev: 78b6c89931a78b2c722d2fcf61cf553b45566a5a) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-08-02bitbake: bitbake-user-manual-fetching.xml: Minor edits to clearcase fetcherScott Rifenbark
(Bitbake rev: 33cd736d84eb8d4719e430450f26acaee5b31782) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-08-02bitbake: bitbake-user-manual/bitbake-user-manual-intro.xml: Fixed linkScott Rifenbark
I inadvertantly used a &YOCTO_* variable in the book to get a link to the landing YP page. Of course this does not work. I replaced it with the actual URL. Unfortunately, a previous commit slipped through that would have prevented the manual from "making" correctly. (Bitbake rev: 63f5a4b06a575e1fb18805b45a01549bffdc4a03) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-08-02bitbake: bitbake-user-manual-fetching.xml: Added new clearcase fetcher module.Scott Rifenbark
Reported-by: Richard Purdie <richard.purdie@linuxfoundation.org> (Bitbake rev: dc669c4beda04ee88a50c9b48facfbd8cf17a331) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-07-23bitbake: "per-package" should say "per-recipe"Robert P. J. Day
(Bitbake rev: 1cd369883469747a8158826bb8d67dcca2a8577f) Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-07-22bitbake: Updated the the example 'bitbake -h' output to match the actual ↵Scott Rifenbark
output, which has been recently patched to fix the '-S SIGNATURE_HANDLER, --dump-signatures=SIGNATURE_HANDLER' option. Note also, that I have added a new option that has since appeared in the output but was not in the manual's example. That option added is '--token=XMLRPCTOKEN'. Reported-by: Richard Purdie <richard.purdie@linuxfoundation.org> (Bitbake rev: 8fbffd25d42f1f2d9a85ae1d9cc4852e835730d4) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-07-21bitbake: bitbake-user-manual-metadata.xml: fixed some example whitespace issuesScott Rifenbark
I added some whitespace to bring the example to use 5 spaces rather than for so that it follows the manual's convention. (Bitbake rev: 4c6e7d88d715db18e61bb263dfd2672ebb6c6b09) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-07-21bitbake: bitbake-user-manual-metadata.xml: KERNEL_FEATURES example updated.Scott Rifenbark
I added text to separate this example code from the general BitBake User Manual's spirit of standing alone and away from YP or OE stuff. Also, added another space to move the examples code so that 5 spaces are used for literal indentation. (Bitbake rev: 17fcac8a7b21afa5c7d201e94cbf603ab07ba70c) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-07-21bitbake: bitbake-user-manual-metadata.xml: Fixed whitespaceScott Rifenbark
I noticed that the examples from some patches were not indenting by 5 spaces. I have fixed these to be consistent. (Bitbake rev: c487341bd20b70aae6b430ee1c74a7f20345f81a) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-07-21bitbake: bitbake-user-manual-metadata.xml: Removed fakeroot from listRobert P. J. Day
"fakeroot" is now specified as a function attribute, not as a task flag. (Bitbake rev: 749b39a8e5e8060222c748a349efc31f541da94e) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-07-21bitbake: bitbake-user-manual-metadata.xml: Added second conditional metadata ↵Robert P. J. Day
example. I think having a couple real-life examples here would make a huge difference. Comment from Scott: I modified the example description to indicate that it is from an OpenEmbedded metadata-based recipe (i.e from YP). We have been trying very hard to keep the BitBake User Manual as separate as possible from the YP docs. (Bitbake rev: 834780772a08ecce7ed863e96d0674b47d0e589d) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-07-21bitbake: bitbake-user-manual-metadata.xml: Adding some flag examples.Robert P. J. Day
As long as i've understood everything correctly, this is just throwing in some physical examples of a couple concepts. (Bitbake rev: a18cc69c2fef6484a6acd78ea008d1da71198e68) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-07-21bitbake: bitbake-user-manual-metadata.xml: Edits to some operatorsScott Rifenbark
Added wording to clearly state immediate or delayed application for various operators. Reported-by: Robert P. J. Day <rpjday@crashcourse.ca> (Bitbake rev: 877c4c9a466e26953abd6fe416c2cba092607dac) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-07-21bitbake: bitbake-user-manual-execution.xml: Minor edits to execution chapter.Robert P. J. Day
(Bitbake rev: 8ff1b363df74f7e48da67fce9cf6b7e868c5e28e) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-07-21bitbake: bitbake-user-manual-intro.xml: More edits to the intro chapter.Robert P. J. Day
Some applied as is, some not applied, some modified. (Bitbake rev: af98b2ff4f44f892b63a6598e7fdfc144972ed3d) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-07-21bitbake: bitbake-user-manual-intro.xml: Minor edits to start of intro chapterRobert P. J. Day
(Bitbake rev: 4e5db4bc460c12194a233dd283c273009606bb64) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-07-21bitbake: bitbake-user-manual-metadata.xml: Replaced "populate_staging"Robert Yang
There is no "populate_staging" any longer, should be "populate_sysroot". (Bitbake rev: dbe5902e64259e2143f09ab1aa9afa03aa02f4c4) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-07-21bitbake: bitmake-user-manual-fetching.xml: Added transportuser parameter for SVNScott Rifenbark
Fixes [YOCTO #6475] A new parameter has been added to make sure the user is not passed as the username for the subversion commands with the SVN fetcher. (Bitbake rev: 366c70dbb0e9916f50ce1a4ff3ad4bd2757832a3) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-07-03bitbake: bitbake-user-manual-ref-variables.xml: Edits to OVERRIDES variable.Scott Rifenbark
More detail. (Bitbake rev: 0ac8a504de1798dae02eb2dade2776e7e25d034d) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>