summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual
Commit message (Collapse)AuthorAgeFilesLines
* 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, overview-manual: Fixed BitBake User Manual linksScott Rifenbark2018-12-271-1/+1
| | | | | | | | | | | | | | Some occurrences of links to the BitBake User Manual were using a target (i.e. &YOCTO_DOCS_BB_URL;#bitbake-user-manual). Using this form causes the mega-manual.sed file to not process the link correctly for the mega-manual. These are subtle errors and have probably existed for some time. I removed the target ID to fix the problem. (From yocto-docs rev: 701f61fd80e5103ee02efbe5eed9a8607ac9a336) 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>
* documentation: Preparing for 2.7 release.Scott Rifenbark2018-12-151-1/+6
| | | | | | | | | | | Updated poky.ent to have variables for 2.7. Updated mega-manual.sed file to use "2.7" string. Updated all <manual>.xml Manual History Tables to use "TBD" (From yocto-docs rev: d6f8bbd6e107913265ea1ac95ab8817e199ff60b) 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-153-7/+14
| | | | | | | | | | | 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: Updated list of supported Linux Distros:Armin Kuster2018-11-221-15/+18
| | | | | | | | | Updates for the "thud" release. (From yocto-docs rev: ccd2d2c7b062627a3fd1961ab23ee6fff714428a) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added a note saying WSL is not supported.Scott Rifenbark2018-11-221-0/+8
| | | | | | | | | | Windows Subsystem for Linux (WSL) is not supported with the Yocto Project. (From yocto-docs rev: 0898d7fb7166da91598854f385cd574004098ac3) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated image_types.bbclass description.Ming Liu2018-11-221-14/+21
| | | | | | | | | | | | The "image_types" class is now inherited mandatorily in image.bbclass through the variable IMGCLASSES. Users do not have to inherit it in their customized image type bbclass. They also do not have to put it in IMAGE_CLASSES. (From yocto-docs rev: bd391092b216e39dad317dc1aae5c715371766ef) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added description for devupstream.bbclassScott Rifenbark2018-11-221-0/+48
| | | | | | | | | | | New section added. Fixes [YOCTO #12732] (From yocto-docs rev: 3d4a1fef8e1809cd7f1dece55790b6ee12dc60b3) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added cross-references to "Post-Installation Scripts"Scott Rifenbark2018-11-221-1/+11
| | | | | | | | | | | | Two areas in the migration chapter discuss the post-installation behavior when you defer the scripts to after boot. I added a couple references to each of those migration note sections that go into the dev-manual's section. (From yocto-docs rev: eeb09b5fa208499f37be4e5aafcf55db82715fd1) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated "Packaging Changes" section for 2.6 migration.Scott Rifenbark2018-11-221-1/+2
| | | | | | | | | | Changed reference to "python-modules" to "python-modules / python3-modules". (From yocto-docs rev: 49d66f928366dda19b6afd1e9ac6431f0f66ab21) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Applied review edits to the 2.6 migration section.Scott Rifenbark2018-11-221-11/+8
| | | | | | | | | Minor fixes here and there. (From yocto-docs rev: 740b4392bd98a12f188b79ae3ecdc7c3031f9f7d) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: New 2.6 Migration section complete.Scott Rifenbark2018-11-221-20/+14
| | | | | | | (From yocto-docs rev: 6597ea2d706e3975ff0ffae15cf748ffd7aaed8b) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added new python3 profile-optimization migration topicScott Rifenbark2018-11-221-0/+33
| | | | | | | (From yocto-docs rev: 2d0960d9282ffcb843ed9956a0e49183b22f11f2) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated postinstall migration note.Scott Rifenbark2018-11-221-2/+8
| | | | | | | (From yocto-docs rev: fa6582df36d770e7207e4c5201dafe0e64f46a76) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updates to the 2.6 migration section.Scott Rifenbark2018-11-221-9/+235
| | | | | | | | | This is the completed first draft. (From yocto-docs rev: 45d39b7655ea5b515c8dda91249a84ee19387099) 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 references.Scott Rifenbark2018-11-221-8/+0
| | | | | | | (From yocto-docs rev: fdce52a34db29c98140daa05bd9c660a2494dc12) 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 several new sections to the 2.6 migration section.Scott Rifenbark2018-11-221-2/+284
| | | | | | | (From yocto-docs rev: 54703fbde3f7808b9257da883fe8e4769a65fc44) 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: Updated migration section for 2.6Scott Rifenbark2018-11-221-3/+3
| | | | | | | | | Made two minor corrections from reviewer feedback. (From yocto-docs rev: 765e44127f52e1d9d4d1c365b0574ca73364add2) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated 2.6 migration topic "_remove"Scott Rifenbark2018-11-221-0/+9
| | | | | | | | | | Provided more explanation and also a link into the BB manual for a detailed example. (From yocto-docs rev: ca1e113dc837f5104f765b655880a87d1fbd66ac) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added the 2.6 Migration Section.Scott Rifenbark2018-11-221-0/+88
| | | | | | | | | | Provided some new sections on the information for migrating from the 2.5 release to the 2.6 release. (From yocto-docs rev: dd721a31594c753d7229c45ebad0ce11640a0704) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated testimage and testsdk class descriptions.Scott Rifenbark2018-11-221-0/+16
| | | | | | | | | | | I added notes indicating that the best practice for automated testing is to inherit these classes by using the IMAGE_CLASSES variable instead of the INHERIT variable. (From yocto-docs rev: 8f4765db897c20f0011ea65f62d6b45495d313d2) 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-223-37/+43
| | | | | | | | | | 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-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>
generated by cgit v1.2.3-54-g00ecf (git 2.39.0) at 2024-11-12 04:42:21 +0000