summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual
Commit message (Collapse)AuthorAgeFilesLines
* 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-202-53/+144
| | | | | | | | | | 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: Updates to native.bbclassScott Rifenbark2018-10-041-15/+21
| | | | | | | | | | | | | | | Fixes [YOCTO #12924] Naming convention does not apply to the second recipe-creation method described in this class. I have moved the note about that to be under the applicable method (i.e. the first bullet). Fixed the syntax reversal of the sample name in the example. (From yocto-docs rev: f7f1a89043156527fa4b426c0322ad225a9f2ff1) 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>
* ref-manual: Removed misleading paragraph in siteinfo.bbclassYevgeny Popovych2018-08-151-6/+0
| | | | | | | | | | | The section on the siteinfo.bbclass file had a paragraph indicating base.bbclass included siteinfo.class. This is not true since 2010. I removed the paragraph. (From yocto-docs rev: 5d39220baddc9db5c1182cea8447e5c4a2e42bd8) 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>
* documentation: Changed section title for required packages.Scott Rifenbark2018-08-153-4/+4
| | | | | | | | | | | The title needs to use the terminology "Build Host" to be consistent with the manual set. I updated the title and the many links into that section. (From yocto-docs rev: 930030433e58e6180ee4f95e559d079c3899defc) 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>
* ref-manual: Removed the do_rm_work_all TaskKristi Rifenbark2018-06-281-9/+0
| | | | | | | (From yocto-docs rev: 74a90f766a38c425a6ceb8a50ad24b23460f9640) Signed-off-by: Kristi Rifenbark <kristi@buzzcollectivemarketing.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>
* documentation: Set up the 2.6 version of the docsScott Rifenbark2018-05-241-0/+5
| | | | | | | | | | | poky.ent - Edited for new variables. <manual>.xml - Manual revision tables updated mega-manual.sed - swapped out 2.5 for 2.6 (From yocto-docs rev: 2bae8fa18ae82a325785276acdeb1394e110d2cf) Signed-off-by: Scott Rifenbark <srifenbark@gmail.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>
* ref-manual: Finalized edits on the 2.5 Migration sectionKristi Rifenbark2018-05-241-108/+88
| | | | | | | (From yocto-docs rev: 54259a4d4d69be73e7c614baa2a8d87faa2e3ea5) Signed-off-by: Kristi Rifenbark <kristi@buzzcollectivemarketing.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Changed "Working With Yocto Project Source Files" titleScott Rifenbark2018-05-241-1/+1
| | | | | | | | | | Changed to "Locating Yocto Project Source Files". I am moving the sections on cloning repositories out from under this section. (From yocto-docs rev: 3889aadab9b603097b6cc5b7afb9d0066021106c) 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: Chanaged a link to Wayland topic.Scott Rifenbark2018-05-241-2/+2
| | | | | | | | | | | The Wayland and Weston topic moved from the overview-manual to the dev-manual. The lone link to this topic was in the ref-images chapter. I updated the link. (From yocto-docs rev: 6c335f8d3618e3285f91fe20aea33a1c1f1c0ddf) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Formatting pass of 2.5 Migration sectionKristi Rifenbark2018-05-241-136/+190
| | | | | | | (From yocto-docs rev: 50308cc7f04d3fc54c06766f85e15e76a99f0b4b) Signed-off-by: Kristi Rifenbark <kristi@buzzcollectivemarketing.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Removed release date ENTITYScott Rifenbark2018-05-241-1/+1
| | | | | | | | | | | Now that 2.5 has released, I replaced the ENTITY variable used for the moving month and year with the actual release month and year (i.e. May 2018). (From yocto-docs rev: 2d6e8ddce4fce0c405d2aea69cea2a5b262410f7) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added 2.5 Migration SectionKristi Rifenbark2018-05-241-0/+417
| | | | | | | (From yocto-docs rev: 5d6c1b69e5559eced5142f46421302f61c95404c) Signed-off-by: Kristi Rifenbark <kristi@buzzcollectivemarketing.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>
* ref-manual: Updated SDK_HOST_MANIFEST variable.Scott Rifenbark2018-05-241-1/+1
| | | | | | | | | Grammar fix. (From yocto-docs rev: aa5a60c8e3bf3f243678169b323e7ea5df7a6c19) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated PACKAGE_CLASSES variable note.Scott Rifenbark2018-05-241-3/+4
| | | | | | | | The note about the TAR backend not working was changed to soften the warning. It has "limited functionality" rather than "broken". Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated the STAGING_DIR variable description.Scott Rifenbark2018-05-241-12/+12
| | | | | | | | | | | This variable plays a much smaller role since recipe-specific sysroots were implemented. I have rewritten the description to say that STAGING_DIR helps construct the recipe-sysroots directory. (From yocto-docs rev: c1ad18abe67111738efc18725c4f7706b55738cb) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated the PKGDATA_DIR variable descriptionScott Rifenbark2018-05-241-0/+3
| | | | | | | | | | | Added a reference to the STAGING_DIR_HOST variable, which is part of the default directory used as the shared, global-state directory holding data generated during the packaging process. (From yocto-docs rev: d68dcec327e96f1da0879681dcde43d4f1769af0) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated STAGING_DIR_HOST variable description.Scott Rifenbark2018-05-241-15/+18
| | | | | | | | | Fixed some grammar issues. (From yocto-docs rev: 5d19e2102d1251dd4fa561995c29191c1489f7fc) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Revision updates to BUILDHISTORY_FEATURES variable.Scott Rifenbark2018-05-241-7/+7
| | | | | | | | | Re-oredered the four options to be alphabetical. (From yocto-docs rev: 7976ee05c935fd6c24abea99f71436003656cc73) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated the FILESPATH variable descriptionScott Rifenbark2018-05-241-1/+15
| | | | | | | | | | Added some key references to the patching areas of discussion across the manual set. (From yocto-docs rev: f198529b3072a4a03fd368ea307e8e004c46a344) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added a link to the patching section in the SRC_URI variableScott Rifenbark2018-05-241-1/+3
| | | | | | | | | | | The file:// protocol is primarily used for digging out patch files that are local with the metadata (layer). I put a link in the paragraph that is talking about them to the "Patching" section in the overview-manual. (From yocto-docs rev: 18a7b4b81d192fb2cfd96763de4cfabd61c3a0ea) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Review edits added to do_patch taskScott Rifenbark2018-05-241-8/+15
| | | | | | | | | | | Mentioned the role of SRC_URI earlier in the description as it is key. Replaced "some_recipe" with "some_package" as the emphisis is not on the recipe at that point in the example. (From yocto-docs rev: f7f86941fdf866a693386335374f835078db3ddf) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated do_patch task descriptionScott Rifenbark2018-05-241-4/+72
| | | | | | | | | | | I added more content to this task description to help describe how patching is performed and how the task uses the "apply" parameter that can be provided with the SRC_URI variable. (From yocto-docs rev: 6717a3326b0005f6a57be4cc026693b7cd9e8d08) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated the BUILDHISTORY_FEATURES variable descriptionPeter Kjellerstedt2018-05-241-2/+10
| | | | | | | | | | | Added a new feature (task) to the list of available features you can use with the variable. The "task" feature saves output file signatures for sstate tasks. (From yocto-docs rev: 0669580ce40c46f0b5f8204a6b00e11f725a383c) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added "Patching" section reference to do_patch taskScott Rifenbark2018-05-241-1/+3
| | | | | | | (From yocto-docs rev: 48335f99d896994283042752bd9ec4d20bd6d363) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated the TARGET_OS variable descriptionScott Rifenbark2018-05-241-4/+4
| | | | | | | | | Provided a more complete and clear description. (From yocto-docs rev: 65505debfb82536e7e2d4ff7e5bc14c6af1a7cf6) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated PACKAGE_ARCH variable description.Scott Rifenbark2018-05-241-3/+9
| | | | | | | | | | | | | | | I added a link to the BUILD_ARCH variable. The variable is part of the glossary but for some reason there was no link to it. I also added a note for a link to the SDK_ARCH variable, which was described inline. By convention, I do not like to link to variables inline as the underlining used to indicate a link messes with with underscore characters that are usually a part of a varible's name. (From yocto-docs rev: a2f487141375ee7ce226eece85424e709ddc67a3) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Added ENTITY variable to track a release date and yearScott Rifenbark2018-05-241-1/+1
| | | | | | | (From yocto-docs rev: 65a87312f541e2f2b01fa1918f7a12da607fe7ab) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
generated by cgit v1.2.3-54-g00ecf (git 2.39.0) at 2024-11-12 06:43:42 +0000