aboutsummaryrefslogtreecommitdiffstats
path: root/doc/bitbake-user-manual/bitbake-user-manual-metadata.xml
AgeCommit message (Collapse)Author
2017-10-07bitbake-user-manual-metadata: include a space on a append exampleLeonardo Sandoval
By definition, the override operator "_append" does not include a space, so include it. Signed-off-by: Leonardo Sandoval <leonardo.sandoval.gonzalez@linux.intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-09-13bitbake-user-manual: Edits to "inherit" section.Scott Rifenbark
Fixes [YOCTO #12031] Applied minor wording changes based on review feedback. Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
2017-09-13bitbake-user-manual: Updated inherit and INHERIT sectionsScott Rifenbark
Fixes [YOCTO #12031] Moved an inappropriate example from the bottom of the INHERIT Configuration Directive section up into the inherit directive section. Updated the example at the end of the INHERIT Configuration Directive section to apply to INHERIT. Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
2017-09-13bitbake-user-manual: Clarified inherit, include, require relationshipsScott Rifenbark
Fixes [YOCTO #12032] I applied some re-writing to help clarify the relationships between the inherit, include, and require directives. Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
2017-06-09bitbake-user-manual-metadata.xml: fix a typoMing Liu
'buildCompleted' should be 'BuildCompleted'. Signed-off-by: Ming Liu <peter.x.liu@external.atlascopco.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-05-21bitbake-user-manual: Updated INHERIT descriptionsScott Rifenbark
Fixes [YOCTO #11498] Enhanced the glossary description for the INHERIT variable to give more detail and to cross-reference the reader back into the Chapter 3 section describing its use. Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-01-23bitbake-user-manual: Fixed small typo in "Events" sectionScott Rifenbark
There was a stra quote character after the word database and I removed it. Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-01-23bitbake-user-manual: Updated Event descriptionsScott Rifenbark
Fixes [YOCTO #10886] Added text descriptions for many of the events in the list of the "Events" section. Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-12-08bitbake-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. Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
2016-11-30bitbake: 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\) Signed-off-by: Joshua Lock <joshua.g.lock@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-10-13bitbake-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. Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
2016-10-13bitbake-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. Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
2016-10-13bitbake-user-manual: Updated the [noexec] and [nostamp] flag descriptionsScott Rifenbark
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. Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
2016-10-13bitbake-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. Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
2016-10-13bitbake-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. Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
2016-10-06bitbake-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. Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-10-06bitbake-user-manual: Updated minor wordings.Scott Rifenbark
Fixes [YOCTO #10296] Applied some minor wording changes per review edits. Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-10-06bitbake-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. Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-10-06bitbake-user-manual: Fixed grammar from missing wordScott Rifenbark
Fixes [YOCTO #10293] I omitted the work "quote" and needed to have it there. Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-09-21bitbake-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. Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-09-21bitbake-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. Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-09-02bitbake-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. Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
2016-08-17ast/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 Signed-off-by: Jérémy Rosen <jeremy.rosen@openwide.fr> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-08-17bitbake-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. Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-08-17bitbake-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. Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-08-17bitbake-user-manual: Added more detail to anonymous Python functions.Scott Rifenbark
Fixes [YOCTO #10093] Provided much more detail on how these functions work. Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-08-17bitbake-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. Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-08-17bitbake-user-manual: Added detail to [dirs] and [cleardirs] flagsScott Rifenbark
Fixes [YOCTO #10071] Provided more clear descriptions for these two flags. Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-08-02bitbake-user-manual: Applied typo fix to "Override Style Operation Advantages"Scott Rifenbark
Fixes [YOCTO #9985] Fixed an operator typo from ":=" to "+=" in the note at the bottom of the section. Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
2016-08-02bitbake-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. Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
2016-08-02bitbake-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. Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
2016-08-02bitbake-user-manual: Updated the "Inline Python Variable Expansion" section.Scott Rifenbark
Fixes [YOCTO #9984] Added a small note to the bottom to help clarify. Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
2016-08-02bitbake-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. Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
2016-08-02bitbake-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. Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
2016-08-02bitbake-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. Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
2016-07-21bitbake-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] Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
2016-07-21bitbake-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] Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
2016-07-21bitbake-user-manual: Added a note providing examples of task dependenciesScott Rifenbark
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. Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
2016-07-21bitbake-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. Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
2016-07-21bitbake-user-manual: Updated the defaults for getVar and getVarFlagScott Rifenbark
There is no default. Fixes [YOCTO #9683] Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
2016-04-18bitbake-user-manual: Updated "Conditional Metadata" sectionScott Rifenbark
Added information about using lower-case characters and no underscore characters when using OVERRIDES. Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-04-14bitbake-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. Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-23bitbake-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] Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
2016-03-23bitbake-user-manual: Updated the "inherit Directive" section.Scott Rifenbark
Fixes [YOCTO #9283] Updated the description to document conditional inherits. Provided several examples. Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
2016-03-03bitbake-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. Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
2016-03-03bitbake-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. Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
2016-03-03bitbake-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. Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
2016-01-29bitbake-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. Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-06-19bitbake: 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 *` Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-05-22bitbake-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. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>