summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual
AgeCommit message (Collapse)Author
2019-04-09Documentation: Prepare for 2.6.2 release.Scott Rifenbark
poky.ent - updated variables mega-manual.sed - updated release string <manual>.xml - updated manual revision history tables (From yocto-docs rev: 5559b4006668d47595b3e4b5d5703bb1c200d6d1) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-03-19ref-manual: Fixed SRC_URI cut-and-paste error.Filip Jareš
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: fdf0a0e2e0bd0852208d08e5661a04d25c04feef) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-02-25ref-manual: Typo found and fixed.Daniel Ammann
(From yocto-docs rev: 035c6bc2089b19b0d0ae332bca25a75211f86964) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-02-12ref-manual: Fixed INC_PR literal example indentation.Scott Rifenbark
Five-space indentation missing. (From yocto-docs rev: 6e43669a0100bb4520770d8aadee3b9c8526dbf5) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-02-12ref-manual: Updated list of supported distros.Scott Rifenbark
Had to make some tweaks. (From yocto-docs rev: 7200f3d0b75e2ffc8b755c4962b532f399b78885) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-02-12ref-manual: Updated the list of supported distrosScott Rifenbark
Ran the script against the tip of the "thud" branch in poky and used the supported distros returned. (From yocto-docs rev: 75b72c440a08d38562fb846ef0714e96d4b4a811) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-12-27Documentation: Prepare for 2.6.1 release.Scott Rifenbark
Updated the following: * poky.ent to use new variables values for 2.6.1 * mega-manual.sed to use "2.6.1" string for links * *.xml manual files to have a new entry in the manual history tables. Using the variable for the most recent entry. Hard-coded "November 2018" for the previous release, which was "2.6". (From yocto-docs rev: bada424e14169d1ae378c0481970e55ce8f5df51) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-12-27ref-manual: Document the fifth argument to PACKAGECONFIGPeter Kjellerstedt
(From yocto-docs rev: 1a4a95d070d79bfeb202faf381c2e0a288ba88f5) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-12-27ref-manual: Add missing whitespace around "=" in a few code examples.Peter Kjellerstedt
(From yocto-docs rev: 0ed3bd9cfe6a3ad04e2ebbbcc95320275dcfacad) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-12-27ref-manual: Updates to CMake and cmake.bbclass.Scott Rifenbark
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: 7e825427a2dcef2b91a1bfbf1827b73e034e0974) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-12-27ref-manual: Updated list of supported Linux Distros:Armin Kuster
Updates for the "thud" release. (From yocto-docs rev: 1e8dd2130c7814895cf745b615346d3715d39fac) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-12-27ref-manual: Added a note saying WSL is not supported.Scott Rifenbark
Windows Subsystem for Linux (WSL) is not supported with the Yocto Project. (From yocto-docs rev: 68dea2908b5cfeb9e374c6e72493f6b635267dda) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-12-27ref-manual: Updated image_types.bbclass description.Ming Liu
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: 9d71cd281864478c76e40fa6e0b9cd0055f131c0) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-12-27ref-manual: Added description for devupstream.bbclassScott Rifenbark
New section added. Fixes [YOCTO #12732] (From yocto-docs rev: e0c4006614cca76f07782c8273f4c8cba5394220) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-12-27ref-manual: Added cross-references to "Post-Installation Scripts"Scott Rifenbark
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: fd550364c6fcfdff24b5c69f289733ed319c6be1) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-12-27ref-manual: Updated "Packaging Changes" section for 2.6 migration.Scott Rifenbark
Changed reference to "python-modules" to "python-modules / python3-modules". (From yocto-docs rev: d3efb499d0f027be5233dc2f922cef98b03015ca) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-12-27ref-manual: Applied review edits to the 2.6 migration section.Scott Rifenbark
Minor fixes here and there. (From yocto-docs rev: 37617222d5e76cd9debfb8271807ff016d124010) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-12-27ref-manual: New 2.6 Migration section complete.Scott Rifenbark
(From yocto-docs rev: 6d898834bbcef29934f9fcf895880acdb8838a57) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-12-27ref-manual: Added new python3 profile-optimization migration topicScott Rifenbark
(From yocto-docs rev: 108adb60eabf43ddd4fa91f26b701e7a2930dcee) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-12-27ref-manual: Updated postinstall migration note.Scott Rifenbark
(From yocto-docs rev: beb7286abdfa2a6f9cc1772429671250a52d6425) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-12-27ref-manual: Updates to the 2.6 migration section.Scott Rifenbark
This is the completed first draft. (From yocto-docs rev: f7f7e6b64c3dc8380b107851abc5719fd806683a) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-12-27ref-manual: Added KERNEL_ARTIFACT_NAME and adjusted referencing variables.Scott Rifenbark
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: e3fd82b1c65460097d7e0f2398be8c8756892e65) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-12-27ref-manual: Removed the NOISO and NOHDD references.Scott Rifenbark
(From yocto-docs rev: ae83daebbb316d2c34136c466bdf7b491c9fff1b) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-12-27ref-manual: Removed the NOISO and NOHDD variables.Scott Rifenbark
(From yocto-docs rev: 969533a299c559eadeb8807e94f6af79fbf8f66a) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-12-27ref-manual: Added several new sections to the 2.6 migration section.Scott Rifenbark
(From yocto-docs rev: 0f5d18d0118632db43706beef7d2020ec6890ade) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-12-27ref-manual: Added new artifact naming variables to glossary.Scott Rifenbark
(From yocto-docs rev: 8c4d8fba8e5bf84a230c112b1b46a3bc5453184a) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-12-27ref-manual: Changed "post 2.6" to correct wording.Scott Rifenbark
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: 93720a1c072ad6268cb5681c51660f03059d880a) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-12-27ref-manual: Added KERNEL_IMAGE_NAME descriptionScott Rifenbark
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: 2a7bc2dd274f23d58c997771175c37005763ed08) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-12-27ref-manual: Added GCCVERSION variable description to glossary.Scott Rifenbark
(From yocto-docs rev: f48ffe39e2d0c1bc57579e4ee457c72b7c626ad1) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-12-27ref-manual: Updated migration section for 2.6Scott Rifenbark
Made two minor corrections from reviewer feedback. (From yocto-docs rev: 41e657ba47dd91a10a1d1ae4855e959eb697ea76) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-12-27ref-manual: Updated 2.6 migration topic "_remove"Scott Rifenbark
Provided more explanation and also a link into the BB manual for a detailed example. (From yocto-docs rev: eb2a3bc65c99ae72173d5f3848af423af112ccb2) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-12-27ref-manual: Added the 2.6 Migration Section.Scott Rifenbark
Provided some new sections on the information for migrating from the 2.5 release to the 2.6 release. (From yocto-docs rev: b95183e9f2358ec5bc67081334e13526ba1ad48d) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-12-27ref-manual: Updated testimage and testsdk class descriptions.Scott Rifenbark
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: 70e18e93e96f283ae183f5f4468859bfca37c581) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-12-27ref-manual, dev-manual: Removed TEST_IMAGE for TESTIMAGE_AUTO.Scott Rifenbark
The TEST_IMAGE variable went away and was replaced with the TESTIMAGE_AUTO variable. Fixed all related/affected areas. (From yocto-docs rev: 84e2c149fa823ab6e12be17b049c9bae1c1dd904) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-10-29ref-manual: Updates to variable wildcard supportScott Rifenbark
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>
2018-10-29ref-manual: Updates to the SSTATE_MIRRORS variable.Scott Rifenbark
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>
2018-10-29ref-manual: Updated SSTATE_MIRRORS variable descriptionScott Rifenbark
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>
2018-10-20ref-manual: Updates to describe wildcarding supportScott Rifenbark
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>
2018-10-04ref-manual: Updates to native.bbclassScott Rifenbark
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>
2018-10-04ref-manual: Added "debug-with-srcpkg" option to package split variableJoshua Watt
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>
2018-09-11ref-manual: Updated TCLIBC variable.Scott Rifenbark
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>
2018-08-28dev-manual, ref-manual: Changed section heading for multiconfig buildsScott Rifenbark
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>
2018-08-15ref-manual: Removed misleading paragraph in siteinfo.bbclassYevgeny Popovych
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>
2018-08-15dev-manual, ref-manual: Updated available names for TEST_TARGETPaulo Neves
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>
2018-08-15documentation: Changed section title for required packages.Scott Rifenbark
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>
2018-08-15ref-manual: UPdates to the PNBLACKLIST variable descriptionScott Rifenbark
(From yocto-docs rev: c8a606dbce01132e95250c33270ff729cadc2c0e) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-08-15ref-manual: Removed non-existant variable from PACKAGE_WRITE_DEPS descriptionScott Rifenbark
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>
2018-08-15ref-manual: Updated the SDK_TITLE variable descriptionScott Rifenbark
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>
2018-08-15ref-manual: Added SDKEXTPATH variable description.Scott Rifenbark
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>
2018-08-15ref-manual: Updated DISTRO_NAME variable description.Scott Rifenbark
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>
generated by cgit 1.2.3-korg (git 2.39.0) at 2024-05-03 11:57:47 +0000