summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual
AgeCommit message (Collapse)Author
2017-09-02ref-manual: Fixed broken link.Scott Rifenbark
(From yocto-docs rev: b0ee7cf9ab8cb8f9beb490b9aac128c48b13af66) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-09-02ref-manual: Removed duplicate section id.Scott Rifenbark
(From yocto-docs rev: b49b1d2219bf18f6581cbdd1f7277d65e697c1f8) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-09-02ref-manual: Added a cross-reference link to "tmp/sysroots-components"Kristi Rifenbark
(From yocto-docs rev: 4cd0c8404e581e33194649a716c84100fddab00c) Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-09-02ref-manual: Updated SSTATE_SCAN_FILES variable descriptionKristi Rifenbark
(From yocto-docs rev: f20240fda71a19a7bf78a8366270998d6c708076) Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-09-02ref-manual: Added tmp/sysroots-components taskKristi Rifenbark
(From yocto-docs rev: b723fc6d05ad4db48dfda2aece797c7cbab06cf3) Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-09-02ref-manual: Corrected spelling errorsKristi Rifenbark
Updated two instances of "sysroot-components" to "sysroots-components". (From yocto-docs rev: 8f95d9ccd958c46ce5f3f4c7eb95424bee958a9e) Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-09-02documentation: Preparation for 2.3.2 releaseScott Rifenbark
poky.ent -> Changed variables mega-manual.sed -> replaced 2.3.1 with 2.3.2 *.xml files -> Updated manual revision tables for 2.3.2 and September 2017 (From yocto-docs rev: ce5bc517148f872e49d617fbfda7ae81c56efa04) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-09-02ref-manual: Fixed YP Term problem with botched earlier commitScott Rifenbark
I was cherry-picking in commits from master to pyro and had a conflict that I did not go far enough to the bottom of the file to see the true nature, which was duplication of the "Yocto Project Terms" section. When I resolved the conflit I just took out the top couple lines and actually left the duplicated terms section in. Then I pushed everthing. I should have made the manuals first and I would have discovered the error. This commit fixes it. (From yocto-docs rev: 0a9a7303fc048b59e5328a9855f8615a042ab411) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-09-02ref-manual: Added new variableKristi Rifenbark
Added SYSROOT_DESTDIR to the variable glossary. (From yocto-docs rev: abb83993ade1200fb99b2c9ee65ea835773c950b) Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-09-02ref-manual: Fixed links in do_prepare_recipe_sysroot taskKristi Rifenbark
(From yocto-docs rev: 369038fa0fa2055bf39583aa1c707d889dd5db07) Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-09-02ref-manual: Edited Migration sectionKristi Rifenbark
Edited OpenEmbedded reference in "Recipe-specific Sysroots" secion. Edited bullet title in "Recipe-specific Sysroots" section. (From yocto-docs rev: a7a909a17e69d7961e0c0d82e77b325e87399e32) Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-09-02ref-manual: Edits to staging.bbclassKristi Rifenbark
Added a missing closing parenthesis. Edited Note for for file clarification. (From yocto-docs rev: c3cd491bf6949bce1546caa4be250ea05a8a564b) Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-09-02ref-manual: Updated build/tmp/work/tunearch/recipename/versionKristi Rifenbark
Replaced "recipe_work_directory" with "${WORKDIR}" throughout the section. (From yocto-docs rev: 79911f48d469f95ec026fe60585d1b4983e9c1c6) Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-09-02ref-manual: Updated Documentation required packagesKristi Rifenbark
Removed xsltproc package in Fedora, CentOS, and openSUSE Documentation required packages. Removed fop package in openSUSE Documentation required packages. (From yocto-docs rev: f7ba4c02c0157a8210b0e145a7cbc1ba51f3795b) Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-09-02dev-manual: Updates to "Using .bbappend Files in Your Layer"Scott Rifenbark
I did some rewriting for clarity in the "Using .bbappend Files in Your Layer" section. The section needed to be retitled so focus on the layer aspect of .bbappend files. Also, while I was in there, I did more work on the prose in general. Also had to fix some links in the bsp, kernel, and ref manuals that linked into the section whose name I changes. (From yocto-docs rev: 27003c525a05ffa2f810a038c7c8f96bb7535986) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-06-22ref-manual: uClibc Replaced by musl from Yocto 2.2Changhyeok Bae
(From yocto-docs rev: 859549a1dbc0b63bc04310a121600ea622509256) Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-06-22ref-manual: Updated LAYERRECOMMENDS variableScott Rifenbark
Fixes [YOCTO #11579] I made some corrections by taking out the fact that BitBake issues a warning or error if any version mismatches are found. (From yocto-docs rev: e037858b95a97699c110be3b091db06633c9c44a) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-06-22documentation: Prepared 2.3.1 release variables and datesScott Rifenbark
poky.ent - updated variables for 2.3.1 mega-manual.sed - exchanged "2.3.1" for "2.3" for links <manual>.xml - updated manual revision tables to use "June 2017" as the release date for 2.3.1 (From yocto-docs rev: 01d60d08a0c7371b8f7476f45fca89226caec680) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-06-22ref-manual: Updated PACKAGECONFIG_CONFARGS variableScott Rifenbark
Fixes [YOCTO #11600] Removed the example. It was not needed. (From yocto-docs rev: e3610147535c259c49c3dc08289c037ba49c48a1) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-06-22ref-manual: Added warning to native.bbclass for naming conventionScott Rifenbark
Fixes [YOCTO #11411] Added a naming convention warning to the native.bbclass description that is similar to the existing warning used in the description for the nativesdk.bbclass. (From yocto-docs rev: ece69399decb54045c974e9e537286eb820fde61) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-06-22ref-manual: Updated PACKAGECONFIG_CONFARGS variable descriptionScott Rifenbark
Fixes [YOCTO #11600] "configure" and "cmake" are not do_* tasks of BitBake. I updated the formatting of these programs and removed links that were to the tasks in the reference manual. (From yocto-docs rev: a53d766976ec77a2706014d114bef698d3b6f710) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-06-22ref-manual: Added LAYERRECOMMENDS variable descriptionScott Rifenbark
Fixes [YOCTO #11579] Added a new description for the LAYERRECOMMENDS variable. (From yocto-docs rev: 207c69e218507b384dbd017367dfe392fd45296e) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-06-22ref-manual: Updated LAYERDEPENDS variable descriptionScott Rifenbark
Fixes [YOCTO #11579] The syntax for specifying a layer version was incorrect. I have added an explanation for the correct syntax and provided an example. (From yocto-docs rev: 83c97473defbbac35ebca81f4ef69289f3dd8789) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-06-22ref-manual: Updated image-live.bbclass descriptionScott Rifenbark
Fixes [YOCTO #9001] Updated the image-live class description to specifically mention creating *.iso and *.hddimg images as "live" images. Provided more explanation about usage through the NOISO and NOHDD variables. Also, provided a cross-referencing link back to the updated image-live class from the EFI_PROVIDERS variable. (From yocto-docs rev: 10c81adc26bd0a7a8952eb362f958f92566d42db) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-06-22ref-manual: Enhanced the glossary description for INHERITScott Rifenbark
Fixes [YOCTO #11498] I enhanced the description of the INHERIT variable's glossary description to provide more detail. I also included a link into the section of the BB manual where INHERIT is described. (From yocto-docs rev: ed44df6342ee20720aeee2dd8eae944db767023e) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-06-22ref-manual: Fixed typo for "Installation"Joshua Lock
(From yocto-docs rev: 7abd2ff4948a25da7de85df102fb4e54920b3072) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-05-10ref-manual: Removed section on checking for build-time dependencies.Scott Rifenbark
This scheme has changed due to recipe-specific sysroots making it obsolete. Removed the entire section. (From yocto-docs rev: c52a896829212863402e5532dd8fb7fe4c247fca) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-05-10ref-manual, dev-manual: replaced "depexp" with "taskexp"Scott Rifenbark
(From yocto-docs rev: 3d7a13357a12b70d0c46b8aafdaf2ace20dcb970) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-05-10ref-manual: Removed text surrounding BB_SETSCENE_VERIFY_FUNCTION* varsScott Rifenbark
The BB_SETSCENE_VERIFY_FUNCTION2 variable no longer exists. I removed a link to the BB manual to this variable description, which no longer exists. Also, removed a paragraph in the discussion around setscene that talked about the variable. (From yocto-docs rev: 1f8e3d53ee72c369cb1211332e074976737fd76b) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-05-10dev-manual: Changed "Dnf" to "DNF" for consistencyScott Rifenbark
(From yocto-docs rev: 22ca6c591fd28995a5444635dc787c67f8af822a) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-05-10ref-manual: Added links for variablesScott Rifenbark
Needed to add cross-links into the glossary for various variables. (From yocto-docs rev: 45acf78a2f99e8fda91042c2bee30094255e5a10) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-05-10ref-manual: Added 4 DISTRO_FEATURES* variable descriptions.Scott Rifenbark
Added the following: * DISTRO_FEATURES_NATIVE * DISTRO_FEATURES_NATIVESDK * DISTRO_FEATURES_FILTER_NATIVE * DISTRO_FEATURES_FILTER_NATIVESDK to the variables glossary. (From yocto-docs rev: ee68291c32cdbf8004c24295784c0f70f02c0a55) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-05-10ref-manual, dev-manual: Completed first draft of 2.3 migration section.Scott Rifenbark
(From yocto-docs rev: 42ab9e34da640b46d39741c9c83648dc65518ec1) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-05-10ref-manual: Applied 2.3 Migration review comments.Scott Rifenbark
(From yocto-docs rev: 08a077adea37d5b3eb3ac119b1a5981a6fef21a3) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-05-10ref-manual: Added new glossary entries for HOSTTOOLS* variables.Scott Rifenbark
Entry added for HOSTTOOLS and HOSTTOOLS_NONFATAL. (From yocto-docs rev: c766920a13071c1bb46a195ea07be38962d2e12d) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-04-29ref-manual: Added warning for nativesdk recipe naming conventionScott Rifenbark
Fixes [YOCTO #11411] To help clear up the importance of the naming convention a user must follow when creating a nativesdk-myrecipe.bb recipe that inherits the nativesdk class, I placed a warning note at the end of the section for the "nativesdk.bbclass" section. (From yocto-docs rev: e6dc512aaeb0267c2c15c17a599c6950728b4547) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-04-20dev-manual, ref-manual: Updated various wordings and linksScott Rifenbark
Fixes [YOCTO #10995] I implemented various wording changes based on feedback from the review. One section title changes so some links in the ref-manual and the dev-manual needed updating as well. (From yocto-docs rev: 43a35a311a006d47db50602822e44ab431ca3e43) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-04-18poky.ent: Removed "python3-expect" package from 3 distros.Scott Rifenbark
Fixes [YOCTO #11310] After a bit of deliberation.. it was decided that "python3-expect" is not needed in the Debian, Fedora, and OpenSUSE distros as an essential package. They are gone. (From yocto-docs rev: 07fcb23a03122e5f4f9bb2a32e585d9cba7d5d93) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-04-18ref-manual, dev-manual: Updates to support recipe-specific sysrootsScott Rifenbark
Changes covered several areas. Version 2.3 of the YP now supports recipe-specific sysroots and is not limited to machine-specific as was prior releases. Manual changes were as follows: dev-manual: "Sharing Files Between Recipes" - Wordings were changed to support the new functionality. ref-manual: do_prepare_recipe_sysroot task added to the list of tasks described in "Configuration and Compilation". ref-manual: Extensive re-write of the "staging.bbclass" section. ref-manual: Added a section to the build structure for build/tmp/work/tunearch/recipename/version/. This section breaks down the recipe-specific subdirectories used to create (stage) the sysroot. ref-manual: New section (entry) for the do_prepare_recipe_sysroot task in the task chapter. ref-manual: Added a variable glossary description for the SSTATE_SCAN_FILES variable. In addition to these changes, I sprinkled in a liberal amount of cross-referencing for the readers pleasure. (From yocto-docs rev: 3a8ca96861f4c5d3badb91d0cdc5a3df513d4e59) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-04-12dev-manual, ref-manual: Edits to the "Incrementing Binary Package" section.Scott Rifenbark
Fixes [YOCTO #10995] I applied some revisions to the related sections for incrementing a binary package version and revision sections. Mainly clarified terminology and pulled the sections into one single section head. I also cleaned up referencing to all these sections throughout the YP manual set (i.e. the ref-manual). (From yocto-docs rev: 7deda18dd496cc383c5de71a10f2b11b1ca0688f) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-04-12dev-manual, ref-manual: Created new section on linear revision for packagesScott Rifenbark
Fixes [YOCTO #10995] For the dev-manual, I added a new section on incrementing package revision numbers that explains how the build system uses various variables to create linearly numbered revisions for packages. For the ref-manual, I cross-referenced into the new section from the AUTOSRC and SRCREV variables. (From yocto-docs rev: 53c3092e0f0293f4db0a88659abb4cf1c93f208c) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-04-12ref-manual: Initial draft of 2.3 migration section.Scott Rifenbark
(From yocto-docs rev: c4c995aa94e5100e0d306eb91f490c23726ea91f) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-04-12dev-manual, ref-manual: Added PACKAGE_WRITE_DEPS and concept supportScott Rifenbark
Fixes [YOCTO #11274] When a post-installation or pre-installation script uses tools that have dependencies, you need to specify the tools using the new PACKAGE_WRITE_DEPS variable. I added this information at the end of the "Post Installtion Scripts" section in the dev-manual. I also added a new variable entry for the PACKAGE_WRITE_DEPS variable in the glossary. (From yocto-docs rev: 4d130b63cba5ebabd4af52b62421d387a4b54353) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-04-12ref-manual: Added section on test and QA infrastructureScott Rifenbark
Fixes [YOCTO #10887] There needed to be an overview of the test and QA infrastructure used by the YP development team for releases and that is visible to the developer. I added a new section for this information into the existing section on YP release processes. (From yocto-docs rev: 17b3d6898b37bdbfbd23a333a4d659a9746696d0) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-03-31ref-manual: Rewording of devtool-deploy target command caveatsScott Rifenbark
Fixes [YOCTO #10350] Based on Henry's assesment that the wording was unclear in some spots, I did a little smithing to try and help. (From yocto-docs rev: b52bb8d73071ad6b7a0956dec2f84a84ae1c7045) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-03-31dev-manual; ref-manual: Updates to replace "smart" with "dnf"Scott Rifenbark
Fixes [YOCTO #9675] Various fixes to replace the "smart" package manager references with "dnf". (From yocto-docs rev: 721dc7fb637c4c03534eb19f61b0b08a7303826d) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-03-31ref-manual: Fixed wording for clarityScott Rifenbark
Fixes [YOCTO #10898] I altered the verbiage used to describe the inclusive nature of the beginline and endline note to be clear to non-native English speaker based on feedback. (From yocto-docs rev: 5edf417cd044ded30d1f8366ac0cde336d0da016) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-03-31ref-manual, yocto-project-qs, poky.ent: Fixed CentOS essentialsScott Rifenbark
Fixes [YOCTO #10854] I added extra "yum" commands and a make command to deal with some essential packages needed for CentOS distribution. These packages were missing. (From yocto-docs rev: 38ac6cf0165f7dd7bbfd583e218b6948dafae29c) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-03-24documentation: Added support for "pyro" name and May release date.Scott Rifenbark
poky.ent - changed the "tbd" and "TBD" strings to "pyro" and "Pyro", respectively. Manual Head Files - Updated the manual history table with the May release month. (From yocto-docs rev: 076226d2986d0cf69685121e4342f50c1603fc7b) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-03-24ref-manual: Updated note about included failed license checkScott Rifenbark
Fixes [YOCTO #10898] It is hard to get the exact start and end for included license text during a LIC_FILES_CHKSUM operation. I updated the notes indicating that the QA message returned upon failure includes the attempted license text. The user can better adjust his LIC_FILES_CHKSUM statement to then dig out the proper text. (From yocto-docs rev: 1db04334703f35f1cab933c345fb1db43fd0af79) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>