aboutsummaryrefslogtreecommitdiffstats
path: root/documentation
AgeCommit message (Collapse)Author
2016-12-08sdk-manual: Added note about nullpointer error for launch eclipseScott Rifenbark
Fixes [YOCTO #10714] Apparently there is some issues with GTK3 libraries for the Mars Eclipse version. The note provides a workaround that requires editing the eclipse.ini file. (From yocto-docs rev: f940d5d3f7bf446af8f3c7cec5958c8395425a69) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-12-08ref-manual: Added KERNEL_IMAGE_BASE_NAME change to 2.2 migrationScott Rifenbark
The fact that the OpenEmbedded build system can now build multiple image types caused the KERNEL_IMAGE_BASE_NAME variable to have the KERNEL_IMAGETYPE portion removed. This could cause existing recipes that use the KERNEL_IMAGE_BASE_NAME variable directly issues. I added a section indicating that the user should address those recipes to avoid problems. (From yocto-docs rev: c433fca3840440c14bb364a51afc5c3c2bfc7c88) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-12-08ref-manual: Updated KERNEL_IMAGE_BASE_NAME glossary descriptionScott Rifenbark
Fixes [YOCTO #10717] Now that multiple images can be built, the KERNEL_IMAGE_BASE_NAME no longer requires "${KERNEL_IMAGETYPE}" as part of its default value. I have removed this portion of the default definition described in the glossary. (From yocto-docs rev: 713b3c141dfb66fc3852b5a997a7fc19d494e97b) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-11-23dev-manual: Added note about RPM not dealing with post-installScott Rifenbark
Fixes [YOCTO #10351] I added a note to the "Post Installation Scripts" section of the "Writing a New Recipe" section to call out the fact that the RPM package manager will not install packages on the target when any RPM post-install script returns a non-zero exit code when the script is run on the target. (From yocto-docs rev: 8565b0ba874f3357500a91640c0f77077c83b8d6) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-11-23ref-manual, dev-manual: Added references to SYSROOT_DIRSScott Rifenbark
Fixes [YOCTO #10692] I updated the STAGING_DIR variable description to have a reference to the SYSROOT_DIRS variable as well as the "Sharing Files Between Recipes" section of the dev-manual. I also updated the "Sharing Files Between Recipes" section so that the role of SYSROOT_DIRS is explained and actually used in an example to add another directory. (From yocto-docs rev: 6539fcf632cfa3f076f874535ee9fc7ac291fbce) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-11-23sdk-manual: Updated the section on adding docs to standard SDKScott Rifenbark
Fixes [YOCTO #8584] Made some edits to tighten this down and make it more efficient. (From yocto-docs rev: d5a37b77fa5c8df766248849601ca229502bb4ab) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-11-16documentation: Updates to support developing 2.3 YP docsScott Rifenbark
Changes to the following: * All manual revision tables to indicate a 2.3 release proposed for April of 2017. * Updated the poky.ent file so that all variables needed reflect 2.3 values. * Updated the mega-manual.sed file so that processing of links in the mega-manual work for a 2.3 release. (From yocto-docs rev: 926e282c17b67c79b94a0b62a0b18bfbe0b26c40) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-11-16documentation: Added new appendix for customizing standard SDKScott Rifenbark
Fixes [YOCTO #8584] This fix essentially had to document how to add the API documentation to the standard SDK. The fix required adding a new appendix to the SDK manual on how to customize that standard SDK. I could not put just one topic in a new appendix so I also added a sub-section on how to add indidual packages to the standard SDK. Other changes here were the introduction of a new file for the new appendix, updated the mega-manual.xml file so that it would include the new chapter when the MM was built. Finally, I added some cross-referencing to the new appendix from the TOOLCHAIN_HOST_TASK and TOOLCHAIN_TARGET_TASK variables. And a cross reference from the distro features section on the api-documentation bullet. (From yocto-docs rev: 1fb4321ae42253d1fc9602496b5e9e8b495197dd) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-11-16ref-manual: Added api-documentation to distro featuresScott Rifenbark
Fixes [YOCTO #8584] Updated the "Distro Features" section to include the "api-documentation" feature. (From yocto-docs rev: 5b4e8fc58b84aea9a940f67f8d7585912fadc676) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-11-16dev-manual: Fixed typo for "${INC_PR}.0"Scott Rifenbark
The string appeared in the text as "$(INC_PR).0". So, fixed it to be proper with the curly braces. (From yocto-docs rev: 0e4ca6cd3d0eae847243fc624c5f119d004cf40c) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-11-16ref-manual: Fixed presentation of "openSUSE" in supported distrosScott Rifenbark
The way I had this string was incorrect. I changed it to "openSUSE". (From yocto-docs rev: 221f5032ad3589b96a004d38e2b250e38f971007) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-11-16dev-manual: Updated "Exporting Tests" sectionScott Rifenbark
Fixed [YOCTO #10588] This section was confusing due to the fact that it used an actual set of IP addresses and image name where they should be clearly called out as examples. Fixed it. (From yocto-docs rev: 4682899c7b70c730256412bf08f469c457af1c2e) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-11-16ref-manual: Updated the supported distro list for Morty.Scott Rifenbark
(From yocto-docs rev: 0891a9a5715b00de7bd872a7df6f84ef2ea441eb) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-11-16yocto-project-qs: Fixed typoScott Rifenbark
Fixes [YOCTO #10451] Added a missing closing parentheses to a sentence. (From yocto-docs rev: e181c2e48ecc45cb194df02c9019ddada9707b41) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-11-16ref-manual: Fixed tense issue for migration 2.2 sectionScott Rifenbark
The "runqemu Ported to Python" section was using past tense for a note about previous usage patterns being supported. I changed this to present tense. (From yocto-docs rev: d8956022c7eb6046e67766fd6e9121579d6b323b) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-11-16yocto-project-qs: Fixed the minnowboard example to use .wic and baseScott Rifenbark
(From yocto-docs rev: 7e68281d91bdaf060803ac90282b13c456e53807) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-10-25ref-manual: Removed host package requirements for SDKScott Rifenbark
These requirements were in place for the ADT, which is gone now. I have removed the four supported host lists for packages to support the SDK. (From yocto-docs rev: 9c7c20074e455c24c3fa4cf7114495af47d9881c) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-10-25ref-manual: Applied minor corrections to 2.2 migration section.Scott Rifenbark
Moved a couple notes around and changed some wordings... nothing major. (From yocto-docs rev: 75be6c30ca646ee81b955fae7a3e0183ead9ca08) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-10-25yocto-project-qs: Created two sub-sections for the "Build" section.Scott Rifenbark
Fixes [YOCTO #10462] The section that shows how to build images had two examples all within the same section. It was suggested to place these examples in their own sub-sections. Good suggestion. I broke them out into sub-sections titled appropriately. (From yocto-docs rev: 280f304b9823553754c86a5fa6d0c4065d729e7b) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-10-25yocto-project-qs: Fixed the example to use 'dd' instead of 'mkefidisk.sh'Scott Rifenbark
Fixes [YOCTO #10451] The example that writes the image to bootable media did not seem to work when using 'mkefidisk.sh'. It does work using 'dd'. I changed the procedure to use 'dd'. (From yocto-docs rev: 27a70c88f987cee731584618d76c40a878f35a75) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-10-25ref-manual: Added BBMULTICONFIG glossary description.Scott Rifenbark
(From yocto-docs rev: 47edb1bbddead120bc976a920089d61426f8f223) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-10-25dev-manual: Added section for multi-configuration supportScott Rifenbark
I added a new section in the "Common Tasks" chapter to support the fact that BB can now build for multi-configurations. (From yocto-docs rev: aa21aeb2f3d2f9d5a3a6e7175b7c6f13da5f608e) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-10-25ref-manual: Updated the RDEPENDS variable description.Scott Rifenbark
Fixes [YOCTO #10445] Pointed out that the EXTENDPKGV variable is hard to locate in the BB manual. Firstly, we don't document that variable in the BB manual.... maybe we should. For the ref-manual, however, it is barely referenced in a side example from the dev-manual. So, I updated the RDEPENDS variable to have a "Tip" box in the area where it is shown how to use the package version as part of the RDEPENDs variable. (From yocto-docs rev: 7aff5df538c27cf3c2700538e46e723cdb5d9986) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-10-25ref-manual: Updated 2.2 migration for runqemu porting to pythonScott Rifenbark
Indicated that the configuration file is not mandatory. Also, documented the supported qemu* machines should you run the script without a configuration file. (From yocto-docs rev: aeb2c28d7476f67302a1b51da51fb57027e9d02c) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-10-19ref-manual: Removed RM_OLD_IMAGE variable description.Scott Rifenbark
This variable is now redundant due to the way these image files are staged now. The variable does not need to be in the glossary. Removing the images is now the default behavior. Author: Joshua Lock <joshua.g.lock@intel.com> (From yocto-docs rev: 049c371b44d3ef68def4ead7d1db8bf982d23c57) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-10-19ref-manual: Added more to migration 2.2 runqemu ported to python.Scott Rifenbark
Provided more detail on what the user can do with configuration files to use the changed runqemu. (From yocto-docs rev: 5dee8ceca290fdc8f3b41e0eba6565494190ce4f) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-10-19ref-manual: Updated the 2.2 Migration section with review changes.Scott Rifenbark
(From yocto-docs rev: 4af78f942bedb55e46280bc0fc878f174e15b479) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-10-19ref-manual: Added links for migration BitBake change.Scott Rifenbark
I did not put in the links for a couple commits for some of the 2.2 bitbake changes. Put in the links. (From yocto-docs rev: a806463a07ab07ce9da23d6bb73cb981b85b668e) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-10-19ref-manual: Fixed missing title for migration section.Scott Rifenbark
(From yocto-docs rev: 81645a11c4e27daa30891265e9a1ea2c3c2682cc) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-10-19ref-manual: Added the 2.2 Migration guide section.Scott Rifenbark
(From yocto-docs rev: 668e32419ba59d975a196967e620c384009426a4) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-10-19ref-manual: Added note to RM_OLD_IMAGE indicating redundancyScott Rifenbark
The way these old image files are staged now makes removing them the default behavior. Thus, this variable has become redundant. I added a note indicating such. (From yocto-docs rev: e1db620fdf741b46e54cf1a3715597f81a811818) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-10-19ref-manual: Changed BB_SETSCENE_VERIFY_FUNCTION nameScott Rifenbark
The BB_SETSCENE_VERIFY_FUNCTION variable has effectively changed names to be BB_SETSCENE_VERIFY_FUNCTION2. I made the one instance of it correct here. (From yocto-docs rev: c2864dace370d7a43234f4728b33f25082e628e3) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-10-13dev-manual: Re-wrote the remote GDB debugging section.Scott Rifenbark
Fixed [YOCTO #9481] Complete re-write based on Mark Hatle's steps. I converted from sub-sections to an ordered list. (From yocto-docs rev: f83bfe5d3dc012b924b6870672d7260a9c0bc3ee) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-10-13dev-manual: Applied review comments to "Packaging Externally Produced Binaries"Scott Rifenbark
Fixes [YOCTO #10392] Moved the last bullet item from the list that was about DEPENDS to a note form above the list. This was done because the stuff for DEPENDS is more general. (From yocto-docs rev: 2879d97b14322f1f9495288fc7f2298a186c5f68) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-10-13bsp-guide: Updated the yocto-bsp create selections in the example.Scott Rifenbark
(From yocto-docs rev: 5cade0f14904fc6f7f2fab2816fcf2fe97ab7447) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-10-13toaster-manual: Added video link to 2.2 Toaster Intro.Scott Rifenbark
(From yocto-docs rev: 5f93674dbb26db55302471b65f2bc2fa2d78ab8b) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-10-13yocto-project-qs: Fixed Minnow MAX build exampleScott Rifenbark
Fixes [YOCTO #9667] The actual command in the example to build the image for Minnow MAX should be for 'core-image-base'. I changed it to be that. (From yocto-docs rev: 9aca9cceee543eea278390059ccff0761758b55e) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-10-11ref-manual: Updated the USERADD_ERROR_DYNAMIC and USERADDEXTENSION variables.Peter Kjellerstedt
The value for USERADD_ERROR_DYNAMIC changed from "1" to "error" to activate this variable. Also, the value "warn" is used to cause a warning to be issued. I updated the variable description to reflect this. For the USERADDEXTENSION variable, I updated the [doc] string to use proper quote marks. I was not nesting these properly. (From yocto-docs rev: f21277b3887134611fc567da05e8a590ecb0d7af) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-10-11dev-manual: Updated "Packaging Externally Produced Binaries"Scott Rifenbark
Fixes [YOCTO #10392] People often needlessly put [noexec] on tasks, making the recipes more complicated than they need to be. I updated the first bullet item in this section to more clearly explain how to do this. Also, added a new bullet item to the end to point into the DEPENDS variable for more clarification. (From yocto-docs rev: c61e61c1a5f9524c50bfc26335ea6c2027cafd19) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-10-11bsp-guide: Updated the yocto-bsp create output in the example.Scott Rifenbark
Fixes [YOCTO #10385] The output was incorrect for the default kernel type. In the Krogoth branch, the output uses 4.1 and the text indicates 4.4. In the master branch it was the same as well. This commit fixes the master branch to use the default 4.8 kernel in both the example output and the text. (From yocto-docs rev: a76d1cc91883dcd58743f2cd2626917e51419cb1) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-10-11ref-manual: Added link in the SYSROOT_DIRS_NATIVE descriptionScott Rifenbark
Fixes [YOCTO #10377] Linkified the STAGING_DIR_NATIVE item in the the SYSROOT_DIRS_NATIVE glossary entry. (From yocto-docs rev: e02ecfac949b92ec32a621fccb0d1663bb7816ad) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-10-11ref-manual: Review edits to do_populate_sysroot and SYSROOT_DIRS_NATIVEScott Rifenbark
Fixes [YOCTO #10377] Some minor wordsmithing. Also added a new note to the SYSROOT_DIRS_NATIVE variable. (From yocto-docs rev: 459666b01b8d6d8212a59c877ea6c324511a5883) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-10-11ref-manual: Updated three SYSROOT_DIRS* variables.Scott Rifenbark
Fixes [YOCTO #10377] Provided links back into the do_populate_sysroot task and other key variables. I updated the SYSROOT_DIRS, SYSROOT_DIRS_BLACKLIST, and SYSROOT_DIRS_NATIVE variables. (From yocto-docs rev: 23ed80e4884b00e303a15d0d191bd0dca385b064) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-10-11ref-manual: Updated the do_sysroot_populate task description.Scott Rifenbark
Fixes [YOCTO #10377] Added more detail and linked it to key variables. (From yocto-docs rev: d82c1d4e8cc95bee718388cfeced1566ce8569a0) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-10-11ref-manual: Updated QA error message.Scott Rifenbark
Added wording to the "installed-vs-shipped" error message in the QA chapter. (From yocto-docs rev: cc9d22fb6dd8e45ef6b53608f0ebccf29721cc3f) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-10-11ref-manual: Added note about bb.fatal() raising an exception.Scott Rifenbark
Fixes [YOCTO #10363] Added a small note to the bullet item about bb.fatal(). Noted that the function raises an exception so the user does not have to put a "return" statement after the function call. (From yocto-docs rev: c27bae87192b7e109d995679c8c91fb3388d8d4c) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-10-11documentation: Updated Manual revision table for 2.2Scott Rifenbark
Added string "October 2016" as the release date. (From yocto-docs rev: db40986677746afbbb138d9cbe3885111550b7c5) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-10-11ref-manual: Applied review changes to the STAGING_DIR_HOSTScott Rifenbark
I basically moved the note from the bottome to a position within the bulleted list. Fixes [YOCTO #10348] (From yocto-docs rev: a55dc7e0f8465abf8398f51d90bbe2df7e639b3f) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-10-11ref-manual: Added a reference to viewing task variable dependencies.Scott Rifenbark
Put a closing reference in the "Stamp Files and the Rerunning of Tasks" section to point the user to the area that tells them how to view information about a task's signature. (From yocto-docs rev: 3f395ef1999a2aff1447da4d257fd5d53124aaa7) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-10-11yocto-project-qs: Altered MinnowBoard MAX exampleScott Rifenbark
Fixes [YOCTO #9667] The example that built the image out for the MinnowBoard MAX was buiding a core-image-minimal. This was not ideal. I have fixed it so that several types of images are suggested as examples with a reference to the Images chapter in the ref-manual. The actual command now builds out core-image-base. (From yocto-docs rev: 588f9c06bf5dbad253826825dd2a9a67c89f3219) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>