aboutsummaryrefslogtreecommitdiffstats
path: root/documentation
AgeCommit message (Collapse)Author
2017-07-12yocto-project-qs: Updated exit QEMU instructions.Kristi Rifenbark
Removed "poweroff" command to exit and replaced with "Ctrl-C". (From yocto-docs rev: 9251f7ebaf4898acbf30e4b650393a62ad16cb9a) Signed-off-by: Kristi Rifenbark <kristi.rifenbark@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-22dev-manual: Fixed a DocBook issue with formatting "bug-id"Scott Rifenbark
I discovered a mis-placed block of DocBook text that was causing the string "bug-id" to appear in a random spot in the "Patch Submission Details" section. Re-ording this block fixed the problem. (From yocto-docs rev: 92616f73ce31505e11f3193b1350acc875003649) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-06-22sdk-manual: Updated the note for building SDK InstallerScott Rifenbark
For development purposes, static libraries need to be present only in the SDK. We do not need those static libraries in the image for most scenarios. So, replace IMAGE_INSTALL with TOOLCHAIN_TARGET_TASK in the documentation. I updated the note to reflect this. Suggested-by: Maxin B. John <maxin.john@intel.com> (From yocto-docs rev: fd17ac96a44d08f7f2798e69cd923e0726a0754a) Signed-off-by: Scott Rifenbark <srifenbark@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-22yocto-project-qs: Updated the YP Development Flow figureScott Rifenbark
The figure that Scott Garman used for an old video cast is much more appealing to the eye than the giant, square beast the current manual was using. I have replaced the image. The image is technically the same. Because the mega-manual has to use a duplicate figure, I put the new PNG files in the Figures directory for both the yocto-project-qs and mega-manual books. (From yocto-docs rev: 10985cadfecea0096412df049b3457bc0297c4bf) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-06-22dev-manual, sdk-manual: Fixed link to Eclipse sectionScott Rifenbark
The YP doc set was using a link to an out-dated video that showed how to configure and run Eclipse. The video was very old and Jessica suggested just removing it. So, I replaced all occurrences of the link to the up-to-date appendix in the SDK manual that provides information on the latest supported version of the Eclipse IDE. (From yocto-docs rev: a414addb427337dc76a05cf3f56bf8aeec1a7c1b) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-06-22dev-manual: Fixed broken link into the setting up Eclipse sectionScott Rifenbark
The link to the section on how to set up Eclipse had been broken for a while. I fixed the link so that it goes to the appropriate section (appendix) in the SDK manual. (From yocto-docs rev: ab2af9c0b237285c6989832db306a42957a6187d) 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-10yocto-project-qs: Updated output for git clone of meta-intel.Scott Rifenbark
(From yocto-docs rev: 446ca716612ced4931b42abd769e0743a3413710) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-05-10yocto-project-qs: Updated git clone output for pyro poky.Scott Rifenbark
(From yocto-docs rev: 50b2ca338312309dd434418e0c88e725c3791ee1) 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: Cleaned up "Gdbserver" termScott Rifenbark
This should be "gdbserver" when referred to generically. (From yocto-docs rev: 83b2be50e34b0c07cce1f27b55e595752b80b3ea) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-05-10dev-manual: Updated a few occurrences of "dnf" to "DNF"Scott Rifenbark
These depend on context. In general, "DNF" is the preferred terminology unless directly referring to an application or such. (From yocto-docs rev: 29012a8f8e21b964e1ea6d32841dffa8dae7df9f) 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-29poky.ent: Added "iputils-ping" to Ubuntu/Debian essential packagesScott Rifenbark
Fixes [YOCTO #11310] Added the "iputils-ping" package to the list of essential host packages. (From yocto-docs rev: c6478419940405091d59312d22c45e3f32f9c94d) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-04-29poky.ent: Added "python3-pexpect" to distrosScott Rifenbark
Fixes [YOCTO #11310] Added this package to Ubuntu/Debina, Fedora, and OpenSUSE. (From yocto-docs rev: e010d1abc083ed064c5340146bcac213286d973c) 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: Added section on using headers to interface with devicesScott Rifenbark
Fixes [YOCTO #8596] Added a new section to describe the right way to use headers to interface to a device or custom Linux kernel API. Too often a user wants to modify the libc header file, which absolutely wrong. This new section provides some guidance. (From yocto-docs rev: 960c49bf6446398a9efb2d018d09d63b49e97196) 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-12sdk-manual: Fixed link to Neon download site.Scott Rifenbark
Fixes [YOCTO #11263] (From yocto-docs rev: c7e68a533045ff482b5fc022886df58e199dd4b7) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-04-12dev-manual: Added cross-reference to QA and Test Infrastructure section.Scott Rifenbark
Fixes [YOCTO #10887] I placed a small paragraph at the end of the introduction to the "Performing Automated Runtime Testing" section that points into the new section on QA and testing infrastructure in the ref-manual. (From yocto-docs rev: 493051e1770e07b89c19a1f235f1dd226610c77a) 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-04-12dev-manual: Added YP Compatibility featureScott Rifenbark
Fixes [YOCTO #10596] No information existed for the version 1.0 YP Compatibility Program for layers. Additionally, the version 2.0 flavor is adding a script as part of the application process. I put in a new section on the whole topic. Also, integrated the information into relevant sections with some cross-referencing. (From yocto-docs rev: 6341705d4c08901b2657c489f4e995968db00d85) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-03-31poky.ent: Removed python3-expect from the CentOS distroScott Rifenbark
Fixes [YOCTO #10854] Feedback from the review indicated that CentOS python3-pip and python3-expect should be python34-pip. Did this change. (From yocto-docs rev: ae307a183328b3c572e3f63c0274806af244c618) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2017-03-31dev-manuual: Replaced "smart" with "dnf"Scott Rifenbark
Fixes [YOCTO #9675] I missed one occurrence of changing "smart" to "dnf" in the Enabling Tests section. Corrected. (From yocto-docs rev: b5106c7a38f51dbfea6d200072039f624be7ed3a) 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-31kernel-dev: Provided better wording for recipe-space metadata sectionScott Rifenbark
Fixes [YOCTO #10946] Based on feedback, I made some minor rewrites to a sentence describing when you need to use a different form to get BitBake to pick up hierarchical data as kernel data. (From yocto-docs rev: 65fcd23826e9a69152933f84cb3f8bac650cd4e5) 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>