summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual/ref-variables.xml
Commit message (Collapse)AuthorAgeFilesLines
* dev-manual, ref-manual: removed "distrodata" classScott Rifenbark2019-06-071-16/+10
| | | | | | | | | | | Ousted these since it was noted in the migration section that the class had been removed. Modified all references to the removed class as needed. (From yocto-docs rev: 7000acc76da6b7ee850b799347ab9083663c7e6a) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added "npm" information to the SRC_URI variable.Scott Rifenbark2019-05-151-0/+3
| | | | | | | (From yocto-docs rev: 644cf94333ef289e9d0719f46b76f712f4807573) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated PREFERRED_VERSION variable to use 5.0Scott Rifenbark2019-05-121-3/+3
| | | | | | | | | | I changed the PREFERRED_VERSION_linux-yocto example to use the 5.0 linux-yocto kernel rather than the 4.12 version. (From yocto-docs rev: 334554dd87f5372066d55246384ed5205aaf1f86) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Removed all references to EclipseScott Rifenbark2019-05-071-1/+1
| | | | | | | | | Links updated as needed. (From yocto-docs rev: acd5a75314b023f613be24b7512f991f8455e325) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated BB_GENERATE_MIRROR_TARBALLSScott Rifenbark2019-04-091-4/+12
| | | | | | | | | | | Updated the description to tell the user they can safely clean up the DL_DIR after creating tarballs of the source files from downloaded repos. (From yocto-docs rev: 6aff69632ea3102b6389ea510e1e3fa5bf1c2123) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Removed DISK_DESCRIPTION variable from glossaryScott Rifenbark2019-03-261-54/+0
| | | | | | | (From yocto-docs rev: 0bc99a673376e70279a353f654287068c59a0b03) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Fixed SRC_URI cut-and-paste error.Filip Jareš2019-03-191-1/+1
| | | | | | | | | | | | The update fixes a copy-paste-and-forget-to-update-everything error in the documentation of the `SRC_URI` entry in the Reference Manual. The `maxdate` paragraph just repeated what is there for the neighboring `mindate` paragraph which was incorrect. (From yocto-docs rev: bbeb096222d42a31adcb358a85f8fe6c4120416a) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added INIHIBIT_SYSROOT_STRIP variable desc.Scott Rifenbark2019-03-191-0/+38
| | | | | | | (From yocto-docs rev: 867c5affcecff77ec4b36f026baba80a6bf4fe62) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Removed DISTRO_FEATURES_LIBC variableScott Rifenbark2019-03-191-2/+4
| | | | | | | | | | | | Took this out of the glossary. After eglibc was merged into glibc, Kconfig support was also dropped so these libc features therefore are not effective anymore and can be removed. (From yocto-docs rev: cfdd02864f004fc48b0353ec0f007ca24b06d29e) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Typo found and fixed.Daniel Ammann2019-02-251-1/+1
| | | | | | | (From yocto-docs rev: 8a64478540dcaad5e79d5ef494f9086a3c8a50a1) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Review edits to FILESOVERRIDES variable.Scott Rifenbark2019-02-251-2/+5
| | | | | | | | | | | | | Fixes [YOCTO #13112] Added a reference in the FILESOVERRIDES variable description to the FILESPATH description to see an example of how automatic overrides work. (From yocto-docs rev: e78fc3468de3d9b9935f0e4f4aa4117b6805e631) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updates to FILESPATH and FILESOVERRIDES.Scott Rifenbark2019-02-161-26/+31
| | | | | | | | | | | | | | | Fixes [YOCTO #13112] Did some paragraph re-ordering based on reviewer feedback. Also, added a bit in the FILESOVERRIDES variable description about out it uses overrides to help with automatic overriding of the FILESPATH variable. Added some better links into the BitBake User Manual as well. (From yocto-docs rev: 6ad5c6f030501cda9bc8ea648d9d7c0e991f55cf) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Fixed literal formatting in INC_PR variable.Scott Rifenbark2019-02-121-4/+4
| | | | | | | | | No indentation was being used for the example. (From yocto-docs rev: e5d13181546d19772fede972b20518103d897eaa) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Update default value for PACKAGE_DEBUG_SPLIT_STYLEJoshua Watt2019-02-121-1/+1
| | | | | | | | | The new default is "debug-with-srcpkg" (From yocto-docs rev: b427e7c2d9f6efca7e0867cc8e508d4e941c5a09) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Update to SDK_VERSION variable.Peter Kjellerstedt2019-01-211-1/+1
| | | | | | | | | Updated the definition to match that of poky.conf. (From yocto-docs rev: 09c73c227c6949ed3f1287ce063aa96967ed2fda) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updates to FILESPATH and IMAGE_FSTYPES variables.Scott Rifenbark2019-01-161-26/+69
| | | | | | | | | | | | | | | | | | Fixes [YOCTO #13112] Fixes [YOCTO #13115] * FILESPATH: Added a detailed example of how to use the variable to set machine-specific configurations. Also, noted the default behavior of using FILESOVERRIDES to automatically extend FILESPATH. Did some rewriting as well. * IMAGE_FSTYPES: Updated the note to not be exclusive to "live" images. The behavior applies to many images. (From yocto-docs rev: 46e3f2545c45ba5391603f9ffa1c87896d472df6) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Document the fifth argument to PACKAGECONFIGPeter Kjellerstedt2018-12-151-4/+8
| | | | | | | (From yocto-docs rev: adb17e3172c829de77d2664c91f7cf4b22c9e5f0) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Add missing whitespace around "=" in a few code examples.Peter Kjellerstedt2018-12-151-6/+5
| | | | | | | (From yocto-docs rev: 0d22771c64d082bf86f5efd85ac9aaeb1c7f3093) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updates to CMake and cmake.bbclass.Scott Rifenbark2018-12-151-1/+6
| | | | | | | | | | | I cleaned up the terminology used for the CMake build system. I provided some meaningful links to a good overview page for CMake. I also built in some cross-referencing as needed. (From yocto-docs rev: 7c38add39b97a7a8786a1be53f9ff549e4727fad) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added KERNEL_ARTIFACT_NAME and adjusted referencing variables.Scott Rifenbark2018-11-221-59/+53
| | | | | | | | | | | | | | The KERNEL_ARTIFACT_NAME variable is used throughout to set the names of build artifacts. Rather than repeat informaiton about KERNEL_ARTIFACT_NAME in the many variables that use it, I added a new entry for the variable. This also impacted the descriptions of the variables that were repeating information. I updated those variable descriptions as well. (From yocto-docs rev: 5750d30be21e17fe21d89254925dc0e773c08e66) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Removed the NOISO and NOHDD variables.Scott Rifenbark2018-11-221-38/+0
| | | | | | | (From yocto-docs rev: bdb67279cd6707e5b0141ecfbfbc09101d508ef4) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added new artifact naming variables to glossary.Scott Rifenbark2018-11-221-37/+257
| | | | | | | (From yocto-docs rev: ed122fae8ec6e9eb38c196decfc6f5016945f4ee) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Changed "post 2.6" to correct wording.Scott Rifenbark2018-11-221-2/+3
| | | | | | | | | | | I changed the wording "post 2.6" to state "2.6 and forward". It was incorrect as the changes are inclusive of YP release 2.6. (From yocto-docs rev: fb3f3db17ea416cd829a291df3933cc3597392b8) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added KERNEL_IMAGE_NAME descriptionScott Rifenbark2018-11-221-3/+44
| | | | | | | | | | | | | | The KERNEL_IMAGE_NAME variable is new and is effectively a renamed KERNEL_IMAGE_BASE_NAME variable now. I provided a new glossary description for the new variable. I updated the existing KERNEL_IMAGE_BASE_NAME description to note it has changed. We can't just delete the old variable as there are migration notes for previous releases of YP. (From yocto-docs rev: e5a38711342f88ded4368521a70e9d117b6d991c) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added GCCVERSION variable description to glossary.Scott Rifenbark2018-11-221-0/+22
| | | | | | | (From yocto-docs rev: 8095f61c0bf0bbfc7fcf83e3f1c080913ed5f17d) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual, dev-manual: Removed TEST_IMAGE for TESTIMAGE_AUTO.Scott Rifenbark2018-11-221-35/+41
| | | | | | | | | | The TEST_IMAGE variable went away and was replaced with the TESTIMAGE_AUTO variable. Fixed all related/affected areas. (From yocto-docs rev: 660da40b4fcdc05666e1877037fa63eb1dfe7227) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updates to variable wildcard supportScott Rifenbark2018-10-291-5/+12
| | | | | | | | | | | | | | Fixes [YOCTO #12390] Updated three variables: BB_ALLOWED_NETWORKS, BBMASK, and BBFILES. Fixed some linking to be sure to use Python3 links instead of Python 2. Fixed a note to clarify use of the "*" wildcard restrictions in the BB_ALLOWED_NETWORKS variable. (From yocto-docs rev: 6f880d10d0830d80cc2d4d1d5b7ea141dad6d4af) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updates to the SSTATE_MIRRORS variable.Scott Rifenbark2018-10-291-6/+10
| | | | | | | | | Accounting for uninative stuff. (From yocto-docs rev: 5915f1345e3b91ae848cf419560d8fae4e850058) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated SSTATE_MIRRORS variable descriptionScott Rifenbark2018-10-291-1/+16
| | | | | | | | | | | | | Fixes [YOCTO #11107] Updated the SSTATE_MIRRORS variable description to include explanation of how to use regular expressions to map file locations to server-provided URLs to share sstate information. (From yocto-docs rev: 1357095864ee919f576de8df36f4e177b24fdd22) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updates to describe wildcarding supportScott Rifenbark2018-10-201-48/+119
| | | | | | | | | | Added specific wildcarding support descriptions for all related variables and file panthnames. (From yocto-docs rev: 543e398c4ae1bce38517a88cd91c957a583a2892) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added "debug-with-srcpkg" option to package split variableJoshua Watt2018-10-041-0/+6
| | | | | | | | | | Added the "debug-with-srcpkg" option for the PACKAGE_DEBUG_SPLIT_STYLE variable. (From yocto-docs rev: 05c51e53059bf7c999a448402d60d0b16d62341b) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated TCLIBC variable.Scott Rifenbark2018-09-111-19/+20
| | | | | | | | | Added "baremetal" as an argument. (From yocto-docs rev: 34cb39334d0af43f3c184adbfc53270def394154) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual, ref-manual: Changed section heading for multiconfig buildsScott Rifenbark2018-08-281-1/+1
| | | | | | | | | | | | Changed the section heading in the dev-manual for building images for multiple targets useing multiple configurations. This wording is more accurate. I updated the link from the BBMULTI_CONFIG variable description as well. (From yocto-docs rev: 3b2f95c3c54bed7ab8b4673ba7a254d31bea811b) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual, ref-manual: Updated available names for TEST_TARGETPaulo Neves2018-08-151-17/+6
| | | | | | | | | | | | | | The documentation of available names for TEST_TARGET has been updated to match the convention of using the class names of controllers. This commit was modified some to make it work. Fixed some formatting errors and isolated and changed missed instances. (From yocto-docs rev: 1bec1dc38cdd1746ce6dd539f9c3e5665d12ab8e) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: UPdates to the PNBLACKLIST variable descriptionScott Rifenbark2018-08-151-4/+3
| | | | | | | (From yocto-docs rev: c8a606dbce01132e95250c33270ff729cadc2c0e) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Removed non-existant variable from PACKAGE_WRITE_DEPS descriptionScott Rifenbark2018-08-151-1/+1
| | | | | | | | | Took out an occurrence of PACKAGE_WRITE_DEPENDS (From yocto-docs rev: f7b2c7c08f3f504e14943a01e7fc0a73c96e9636) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated the SDK_TITLE variable descriptionScott Rifenbark2018-08-151-9/+20
| | | | | | | | | | Provided more detail and a cross-reference into the SDK manual where you can change the title through the variable. (From yocto-docs rev: 9617fa70caef48328455a02d5260e536fac19c53) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added SDKEXTPATH variable description.Scott Rifenbark2018-08-151-0/+30
| | | | | | | | | | | | This variable is the default installation directory for the Extensible SDK. By default, it is "poky_sdk". You can override this variable so it needed to be documented. The ideal place to override it is in the distribution configuration file. (From yocto-docs rev: 67eca50fa973073ce6e7975ab66b89b9706c25c0) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated DISTRO_NAME variable description.Scott Rifenbark2018-08-151-0/+40
| | | | | | | | | I provided some real detail on this variable. It was woefully brief. (From yocto-docs rev: 4282fabddc81bf4c0fbd0a641ec4f1e9754660c2) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated the DISTRO variable descriptionScott Rifenbark2018-08-151-7/+14
| | | | | | | | | | I added a cross-reference to the "DISTRO_NAME" variable as it is the long version of the distribution name. (From yocto-docs rev: bb5638409faadb9c6a5fbca729e4e6b8a220433d) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Fixed cross-reference wording in SDK_LOCAL_CONF_WHITELISTScott Rifenbark2018-08-151-5/+9
| | | | | | | | | Wording did not match that of similar SDK variables. (From yocto-docs rev: 696eb9ff0b89222dc696adc0bd28247c0a0c731a) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Fixed grammar error in SDK_INHERIT_BLACKLIST descriptionScott Rifenbark2018-08-151-2/+2
| | | | | | | (From yocto-docs rev: 0a5775f7ad3e0b6531fcfd1d328d8e0da8727400) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added cross-reference to SDK_LOCAL_CONF_BLACKLIST varScott Rifenbark2018-08-151-0/+9
| | | | | | | | | | Put in a cross-reference to the section in the sdk-manual where it talks about customizing the configuration of the extensible SDK. (From yocto-docs rev: 062db19dd56cc1827ebd7614eb8a54660421df62) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated the SDK_INHERIT_BLACKLIST variable descriptionScott Rifenbark2018-08-151-3/+16
| | | | | | | | | | | Added information on the class in which the default is set. Also, put in a reference for more information on customizing the extensible SDK configuration. (From yocto-docs rev: a0145996aeac1bb45fea9f613789b00327f92d1e) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated the SDK_LOCAL_CONF_WHITELIST variable descriptionScott Rifenbark2018-08-151-4/+16
| | | | | | | | | | | Enhanced this description by indicating the class that it is set in and by including a pointer back into the sdk-manual where filters are described for extending the extensible SDK. (From yocto-docs rev: 355b05366aadc337ec3337c0a3c918a23027923b) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated the SDK_LOCAL_CONF_BLACKLIST variable descriptionScott Rifenbark2018-08-151-2/+21
| | | | | | | | | | | Added more detail including the class that sets the default variables for exclusion and the list of actual variables that are excluded by default. (From yocto-docs rev: f24287851998d554575c6aaf9dcc50d198931e48) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual, ref-manual: Documented NO_GENERIC_LICENSEKristi Rifenbark2018-06-281-0/+34
| | | | | | | | | | | FIXES [YOCTO #12734] Added a new variable description and created a new section in the dev-manual. (From yocto-docs rev: 854e641482171585c96ee5b9387b3e64146072b9) Signed-off-by: Kristi Rifenbark <kristi@buzzcollectivemarketing.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Moved "Speeding Up the Build" and renamed it.Scott Rifenbark2018-05-241-2/+2
| | | | | | | | | | | Renamed to "Speeding Up a Build" and moved out of the setting up chapter to the common tasks chapter. Fixed a couple links in the ref-manual. (From yocto-docs rev: c53fddd353230c8ef1abc21c7a2d2b1f492f034a) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* overview-manual, dev-manual: Moved licensing how-to stuff to dev-manualScott Rifenbark2018-05-241-6/+6
| | | | | | | | | | | | The section on licensing in the overview-manual was really "how-to" information. I moved this to a new section in the dev-manual for "working with licenses". I fixed some references in the ref-manual and in the bsp-guide as well. (From yocto-docs rev: f150a1ea2da900aae88fc5fa60f4115cc213ba2d) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated the SDK_OUTPUT variableScott Rifenbark2018-05-241-2/+5
| | | | | | | | | Added more realistic information on how this variable is set. (From yocto-docs rev: 47e6cb7d00eeb8001c4a53c13600feb5ef4d4660) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>