aboutsummaryrefslogtreecommitdiffstats
path: root/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.xml
AgeCommit message (Collapse)Author
2020-10-05sphinx: remove DocBook filesNicolas Dechesne
The BitBake documentation was migrated to Sphinx. Let's remove the deprecated DocBook files. Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
2020-06-23bitbake-user-manual: Add BBFILES_DYNAMICKonrad Weihmann
- add missing entry for BBFILES_DYNAMIC, ported from yocto-docs - add description for the new inverse mode Signed-off-by: Konrad Weihmann <kweihmann@outlook.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-03-12bitbake-user-manual: Add documentation for BB_LOGCONFIGJoshua Watt
Adds documentation describing how to use the BB_LOGCONFIG variable to enable custom logging. Signed-off-by: Joshua Watt <JPEWhacker@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-02-08doc: Standardize spelling on 'BitBake' throughout docsRobert P. J. Day
Since the proper spelling is, in fact, 'BitBake', might as well make it consistent throughout the user manual. Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-12-27bitbake-user-manual: Created unique tags for glossary variables.Scott Rifenbark
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>
2018-10-29bitbake-user-manual: Updates to variable wildcard support.yocto-2.62018-10-thud1.40.0Scott Rifenbark
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>
2018-10-29bitbake-user-manual: Added wildcarding descriptionsScott Rifenbark
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>
2018-10-17bitbake-user-manual: fix description of BB_RUNTASKChris Laplante via bitbake-devel
Contrary to what the manual said, BB_RUNTASK does include the do_ prefix, unlike BB_CURRENTTASK. Signed-off-by: Chris Laplante <chris.laplante@agilent.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-10-04bitbake-user-manual: Added BBMULTICONFIG supportScott Rifenbark
The BBMULTICONFIG variable is a variable used for BitBake and was not documented in the BitBake Manual glossary. I added the definition. I also added the variable to the example in the section describing how to execute builds for multiple configurations. Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
2018-04-12bitbake-user-manual: Updated "OpenEmbedded-Core" term.Scott Rifenbark
Made sure that the terms "OpenEmbedded-Core" and "OE-Core" are used as such throughout the manual. Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-02-09bitbake-user-manual: Added google-repo fetcher and REPODIR var.Nicolas Cornu
Added a new repo 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 REPODIR. Signed-off-by: Nicolas Cornu <nicolac76@yahoo.fr> Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-09-26bitbake-user-manual: Updated kernel version in PREFERRED_VERSION exampleScott Rifenbark
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-06-15bitbake-user-manual: Updated BBLAYERS_FETCH_DIR variable descriptionScott Rifenbark
Just discovered a minor issue in the bitbake manual - under the variable glossary entry for BBLAYERS_FETCH_DIR we say there's a default value of ${COREBASE} but that's not actually true in bitbake itself - there's no default in bitbake, that default is set in OE-Core. We can keep this in the YP ref manual but in the bitbake manual that sentence should be removed. Signed-off-by: Scott Rifenbark <srifenbark@gmail.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-04-05fetch/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. 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-08-02bitbake-user-manual: Updated the PROVIDES variableScott Rifenbark
Fixes [YOCTO #10011] Added paragraphs near the end to describe the role of virtual targets. Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
2016-07-21bitbake-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] Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
2016-07-21bitbake-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. Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
2016-07-21bitbake-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. Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
2016-07-21bitbake-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. Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
2016-05-18Provide 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] Signed-off-by: Christopher Larson <chris_larson@mentor.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-01-29bitbake-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. Signed-off-by: Peter Kjellerstedt <peter.kjellerstedt@axis.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-10-29bitbake-user-manual: Added new description for BB_TASK_IONICE_LEVELScott Rifenbark
Added a new variable description here for this variable. Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-10-29bitbake-user-manual: Added BBTARGETS variable description.Scott Rifenbark
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-06-19bitbake-user-manual-ref-variables: Added BBLAYERS_FETCH_DIR glossary item.Trevor Woerner
Add BBLAYERS_FETCH_DIR to the Variables Glossary. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-06-16bitbake-user-manual-ref-variables.xml: Added BB_ALLOWED_NETWORKS desc.Scott Rifenbark
Added a new variable description for the BB_ALLOWED_NETWORKS variable. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-04-17bitbake-user-manual: Cleaned up parallelism note and formatted user inputScott Rifenbark
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. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-02-10bitbake-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. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-06-27bitbake-user-manual-ref-variables.xml: Edits to OVERRIDES variable.Scott Rifenbark
More detail. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2014-06-26bitbake-user-manual-ref-variables.xml: Edits to PROVIDES variable.Scott Rifenbark
Added some more detail to help describe the variable. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2014-04-14bitbake-user-manual-ref-variables.xml: Edits to the BBPATH variable.Scott Rifenbark
I took the stuff about running bitbake outside the build directory and removed the note syntax. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2014-04-14bitbake-user-manual-ref-variables.xml: Fixed BBPATH exampleScott Rifenbark
The example used in the note in the BBPATH variable description had incorrect syntax. Spaces existed in the BBPATH = statement. I have removed them. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
2014-04-11doc: Rename user-manual -> bitbake-user-manualRichard Purdie
This manual gets combined with other manuals and in that context, it helps a lot if its seen as the Bitbake User Manual. Renames are a pain but this is worthwhile so that other docs can correctly be combined with this one. This also clarifies things like google search results which is helpful. Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>