summaryrefslogtreecommitdiffstats
path: root/bitbake/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.xml
Commit message (Collapse)AuthorAgeFilesLines
* bitbake: bitbake-user-manual: Created unique tags for glossary variables.Scott Rifenbark2018-12-271-211/+211
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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>' (Bitbake rev: fb6de2057aae3fbdf37f007d2e47794b332020e1) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: bitbake-user-manual: Updates to variable wildcard support.Scott Rifenbark2018-10-291-5/+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. (Bitbake rev: 0cfc71d1a342b82781b0ba547421e41f6340902a) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: bitbake-user-manual: Added wildcarding descriptionsScott Rifenbark2018-10-291-7/+43
| | | | | | | | | | | | Fixes [YOCTO #12390] Added specific descriptions for how wildcarding works for a variety of variables and files (e.g. append files). (Bitbake rev: 0a4377cb1837ede213d9640344f4908de3689d91) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: bitbake-user-manual: fix description of BB_RUNTASKChris Laplante via bitbake-devel2018-10-181-2/+2
| | | | | | | | | | Contrary to what the manual said, BB_RUNTASK does include the do_ prefix, unlike BB_CURRENTTASK. (Bitbake rev: 3f4968c77129252e8d0833fbd683372fca243a90) Signed-off-by: Chris Laplante <chris.laplante@agilent.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: bitbake-user-manual: Added BBMULTICONFIG supportScott Rifenbark2018-10-041-0/+39
| | | | | | | | | | | | 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. (Bitbake rev: 836f994ec530ba82c935cb41e006d1f128885dc2) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: bitbake-user-manual: Updated "OpenEmbedded-Core" term.Scott Rifenbark2018-04-121-3/+3
| | | | | | | | | | Made sure that the terms "OpenEmbedded-Core" and "OE-Core" are used as such throughout the manual. (Bitbake rev: 677e58f8616a4bf58772e54d2313af3885a3b110) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: bitbake-user-manual: Added google-repo fetcher and REPODIR var.Nicolas Cornu2018-02-141-0/+10
| | | | | | | | | | | | | | 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. (Bitbake rev: 1cf084cee506574b7bb6ed03344597b3b2f2fe08) 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>
* bitbake: bitbake-user-manual: Updated kernel version in PREFERRED_VERSION ↵Scott Rifenbark2017-09-261-1/+1
| | | | | | | | | example (Bitbake rev: 41ba3c8bfcd3501604f6a17bd327a8193b11b656) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: bitbake-user-manual: Updated BBLAYERS_FETCH_DIR variable descriptionScott Rifenbark2017-06-151-2/+0
| | | | | | | | | | | | | 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. (Bitbake rev: 7b4e81772ed8789521661a3b32b576c91276ae34) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: bitbake-user-manual: Updated INHERIT descriptionsScott Rifenbark2017-05-231-3/+13
| | | | | | | | | | | | | 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. (Bitbake rev: 362f6044fcaafe51ab4377af8f2606165b112717) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: fetch/local: Drop FILESDIRRichard Purdie2017-04-051-18/+0
| | | | | | | | | | 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>
* bitbake: 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. (Bitbake rev: 41d9cd41d40b04746c82b4a940dca47df02514fc) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: bitbake-user-manual: Updated the PROVIDES variableScott Rifenbark2016-08-021-0/+21
| | | | | | | | | | | | 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>
* bitbake: bitbake-user-manual: Fixed typo in the BBDEBUG variable description.Scott Rifenbark2016-07-211-1/+1
| | | | | | | | | | | | 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>
* bitbake: bitbake-user-manual: Added review changes to BBCLASSEXTEND descriptionScott Rifenbark2016-07-211-7/+9
| | | | | | | | | | | | | 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>
* bitbake: bitbake-user-manual: Addeds support for the Perforce FetcherAndrew Bradford2016-07-211-1/+10
| | | | | | | | | | | | | 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>
* bitbake: bitbake-user-manual: Added clarifying note to BBCLASSEXTEND variable.Scott Rifenbark2016-07-211-0/+21
| | | | | | | | | | | | 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>
* bitbake: Provide LAYERDIR_RE for layer.confChristopher Larson2016-05-191-0/+11
| | | | | | | | | | | | | 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>
* bitbake: bitbake-user-manual-ref-variables: Update the help for BBMASKPeter Kjellerstedt2016-01-291-11/+9
| | | | | | | | | | | 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>
* bitbake: bitbake-user-manual: Added new description for BB_TASK_IONICE_LEVELScott Rifenbark2015-10-291-0/+50
| | | | | | | | | 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>
* bitbake: bitbake-user-manual: Added BBTARGETS variable description.Scott Rifenbark2015-10-291-0/+9
| | | | | | | (Bitbake rev: 0f0c205b9d6c24bee334eabb359973e0368ce931) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: bitbake-user-manual-ref-variables: Added BBLAYERS_FETCH_DIR ↵Trevor Woerner2015-06-231-0/+14
| | | | | | | | | | | 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>
* bitbake: bitbake-user-manual-ref-variables.xml: Added BB_ALLOWED_NETWORKS desc.Scott Rifenbark2015-06-161-0/+50
| | | | | | | | | | 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>
* bitbake: bitbake-user-manual: Cleaned up parallelism note and formatted user ↵Scott Rifenbark2015-04-171-6/+6
| | | | | | | | | | | | | | | | 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>
* bitbake: bitbake-user-manual: Added five new repo variables and links.Scott Rifenbark2015-02-101-4/+50
| | | | | | | | | | | | | | | | | | 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. (Bitbake rev: 5b797c758bf0499646e4e0256f03fbbdfb3ea080) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: bitbake-user-manual-ref-variables.xml: Edits to OVERRIDES variable.Scott Rifenbark2014-07-031-2/+10
| | | | | | | | | More detail. (Bitbake rev: 0ac8a504de1798dae02eb2dade2776e7e25d034d) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: bitbake-user-manual-ref-variables.xml: Edits to PROVIDES variable.Scott Rifenbark2014-07-031-10/+22
| | | | | | | | | Added some more detail to help describe the variable. (Bitbake rev: 4b2019e67324f0f86e1a49d256eddb4f9ca597f4) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: bitbake-user-manual-ref-variables.xml: Edits to the BBPATH variable.Scott Rifenbark2014-04-211-11/+12
| | | | | | | | | | I took the stuff about running bitbake outside the build directory and removed the note syntax. (Bitbake rev: 783f29a593ce16a37b275b02f71b3ec918ef8c91) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: bitbake-user-manual-ref-variables.xml: Fixed BBPATH exampleScott Rifenbark2014-04-211-1/+1
| | | | | | | | | | | The example used in the note in the BBPATH variable description had incorrect syntax. Spaces existed in the BBPATH = statement. I have removed them. (Bitbake rev: 896a1c102a4afda0e5d07d009bd7918044f88269) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: doc: Rename user-manual -> bitbake-user-manualRichard Purdie2014-04-211-0/+2131
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. (Bitbake rev: 452a62ae0c2793e281d6769fd3e45500a74898d6) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>