aboutsummaryrefslogtreecommitdiffstats
path: root/doc/bitbake-user-manual/bitbake-user-manual-metadata.xml
Commit message (Collapse)AuthorAgeFilesLines
* bitbake-user-manual: Added section on modifying variablesScott Rifenbark2019-04-231-0/+72
| | | | | | | | | | | Fixes [YOCTO #12548] I created a new section titled "Modifying Variable Values" that provides instruction on how to use the "bitbake -e" command to be sure your configuration and variable values are as expected. Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake-user-manual: Fixed section head typoScott Rifenbark2019-02-121-1/+1
| | | | | | | Unseting -> Unsetting Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake-user-manual: Created unique tags for glossary variables.Scott Rifenbark2018-12-271-39/+39
| | | | | | | | | | | | | | | | | | | | | | | | | | | Fixes [YOCTO #12399] The bug was to get the BitBake User Manual into the YP Mega-manual. All the changes here create unique tags used with variables in the BitBake Manual. Prior to the fix, tags were identical between like variables in the YP reference manual and the BitBake User Manual. The reason for this is because when I created the BitBake manual's glossary, it was a cut-and-paste operation to get the bulk of the work started. At the time, the BitBake User Manual was not a part of the Mega-manual. Once we decided to include the BitBake User Manual as part of the Mega-Manual, building the mega-manual produced warnings for all these duplicate links. To fix, I have updated the variable tags in the BitBake User Manual to use the following form: 'var-bb-<variable_name>' The tags used in the YP ref-manual follow this form (original): 'var-<variable_name>' Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake-user-manual: Added hard-spacing to "_remove" example.Scott Rifenbark2018-10-311-2/+3
| | | | | | | | | | Rendering the manual to its HTML form was collapsing the two leading and four trailing whitespace characters into single whitespace characters. I inserted multiple "&nbsp;" strings to force the spacing to come through. Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake-user-manual: Updates to variable wildcard support.1.40.0Scott Rifenbark2018-10-291-11/+12
| | | | | | | | | | | Fixes [YOCTO #12390] Applied some fixes to the variable wildcard support documentation in the BitBake manual. Wording changes and changes to make links referencing Python syntax go to version 3 rather than version 2. Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake-user-manual: Added wildcarding descriptionsScott Rifenbark2018-10-291-0/+25
| | | | | | | | | | Fixes [YOCTO #12390] Added specific descriptions for how wildcarding works for a variety of variables and files (e.g. append files). Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* data: Fix whitespace on _remove operationsRichard Purdie2018-10-161-3/+3
| | | | | | | | | | | | | | | | | | We have some slightly odd behaviours with the current implementation of _remove operations. For example: TEST = " A B" TEST_remove = "C" would trigger TEST to become "A B" even thought it doesn't contain "C". In particular, this means that an inactive remove operator added in a bbappend could change the task checksum which is not desireable. Fix the operation to preserve whitespace, adding new tests to make this explict and test further corner cases. Also update the manual to match. Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake-user-manual: Added "number_threads" varflagScott Rifenbark2018-06-191-0/+32
| | | | | | | | | | You can now limit on a task-specific basis the number of threads a task will use. This is useful for machines that have high numbers of cores and need to be rate-limited due to various resource constraints. Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake-user-manual: Updated "Task Checksums and Setscene" sectionScott Rifenbark2018-04-121-28/+46
| | | | | | | | | | | | | | | Fixes [#YOCTO 12030] Updated the "Task Checksums and Setscene" section to provide a bit of user information around the bitbake-dumpsigs use that lets a user examine signatures and inputs that determine if a do_compile task is indeed supposed to be run. Added more explanation of how a user can examine signatures used to determine if a do_compile task is indeed supposed to be run. Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake-user-manual: Commented out Placeholder ParagraphKristi Rifenbark2018-02-061-2/+7
| | | | | | | Fixes [YOCTO #12030] Signed-off-by: Kristi Rifenbark <kristi@buzzcollectivemarketing.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake-user-manual: Updated "Events" for BuildStarted eventScott Rifenbark2018-01-161-0/+2
| | | | | | | | | | BitBake now fires off one "BuildStarted" event per configuration when it is configured for multiple configurations (multiconfig). I updated the bullet item for "bb.envent.BuildStarted()" to indicate that behavior. Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake-user-manual-metadata: include a space on a append exampleLeonardo Sandoval2017-10-071-1/+1
| | | | | | | | 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>
* bitbake-user-manual: Edits to "inherit" section.Scott Rifenbark2017-09-131-3/+3
| | | | | | | | Fixes [YOCTO #12031] Applied minor wording changes based on review feedback. Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
* bitbake-user-manual: Updated inherit and INHERIT sectionsScott Rifenbark2017-09-131-5/+13
| | | | | | | | | | | | | 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>
* bitbake-user-manual: Clarified inherit, include, require relationshipsScott Rifenbark2017-09-131-7/+34
| | | | | | | | | 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>
* bitbake-user-manual-metadata.xml: fix a typoMing Liu2017-06-091-1/+1
| | | | | | | 'buildCompleted' should be 'BuildCompleted'. Signed-off-by: Ming Liu <peter.x.liu@external.atlascopco.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake-user-manual: Updated INHERIT descriptionsScott Rifenbark2017-05-211-1/+2
| | | | | | | | | | | 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>
* bitbake-user-manual: Fixed small typo in "Events" sectionScott Rifenbark2017-01-231-1/+1
| | | | | | | | 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>
* bitbake-user-manual: Updated Event descriptionsScott Rifenbark2017-01-231-61/+127
| | | | | | | | | | 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>
* bitbake-user-manual: Added new "Line Joining" section.Scott Rifenbark2016-12-081-0/+42
| | | | | | | | | | 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>
* bitbake: remove True option to getVar callsJoshua Lock2016-11-301-4/+4
| | | | | | | | | | 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>
* bitbake-user-manual: Changed BB_SETSCENE_VERIFY_FUNCTION nameScott Rifenbark2016-10-131-1/+1
| | | | | | | | 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>
* bitbake-user-manual: Fixes small typos for 'addtask' sectionScott Rifenbark2016-10-131-3/+3
| | | | | | | | | 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>
* bitbake-user-manual: Updated the [noexec] and [nostamp] flag descriptionsScott Rifenbark2016-10-131-4/+13
| | | | | | | | | | | 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>
* bitbake-user-manual: Fleshed out the "addtask" documentationScott Rifenbark2016-10-131-33/+91
| | | | | | | | | 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>
* bitbake-user-manual: Updated the datastore functionsScott Rifenbark2016-10-131-12/+32
| | | | | | | | | 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>
* bitbake-user-manual: Added new section on BB-style functionsScott Rifenbark2016-10-061-3/+96
| | | | | | | | | | | | | | | 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>
* bitbake-user-manual: Updated minor wordings.Scott Rifenbark2016-10-061-4/+4
| | | | | | | | | 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>
* bitbake-user-manual: Added examples for using overrides with functions.Scott Rifenbark2016-10-061-13/+104
| | | | | | | | | | | | | | | 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>
* bitbake-user-manual: Fixed grammar from missing wordScott Rifenbark2016-10-061-1/+1
| | | | | | | | | 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>
* bitbake-user-manual: Added information for using single quotesScott Rifenbark2016-09-211-0/+15
| | | | | | | | | | | | 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>
* bitbake-user-manual: New section on functions you can call from PythonScott Rifenbark2016-09-211-92/+120
| | | | | | | | | | | | | | 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>
* bitbake-user-manual: Added "Exporting Variables to the Environment"Scott Rifenbark2016-09-021-0/+47
| | | | | | | | | | 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>
* ast/ConfHandler: Add a syntax to clear variableJérémy Rosen2016-08-171-0/+17
| | | | | | | | | | 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>
* bitbake-user-manual: Re-write "Dependencies Internal to the .bb File"Scott Rifenbark2016-08-171-25/+29
| | | | | | | | | 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>
* bitbake-user-manual: Added setting variable for a single taskScott Rifenbark2016-08-171-0/+28
| | | | | | | | | | 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>
* bitbake-user-manual: Added more detail to anonymous Python functions.Scott Rifenbark2016-08-171-17/+70
| | | | | | | | | 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>
* bitbake-user-manual: Formatted all "flags" to be consistentScott Rifenbark2016-08-171-29/+34
| | | | | | | | | | | 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>
* bitbake-user-manual: Added detail to [dirs] and [cleardirs] flagsScott Rifenbark2016-08-171-3/+7
| | | | | | | | | 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>
* bitbake-user-manual: Applied typo fix to "Override Style Operation Advantages"Scott Rifenbark2016-08-021-1/+1
| | | | | | | | | 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>
* bitbake-user-manual: Added non-existant variable expansionScott Rifenbark2016-08-021-0/+11
| | | | | | | | | 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>
* bitbake-user-manual: Applied some review commentsScott Rifenbark2016-08-021-3/+4
| | | | | | | | | 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>
* bitbake-user-manual: Updated the "Inline Python Variable Expansion" section.Scott Rifenbark2016-08-021-1/+16
| | | | | | | | Fixes [YOCTO #9984] Added a small note to the bottom to help clarify. Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
* bitbake-user-manual: Fixed override operator syntax.Scott Rifenbark2016-08-021-6/+4
| | | | | | | | 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>
* bitbake-user-manual: Clarified override-style operators.Scott Rifenbark2016-08-021-2/+56
| | | | | | | | | | | | | | | | | | 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>
* bitbake-user-manual: Updated the variable expansion section.Scott Rifenbark2016-08-021-12/+31
| | | | | | | | | Fixes [YOCTO #9984] Added more detail to the examples that show the effects of variable expanison. Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
* bitbake-user-manual: Applied review edits to "Recursive Dependencies"Scott Rifenbark2016-07-211-1/+2
| | | | | | | | | 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>
* bitbake-user-manual: Added review changes to recursive section.Scott Rifenbark2016-07-211-1/+14
| | | | | | | | | | 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>
* bitbake-user-manual: Added a note providing examples of task dependenciesScott Rifenbark2016-07-211-0/+34
| | | | | | | | | | 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>
* bitbake-user-manual: Updated dependency section for tasksScott Rifenbark2016-07-211-9/+26
| | | | | | | | | | 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>