aboutsummaryrefslogtreecommitdiffstats
path: root/bitbake/doc/bitbake-user-manual
AgeCommit message (Collapse)Author
2018-12-10bitbake: bitbake-user-manual: Added "usehead" parameter.Yong, Jonathan
(Bitbake rev: 0d436ff788f019c366cd4e66097fce928b6ff6c5) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
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: 533e1840d553c183e6ab37a350d492187c5eca96) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-04-05bitbake: fetch/local: Drop FILESDIRRichard Purdie
This has long since been deprecated and is no longer used anywhere, FILESPATH is the commonly used varaible which offers much more flexibility. Remove the FILESDIR code and references from bitbake. (Bitbake rev: 751c9dc51fd01fa64a1ff37ba2638110335f71af) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-04-03bitbake: bitbake-user-manual: Fixed special character in -D outputScott Rifenbark
Fixes [YOCTO #9962] The new output for -D was copied into the manual and merged by the engineering team before checking to see if the manual would make properly. The next output for -D introduced an error through the string "<task>". The angled bracket characters are illegal in docbook and must be replaced by "&lt;" and "&gt;", respectively. I made this fix. (Bitbake rev: 0476ec4605c94b9e0208cfd3fa48ecf3e3f04181) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-03-27bitbake: main: Improve -v and -D option documentationDiana Thayer
Expanded and clarify documentation for the -v, --verbose and -D, --debug options. [YOCTO #9962] (Bitbake rev: 921592026c69287cdb40ffd90944d5944f28e2c3) Signed-off-by: Diana Thayer <garbados@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-03-01bitbake: bitbake-user-manual: Added "path_spec" parameter to SVN FetcherScott Rifenbark
Fixes [YOCTO #10405] The section on the SVN Fetcher was missing information on the "path_spec" option. I added this option and also updated the examples at the bottom of the section to include that parameter. Also, made the other two examples consistent. I also removed the "date" parameter. Also, updated the "protocol" parameter as well as the "modify" parameter. For "modify" I removed the reference to "rsh". I applied a small wording change to the "protocol" parameter. Finally, I added a new "ssh" parameter. (Bitbake rev: 3ce6169afa646ef2b847e5fbabfe0191c93928b7) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-03-01bitbake: bitbake-user-manual: Rewrite dependency dot file generationScott Rifenbark
The package-depends.dot and pn-depends.dot files are inaccurate, missing out key dependencies such those made via the [depends] flags. As such they can be misleading to the user. They mainly exist for historical reasons, coming from a time before we had task based execution. This commit removes the two dated file formats and replaces them with a recipe-depends.dot which is a flattened version of task-depends.dot. The old format files are removed if present so that the user can't get confused about why data might not match between files. The code is also rewritten to use 'with f: f.write()' syntax as is more commonly used now. Also update the docs to match the change. (Bitbake rev: f82537d27f2a5bf9d576aa841593db9ec0985ea8) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-02-19bitbake: cooker: Rewrite dependency dot file generationRichard Purdie
The package-depends.dot and pn-depends.dot files are inaccurate, missing out key dependencies such those made via the [depends] flags. As such they can be misleading to the user. They mainly exist for historical reasons, coming from a time before we had task based execution. This commit removes the two dated file formats and replaces them with a recipe-depends.dot which is a flattened version of task-depends.dot. The old format files are removed if present so that the user can't get confused about why data might not match between files. The code is also rewritten to use 'with f: f.write()' syntax as is more commonly used now. Also update the docs to match the change. (Bitbake rev: d3e182bc18ff2894f1efc8aad3d508dd432c996e) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-02-19bitbake: doc: Replace depexp UI with taskexp and cleanup UI listsRichard Purdie
The depexp UI has been replaced with taskexp, also remove old references to goggle and hob. (Bitbake rev: 814c2b232ea5f88b5ad5031fb9d389c9c594aa01) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-01-23bitbake: bitbake-user-manual: Fixed small typo in "Events" sectionScott Rifenbark
There was a stra quote character after the word database and I removed it. (Bitbake rev: 50afcab054b2d93be96bfd3c224affebcab023cc) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-01-23bitbake: bitbake-user-manual: Updated Event descriptionsScott Rifenbark
Fixes [YOCTO #10886] Added text descriptions for many of the events in the list of the "Events" section. (Bitbake rev: e3b7e8430cb207756b59b32128aa3cef6a626fa1) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-12-08bitbake: bitbake-user-manual: Added new "Line Joining" section.Scott Rifenbark
Fixes [YOCTO #10444] Added a new section about syntax called "Line Joining". The section describes how you can use the backslash character (\) to joing stuff. (Bitbake rev: a2768ecae7846d72a1bdb7cbbc5e8d242af854f6) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-12-08bitbake: bitbake-user-manual: Refreshed the 'bitbake --help' output.Scott Rifenbark
(Bitbake rev: d7121d919beaa4be2c18d8f0bbd4afe01590eb7b) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-11-30bitbake: bitbake: remove True option to getVar callsJoshua Lock
getVar() now defaults to expanding by default, thus remove the True option from getVar() calls with a regex search and replace. Search made with the following regex: getVar ?\(( ?[^,()]*), True\) (Bitbake rev: 3b45c479de8640f92dd1d9f147b02e1eecfaadc8) Signed-off-by: Joshua Lock <joshua.g.lock@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-10-13bitbake: bitbake-user-manual: Changed BB_SETSCENE_VERIFY_FUNCTION nameScott Rifenbark
The BB_SETSCENE_VERIFY_FUNCTION variable has effectively changed to BB_SETSCENE_VERIFY_FUNCTION2. I changed the three areas in the book. Basically a name change. (Bitbake rev: 41d9cd41d40b04746c82b4a940dca47df02514fc) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-10-13bitbake: bitbake-user-manual: Fixes small typos for 'addtask' sectionScott Rifenbark
Fixes [YOCTO #10401] Applied some edits to various areas of the section. These were minor in nature. (Bitbake rev: ec99f168fd0d6feca67f2890917ba4829933c73b) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-10-13bitbake: bitbake-user-manual: Updated the [noexec] and [nostamp] flag ↵Scott Rifenbark
descriptions Fixes [YOCTO #10401] Added some wording to clarify that setting these flags to "1" causes the desired action. Also, provided a cautionary note about tasks depending on any [nostamp] task causes the task to always be executed and could cause unnecessary rebuild time. (Bitbake rev: b6a4a6147b9e455cc1fec37553fb577f187a2d73) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-10-13bitbake: bitbake-user-manual: Fleshed out the "addtask" documentationScott Rifenbark
Fixes [YOCTO #10401] The "addtask" documentation was rewritten to tighten up the introductory section and to flesh out the actual examples. (Bitbake rev: c3373399c5d565de033c40a39e6f6f9399bb782e) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-10-13bitbake: bitbake-user-manual: Updated the datastore functionsScott Rifenbark
Fixes [YOCTO #10400] No information existed for cases when a variable did not exist. I added this information to each of the variables in the table. (Bitbake rev: 466b2c30f31754a7b6a2478e359f687ec6888e0d) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-10-06bitbake: bitbake-user-manual: Added new section on BB-style functionsScott Rifenbark
Fixes [YOCTO #10364] Added a new section titled "Bitbake-Style Python Functions Versus Python Functions". This section describes differences for the user between the two types of functions. Also, cleaned up a consistency problem with the terms "BitBake style" and "BitBake-style". I used the latter throughout the manual. (Bitbake rev: e6f12157a210084d1a870832107c910df792f1d9) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-10-06bitbake: bitbake-user-manual: Updated minor wordings.Scott Rifenbark
Fixes [YOCTO #10296] Applied some minor wording changes per review edits. (Bitbake rev: 67d5501d5fd6b7ac3ee9ad97962fcf8a41d00cff) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-10-06bitbake: bitbake-user-manual: Added examples for using overrides with functions.Scott Rifenbark
Fixes [YOCTO #10296] This adds some bits clarifying you can append and prepend to functions. Added a bit to the introduction paragraph of the "Appending and Prepending (Override Style Syntax)" section to note that you can do this. Referenced some new examples. In the "Shell Functions" section I added an example. In the "BitBake Style Python Functions" section I also added an example. (Bitbake rev: 6e6b7e10e04fdb94b59bd2ead3ccb79c899c7458) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-10-06bitbake: bitbake-user-manual: Fixed grammar from missing wordScott Rifenbark
Fixes [YOCTO #10293] I omitted the work "quote" and needed to have it there. (Bitbake rev: 5087d856a39fd7be9716d1a2c185fc764f63f2c7) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-09-21bitbake: bitbake-user-manual: Added information for using single quotesScott Rifenbark
Fixes [YOCTO #10293] In the section about setting variables, I added a paragraph that explains the use of single quotes when setting a variable. The case covers when you must have the double quote charater as part of your variable's value. (Bitbake rev: 01e331cd0d612013badfb07df91151907f74903d) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-09-21bitbake: bitbake-user-manual: New section on functions you can call from PythonScott Rifenbark
Fixes [YOCTO #10100] I added a new parent directory named "Functions You Can Call From Within Python". This section contains a couple new sub-sections. One is the existing "Functions for Accessing Datastore Variables". The other is called "Other Functions", and it is used to point or reference some commonly used functions that the user can call from within Python. (Bitbake rev: ecbcedd74125ef00599f4af384ee303dae8af5b7) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-09-02bitbake: bitbake-user-manual: Added "Exporting Variables to the Environment"Scott Rifenbark
Fixes [YOCTO #10196] Added a new section named "Exporting Variables to the Environment". This section provides a dedicated description for how to export variables to the shell. (Bitbake rev: b543458dd67d24a228fa2db0ecb4ddd20016a560) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-09-02bitbake: bitbake-user-manual: Corrected misspelled STAMPS_DIRScott Rifenbark
Fixes [YOCTO #10141] Section on Checksums (Signatures) had this variable referred to as STAMP_DIR. (Bitbake rev: 7dff6762148bc2ac8f81d89bbe595dfbfdf7b119) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-08-18bitbake: ast/ConfHandler: Add a syntax to clear variableJérémy Rosen
unset VAR will clear variable VAR unset VAR[flag] will clear flag "flag" from var VAR (Bitbake rev: bedbd46ece8d1285b5cd2ea07dc64b4875b479aa) Signed-off-by: Jérémy Rosen <jeremy.rosen@openwide.fr> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-08-17bitbake: bitbake-user-manual: Re-write "Dependencies Internal to the .bb File"Scott Rifenbark
Fixes [YOCTO #10117] Applied a re-write to better clarify the behavior of dependencies. (Bitbake rev: 28bb8ef7f737034055f3485795179cfdcdb9a41f) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
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>