summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual/ref-variables.xml
Commit message (Collapse)AuthorAgeFilesLines
* ref-manual: Added information for OEROOT and build environmentScott Rifenbark2013-09-121-14/+39
| | | | | | | | | | | | | | | | | | | Fixes [YOCTO #4980] Added a new glossary entry for OEROOT. Added significant information to the local.conf and bblayers.conf reference sections to describe how the root build directory is derived. Also, some unrelated formatting to the DL_DIR variable description was mixed in here because I forgot to commit that separatey and it lives in the same variables.xml file. (From yocto-docs rev: c397a31f5b0d3f6257657119a4e81b4fbdc3800c) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual, ref-manual: replaced "atom-pc" with "genericx86"Darren Hart2013-09-121-1/+1
| | | | | | | | | | Update the manuals to reflect the recent replacement of atom-pc with genericx86. (From yocto-docs rev: 8f77006d74b77000f56b64581cb5f6474f53a4f1) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Re-ordered some P* variables in the glossary.Scott Rifenbark2013-09-121-52/+52
| | | | | | | | | Some things were not in alphabetical order. (From yocto-docs rev: e7d96d5eecaa74d680a4495a21f86a7776852c48) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Added the memory-resident BitBake featureScott Rifenbark2013-09-121-4/+29
| | | | | | | | | | | | | | | | | | | | | | | | The main changes are captured in a new section devoted to the oe-init-build-env-memres script within the ref-structure.xml file and in the variables.xml file in a BBSERVER variable entry in the glossary. All other changes were necessary to integrate the new functionality into areas where running the setup script are discussed. Before this feature, there was a single setup script (oe-init-build-env). Consequently, wordings and such were designed exclusively for this single method. With the introduction of a second possible method to initialize the build environment, tweaks to many sections were needed. Beside the wording tweaks, appropriate cross-referencing was also needed. All these changes cover the integration of the new feature. Reported-by: Richard Purdie <richard.purdie@linuxfoundation.org> (From yocto-docs rev: c55c9a53c9b4cd1e06e6e81e32d56f9bbf5fe98c) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Re-ordered some B* variables to be in alphabetical order.Scott Rifenbark2013-09-121-75/+75
| | | | | | | (From yocto-docs rev: 75e170bb84d263a514e79c02c8628ef44290a5b2) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: edits to BAD_ and NO_RECOMMENDATIONSScott Rifenbark2013-09-121-16/+10
| | | | | | | | | Some review edits based on Paul's review. (From yocto-docs rev: d6ff6399cb02b045a7a35a2c87d5f62a25612c3b) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Variable adds and edits for package exclusion changesScott Rifenbark2013-09-121-20/+179
| | | | | | | | | | | | | Fixes [YOCTO #4079] I have added variable descriptions for NO_RECOMMENDATIONS and PACKAGE_EXCLUDE. I updated the BAD_RECOMMENDATIONS and the RRECOMMENDS variables. (From yocto-docs rev: 3b5b44d3db9e723cd9836ddbd4177c2ab2e1d663) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated DEPENDS and RDEPENDS variable descriptions.Scott Rifenbark2013-09-121-5/+56
| | | | | | | | | | | I have added more information to both these variables to help explain their use better. Based on email from Paul Eggleton. Each entry now features a simple example. (From yocto-docs rev: 1ec67c639f15259ac67d5591d1d7a23522b0a822) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated the PE variable description.Scott Rifenbark2013-09-121-3/+4
| | | | | | | | | | I changed the description to note that the PE variable is unset by default. (From yocto-docs rev: fe3655121e2796e50b8b3372df06cdf8341a2202) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: New variables descriptions for PKGDATA_DIR and PKGDESTWORKScott Rifenbark2013-08-301-0/+36
| | | | | | | (From yocto-docs rev: a5c3663f6fa6e8f98a7626b99b5ad9ca2058670b) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Fixed syntax in the S variable.Scott Rifenbark2013-08-261-1/+1
| | | | | | | (From yocto-docs rev: 00fc96c2b5a03e4a32972b5f295fb70411a4e08f) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual, adt-manual: Minor edits from review.Scott Rifenbark2013-08-261-5/+7
| | | | | | | | | | | | | | | | | Fixed some wordings in the ADT manual to remove "Intel-based" so as not to be biased. Added "x86" to qualify the types of systems in the toolchain examples. Added minor wording to the IMAGE_TYPES variable. Changed some wording for the IPK_FEED_URIS varilable. (From yocto-docs rev: 1fa7e0000591bec7e3d0b682df02b95dbee3d4f1) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: minor edit to the PKGDEST variable.Scott Rifenbark2013-08-261-1/+1
| | | | | | | (From yocto-docs rev: 027b73857c76dd34b1559eda9705531d531c806b) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updates to insane.bbclass and two new variables added.Scott Rifenbark2013-08-131-1/+31
| | | | | | | | | | | | | * Updated the insane.bbclass section to move the note at the end about using ERROR_QA and WARN_QA to control how the checks are reported to the front of the section. * Added new variable entries for WARN_QA and ERROR_QA. (From yocto-docs rev: 6f220d1ba3d44a1bba2f1ac882cdf6b601ddc5bb) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Review comments added, new variables addedScott Rifenbark2013-08-131-1/+74
| | | | | | | | | | | | | | | | | | * Updated some links in the insane.bbclass sectioni so they now point to some new variables. * Added glossary descriptions for PKGD, PKGDEST, and INCOMPATIBLE_LICENSE. * Added a paragraph to the LICENSE variable to describe situations where the output might have components whose licensing is from two different licenses (licensing on a per-package basis). (From yocto-docs rev: b8dd3b3d5cb912ed7c5d3c9b6c01d93347e95b84) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added more QA checks to the insane.bbclass.Scott Rifenbark2013-08-131-1/+1
| | | | | | | | | | | | | | Fixes [YOCTO #4788] Added a bunch of new checks to the list of checks in this class. I also recast the section head to just have the class file as the section heading. This resulted in a link that needed changed. (From yocto-docs rev: 4a4df80c0b6012ad09ea526d2893e729aa06965b) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Review comments to a few variables.Scott Rifenbark2013-08-131-5/+3
| | | | | | | | | | Applied some minor review comments from Paul for some variables in the reference. (From yocto-docs rev: 231031c291367f3b8f6b1f44d4a0b1804d8e9d9f) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: updated the IPK_FEED_URIS variable.Scott Rifenbark2013-08-131-1/+1
| | | | | | | | | | | | | | When I added this variable, I cut-and-pasted from the INSANE_SKIP variable, which appears directly in front of this new variable. I failed to change the name of the variable from the copied INSANE_SKIP to IPK_FEED_URIS. Fixed. (From yocto-docs rev: 3138ba59d90dbdd11be524598c3996a6824bc424) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Edits to the IMAGE_TYPES variable.Scott Rifenbark2013-08-131-2/+2
| | | | | | | (From yocto-docs rev: 973bae5361ca3205c467cc7445cf83462f422edb) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Edits to IMAGE_FSTYPES and IMAGE_TYPES variables.Scott Rifenbark2013-08-131-33/+4
| | | | | | | (From yocto-docs rev: f852fff164e926f3b821c59f293904125cbb17bd) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added IMAGE_TYPES variable and updated IMAGE_FSTYPES.Scott Rifenbark2013-08-131-1/+77
| | | | | | | (From yocto-docs rev: f360973500b92a93311ac5e62b09aee9a4bdeebb) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: updates to TARGET_ARCH and KARCH variables.Scott Rifenbark2013-08-131-8/+13
| | | | | | | (From yocto-docs rev: c466ca5b8e9c4fb1824b3cb1bd9d53a300696a2d) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added new variable IPK_FEED_URIS.Scott Rifenbark2013-08-131-1/+15
| | | | | | | (From yocto-docs rev: 94039032274b17e383be026976736b662e877ee0) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added BINCONFIG_GLOB variable and updated binconfig.bbclassScott Rifenbark2013-08-131-0/+23
| | | | | | | | | | | | New variable. Changed the class section to have a reference-like section title. Added a link back to the GLOB variable. (From yocto-docs rev: 42dbafc1b64d8572930501f25a0470038721524f) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Applied review edits to several variable descriptions.Scott Rifenbark2013-08-131-13/+13
| | | | | | | | | Minor changes to a whole lotta variables. (From yocto-docs rev: a2a175a5138683a9e9deac71b6080cc05cbb801e) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Edits and additions to glossaryScott Rifenbark2013-08-131-20/+302
| | | | | | | | | | | | | | | | | | | | | | | | Some items updated and several new variables added: * Review edits to SERIAL_CONSOLE * Added TRANSLATED_TARGET_ARCH * Added SOLIBSDEV * Added SOLIBS * Added OLDEST_KERNEL * Added INTERCEPT_DIR * Added ALTERNATIVE * Added ALTERNATIVE_LINK_NAME * Added ALTERNATIVE_PRIORITY * Added ALTERNATIVE_TARGET * Added COMMON_LICENSE_DIR * Added EXCLUDE_FROM_WORLD * Added INITRAMFS_FSTYPES * Removed commented out BUILDHISTORY_CHECKVERBACKWARDS variable. (From yocto-docs rev: 9c18046e39b3b98e2e788b5c5d05096a3d95add8) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual, dev-manual: Review edits for Build Directory wording.Scott Rifenbark2013-08-131-14/+15
| | | | | | | | | | | | | | | Did some word-smithing to work around a false statement that implied externalsrc.bbclass needed to be inherited on a recipe-by-recipe basis. This affected the usage section and the glossary definitions for both EXTERNALSRC and EXTERNALSRC_BUILD. Also updated the "B" variable description to be more accurate in the use of the term "Build Directory." (From yocto-docs rev: 46695817b6e44cfa88161699105b8d03a5828fd2) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Edits to OE_BINCONFIG_EXTRA_MANGLE and binconfig.bbclassScott Rifenbark2013-08-131-3/+5
| | | | | | | (From yocto-docs rev: d732e0a32d1bc5dccd9bf6522bb9852df3b63ebd) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added glossary entry for INHIBIT_DEFAULT_DEPS variable.Scott Rifenbark2013-08-131-1/+16
| | | | | | | (From yocto-docs rev: d33370a1a1448a339a32f91c171193c7f4d9397e) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added glossary entry for SERIAL_CONSOLES variable.Scott Rifenbark2013-08-131-5/+20
| | | | | | | | | | Also, I changed the definition for SERIAL_CONSOLE to indicate the variable is deprecated. (From yocto-docs rev: 36c78759b406853ab36f815d741689d5719d1e0f) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added glossary entry for SERIAL_CONSOLES_CHECK variable.Scott Rifenbark2013-08-131-0/+13
| | | | | | | (From yocto-docs rev: d4e685033794c504220e30ba92adb7c7da64b753) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added a glossary entry for the EXTENDPKGV variable.Scott Rifenbark2013-08-131-0/+21
| | | | | | | (From yocto-docs rev: 87ccd9f922db081c8848bc543b96859600b1a86b) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added new glossary entry for PACKAGE_INSTALL variable.Scott Rifenbark2013-08-131-0/+21
| | | | | | | (From yocto-docs rev: 15411b77931a039d374c770d71e975aaf34b22c4) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added new glossary entry for the PATCHTOOL variable.Scott Rifenbark2013-08-131-0/+21
| | | | | | | (From yocto-docs rev: fa3e46c5a4debada71cbc9899dca506093d2a8c8) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added placeholder for BUILDHISTORY_CHECKVERBACKWARDSScott Rifenbark2013-08-131-0/+14
| | | | | | | | | Inserted a commented placehoder for this glossary item. (From yocto-docs rev: 6c621cd8eddfdd592df299255035288dd5d15477) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: New variable entries added.Scott Rifenbark2013-08-131-0/+53
| | | | | | | | | | | | | | | | * EXTERNALSRC * EXTERNALSRC_BUILD These are new. Also fixed a link to the dev-manual that points to the section on how to use external.bbclass. The section name was changed so that it does not imply how to use the class. (From yocto-docs rev: be9b801cac6a8fd6cd3db86eacf432f73da6fd08) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updates to the S variable description in the glossary.Scott Rifenbark2013-08-131-11/+14
| | | | | | | (From yocto-docs rev: 44a2b16f77cb86e37f3dcd46c52f699a59e3b418) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added glossary description for OE_BINCONFIG_EXTRA_MANGLE variable.Scott Rifenbark2013-08-131-1/+28
| | | | | | | (From yocto-docs rev: 55bbcbebc707d95ee357aa3d8075218d0f31b2f1) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added new glossary description for RM_OLD_IMAGE.Scott Rifenbark2013-08-131-0/+18
| | | | | | | (From yocto-docs rev: 718002e23dbea4f8c2090003ee43af30fa0ae82d) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Edits to the TOPDIR glossary entry.Scott Rifenbark2013-08-131-2/+1
| | | | | | | (From yocto-docs rev: bb29b4a4a8e5c4be6fc2a4103e1a32df184a2f76) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Small corrections to the TOPDIR variable description.Scott Rifenbark2013-08-131-3/+3
| | | | | | | (From yocto-docs rev: 74e5b386f08169a3381b758e2759caac9d94dd47) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Review comments for closer look at YP dev sectionScott Rifenbark2013-08-131-5/+6
| | | | | | | | | | | | Fixes [YOCTO #2808] Applied minor wording changes as directed by Paul Eggleton's review of the sections and related variable descriptions. (From yocto-docs rev: cf30c3dd78d5e55356bb73f43f10e0093a9aa084) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: New COREBASE variable entry added to glossary.Scott Rifenbark2013-08-131-0/+22
| | | | | | | | | Fixes [YOCTO #4981] (From yocto-docs rev: a3623887a3cfd3df47a09b8fd337a2741b5aaa42) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated the TMPDIR description in the glossary.Scott Rifenbark2013-08-131-6/+8
| | | | | | | (From yocto-docs rev: 854c29e5b09024355eee2284f8ed86a861474811) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual, mega-manual, Makefile: Updates to expanded dev sectionScott Rifenbark2013-08-131-13/+16
| | | | | | | | | | | | | | | | | | | | | Fixes [YOCTO #2808] Applied review comments to the "Images" and SDK sections that are part of the "A Closer Look at the Yocto Project Development Environment" section. Comments from Paul. They resulted in a single figure being removed and split into two new figures - one for the image part and one for the sdk part. Some terminology issues were cleaned up in the main sections as well as the documented variables sections. Makefile changes involved adding the two new figures and removing the old combined one. (From yocto-docs rev: a32908fa68b9786e295097c16f70a5a9c3cc4c1e) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: New variables added to the glossary.Scott Rifenbark2013-08-131-0/+49
| | | | | | | | | | Added entries for DEPLOY_DIR, TOOLCHAIN_HOSTS_TASKS, and TOOLCHAIN_TARGET_TASKS. (From yocto-docs rev: b239c41871f8c833cd33f4c5c875d51fa1bdf9eb) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: New glossary entry for DEPLOY_DIR.Scott Rifenbark2013-08-131-0/+24
| | | | | | | (From yocto-docs rev: f1594bfbc795dd9c22545b4d01601fbc88c91610) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: New entry for OE_IMPORTS variable added to glossary.Scott Rifenbark2013-08-131-1/+16
| | | | | | | (From yocto-docs rev: 3b73c2e1418190b1d998f3f7cf425088df887c21) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added SDKMACHINE variable description.Scott Rifenbark2013-08-131-0/+27
| | | | | | | (From yocto-docs rev: f1e3e52257c296cfeb70fea63bf5ea7b142774dc) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: fixed caps problem with the word "numberS"Scott Rifenbark2013-06-141-1/+1
| | | | | | | (From yocto-docs rev: 079abc1c0eac1b58f8b4947f1addb1161a4bb53d) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>