summaryrefslogtreecommitdiffstats
path: root/bitbake/doc
AgeCommit message (Collapse)Author
2016-08-17bitbake: bitbake-user-manual: Added setting variable for a single taskScott Rifenbark
Fixes [YOCTO #10095] I added a third case to the "Conditional Metadata" section to describe setting a variable for a single task. (Bitbake rev: 24d648ce62b35f7d2b23fde732703c060579a0d2) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-08-17bitbake: bitbake-user-manual: Added more detail to anonymous Python functions.Scott Rifenbark
Fixes [YOCTO #10093] Provided much more detail on how these functions work. (Bitbake rev: dbe25523d899850f85acb6986eca98bf1b0ef52a) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-08-17bitbake: bitbake-user-manual: Formatted all "flags" to be consistentScott Rifenbark
Fixes [YOCTO #10071] The use of any flags throughout the manual was very inconsistent. I changed all references to any named flag in the text to be formatted as code and to be enclosed in square brackets. (Bitbake rev: be0fb616e64e54ae3e2420249f21f4edfd97d648) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-08-17bitbake: bitbake-user-manual: Added detail to [dirs] and [cleardirs] flagsScott Rifenbark
Fixes [YOCTO #10071] Provided more clear descriptions for these two flags. (Bitbake rev: c85c9a468dc3ce606a5f8797e6be8b411a9f3bdb) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-08-02bitbake: bitbake-user-manual: Applied typo fix to "Override Style Operation ↵Scott Rifenbark
Advantages" Fixes [YOCTO #9985] Fixed an operator typo from ":=" to "+=" in the note at the bottom of the section. (Bitbake rev: 319d3d387161182069e6d1b3db17ccb539d097ed) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-08-02bitbake: bitbake-user-manual: Changed bitbake command example.Scott Rifenbark
Fixes [YOCTO #7718] In the "Executing a List of Task and Recipe Combinations" section, I changed the improper bitbake command example to use the correct syntax. This change was review feedback. (Bitbake rev: c79fab1be4898ec88bfddd4c4f84e76dc3a3125b) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-08-02bitbake: bitbake-user-manual: Updated the PROVIDES variableScott Rifenbark
Fixes [YOCTO #10011] Added paragraphs near the end to describe the role of virtual targets. (Bitbake rev: fc47bb99dbc1972dfb3a83c0f4c479963da64bcc) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-08-02bitbake: bitbake-user-manual: Added non-existant variable expansionScott Rifenbark
Fixes [YOCTO #10003] I added a small paragraph explaining what happens when expansion of a variable that does not exist occurs. (Bitbake rev: 8006da3f229d0227215ccd59cd273edacf72f9ce) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-08-02bitbake: bitbake-user-manual: Applied some review commentsScott Rifenbark
Fixes [YOCTO #9985] Fixed some problems with the changes. A small typo for an example and added a clarifying operator in another sentence. (Bitbake rev: d8ae3775eefe3f7b62fc26cae5b742ae83850c13) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-08-02bitbake: bitbake-user-manual: Updated the "Inline Python Variable Expansion" ↵Scott Rifenbark
section. Fixes [YOCTO #9984] Added a small note to the bottom to help clarify. (Bitbake rev: 64bf49826088c56b739ed971251f05b4564c712e) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-08-02bitbake: bitbake-user-manual: Fixed override operator syntax.Scott Rifenbark
I had inconsistent usage of the "_append" style operator syntax in the chaper. I was using a mix of <filename>_append</filename> and "_append". I changed to "_append" for consistency. (Bitbake rev: 5c5b88e402376268baa15c5d04d2592f28d76751) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-08-02bitbake: bitbake-user-manual: Clarified override-style operators.Scott Rifenbark
Fixes [YOCTO #9985] Made the following changes: * Section Removal (Override Style Syntax): Added a small qualifying sentence at the end to further define behavior * Added new section "Override Style Operation Advantages": This section provides some rationale behind the "_append" style operations. * Section "Examples": Changed an example to use the "=" operator rather than the "+=" operator. (Bitbake rev: 797d9627baad9ccd3d55e825c0d705311f631f78) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-08-02bitbake: bitbake-user-manual: Updated the variable expansion section.Scott Rifenbark
Fixes [YOCTO #9984] Added more detail to the examples that show the effects of variable expanison. (Bitbake rev: 480096ca93c0a649ebfff68dfc7d9bbe8eb2ea2d) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-08-02bitbake: Revert "bitbake-user-manual: Added new section on command-line ↵Richard Purdie
execution" This reverts commit 6f6cd0674fd1595f4e74b7da692e0c348b2660c6 as it was a duplicated commit. Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-07-21bitbake: bitbake-user-manual: Added new section on command-line executionScott Rifenbark
Needed a section on executing a list of task and recipe combinations. (Bitbake rev: 6f6cd0674fd1595f4e74b7da692e0c348b2660c6) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-07-21bitbake: bitbake-user-manual: Applied review edits to "Recursive Dependencies"Scott Rifenbark
Added a minor tweak to the third paragraph to be more inclusive of the topic. Fixes [YOCTO #9970] (Bitbake rev: a5d36e8bccf35ffbca41a4facaa041d36f587529) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-07-21bitbake: bitbake-user-manual: Fixed typo in the BBDEBUG variable description.Scott Rifenbark
In the BBDEBUG variable description, the "-d" parameter needed to be "-D". Fixed it. Fixes [YOCTO #9950] (Bitbake rev: 475e7611f6c5b884d86152cb0b334e9d96849608) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-07-21bitbake: bitbake-user-manual: Added review changes to BBCLASSEXTEND descriptionScott Rifenbark
Fixes [YOCTO #9909] Added some technical clarifications to the existing note to be clear about what is causing the limitations in this case. Applied some formatting fixed to for the use of the include word. (Bitbake rev: e9ad2e0f6d2681dd793cc39c468eb86e57fd6f48) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-07-21bitbake: bitbake-user-manual: Added review changes to recursive section.Scott Rifenbark
Applied formatting to a "after" word that should be <filename>after</filename>. Also added a new clarifying paragraph in the "Recursive Dependencies" section. Fixes [YOCTO #9861] (Bitbake rev: ada90f68afd17cb85cb5957f3f91b537ee3599f6) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-07-21bitbake: bitbake-user-manual: Addeds support for the Perforce FetcherAndrew Bradford
Added a new Perforce Fetcher section in the same spirit as the existing sections for other supported fetchers. Changes included the new section, removal of the bulleted item that mentioned this fetcher as an "additional" fetcher, and the creation of a new variable in the glossary named P4DIR. (Bitbake rev: 47e03b1789ee1c18407dbac33a6c235752019865) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-07-21bitbake: bitbake-user-manual: Added clarifying note to BBCLASSEXTEND variable.Scott Rifenbark
Fixes [YOCTO #9909] Added a note that talks about how the BBCLASSEXTEND mechanism adds recipe variants. (Bitbake rev: 185c9c5fc205fe9c9daf5238f11b92bd0954f5c6) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-07-21bitbake: bitbake-user-manual: Added a note providing examples of task ↵Scott Rifenbark
dependencies Fixes [YOCTO #9861] In the "Dependencies internal to the .bb File" section, I placed a note providing more detail on how recipes are built regarding task dependency. (Bitbake rev: c2e72928fbd21d622860a54a55f4239ba27c07a2) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-07-21bitbake: bitbake-user-manual: Updated dependency section for tasksScott Rifenbark
Fixes [YOCTO #9861] I updated the section on dependencies to give a couple of examples for task dependencies within a single recipe and dependencies for tasks between two individual recipes. (Bitbake rev: 231deeb2b0b3847cba971ca30c16e29357100ae6) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-07-21bitbake: bitbake-user-manual: Updated the defaults for getVar and getVarFlagScott Rifenbark
There is no default. Fixes [YOCTO #9683] (Bitbake rev: 886afd6d876c9ae04cf681931db8f1774dc53096) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-07-21bitbake: bitbake-user-manual: Added new section on command-line executionScott Rifenbark
Needed a section on executing a list of task and recipe combinations. (Bitbake rev: 17f7f366df3a5951ae88e24c43aecf3d65d83c14) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-05-19bitbake: Provide LAYERDIR_RE for layer.confChristopher Larson
This variable is a regex-escaped version of LAYERDIR, for safer use in BBFILE_PATTERN, so as to avoid issues with regex special characters in the layer path. [YOCTO #8402] (Bitbake rev: 72900522778b6ff08b135bf8bb97dff3f1a20bd9) Signed-off-by: Christopher Larson <chris_larson@mentor.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>