aboutsummaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual
AgeCommit message (Collapse)Author
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-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-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-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-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-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-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-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-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-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-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-11ref-manual: Updated build/tmp/cache/ reference sectionScott Rifenbark
Fixes [YOCTO #10356] Expanded the general description of this directory. (From yocto-docs rev: df71fe472f9d5cb5f809706ec4218952a49d31d3) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-10-11ref-manual: Updated the STAGING_DIR_HOST variable description.Scott Rifenbark
Fixes [YOCTO #10348] Added a note clarifying that -native recipes are not installed into host paths. (From yocto-docs rev: c0b4265350b558eec296c93f0829c3d687950c52) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-10-11ref-manual: Added explanation of the -C optionScott Rifenbark
Fixes [YOCTO #10345] There was no mention of the -C option in the "Running Specific Tasks" section. I added information to cover this command-line option. (From yocto-docs rev: 7b05c5dd3816414c1d3ca898fbd41ce588425057) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-09-28ref-manual: Updated the DEPENDS variable descriptionScott Rifenbark
Fixes [YOCTO #10298] Applied a small grammar fix to the description. (From yocto-docs rev: d022a01af3f68e6e6311c47aef451e25bc8add5e) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-09-28ref-manual: Updated the DEPENDS variable description.Scott Rifenbark
Small grammatical changes. (From yocto-docs rev: efa1e9c3948f7dd240372a1a1c773286072fbccd) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-09-28ref-manual: Applied small edits to the DEPENDS variable desc.Scott Rifenbark
(From yocto-docs rev: 0ef73dc53a1d88689fdc88cd231b0fa72a6eee8b) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-09-28ref-manual, dev-manual: Add information on devpyshellScott Rifenbark
Fixes [YOCTO #9166] In the dev-manual, I added a new section titled "Using a Development Python Shell." This section is similar to the section that talks about using devshell. The section is tied to a reference section on the do_devpyshell task. In the ref-manual, I entered a new task reference for the do_devpyshell task. It is brief and references into the new section in the dev-manual. (From yocto-docs rev: 637128809e298c3d5e660f6da2366f8e9e307218) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-09-28ref-manual, dev-manual: Updates for "staging" discussion and variables.Scott Rifenbark
Fixes [YOCTO #8631] These fixes cover the following: * New glossary entry for SYSROOT_DIRS * New glossary entry for SYSROOT_DIRS_NATIVE * New glossary entry for SYSROOT_DIRS_BLACKLIST * New section titled "Sharing Files Between Recipes" in the dev-manual's "Writing a New Recipe" section. (From yocto-docs rev: e541a3c8967f51b903d9dd7978009f4fa7c2f014) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-09-28ref-manual: Updated the DEPENDS variable descriptionScott Rifenbark
Fixes [YOCTO #10298] Added a better front part description to the variable. (From yocto-docs rev: ce8a093235aa78761fde66f345f993ab7cfac6c6) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-09-28ref-manual: Updated the intro to the devtool quick reference.Scott Rifenbark
(From yocto-docs rev: cb2c4adc48e723072550de0c1ff1f61201c9e8a6) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-09-28ref-manual: Fixed a typo.Scott Rifenbark
(From yocto-docs rev: ee94b0741b0cd6512adb6b2668413341c8d451e9) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-09-28ref-manual: Added two new tipsScott Rifenbark
Fixes [YOCTO #10297] Updated the "Other Tips" section to include a couple new tips. * Remove the /tmp directory as a way to work-around temporary build issues. * Create a little method to help you search the massive amounts of bits for whatever. Also, suggested filing bugs against the docs if a feature is too hard to find or figure out. (From yocto-docs rev: d9829dd096f7cc56f8e55fba3190be2a59b80fe5) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-09-28ref-manual: Added 'depchains' description for auto dep. mech.Scott Rifenbark
Fixes [YOCTO #10295] Added a third item to the list of mechanisms in the "Automatically Added Runtime Dependencies" section. The new mechanism is depchains. (From yocto-docs rev: 304fe159bfbd426b8b42e1245db83ee57b9e5588) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-09-28ref-manual: Updated the PACKAGES variable descriptionScott Rifenbark
Fixes [YOCTO #10294] Provided text noting that if packages in the PACKAGES list are empty are not generated, unless generation is forced through the ALLOW_EMPTY variable. (From yocto-docs rev: 1c89e0edf7e038f733b9b95bb884648d953b9574) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-09-28ref-manual: Updated "Viewing Variable Values" section.Scott Rifenbark
Fixes [YOCTO #10292] I added an additional paragraph at the end of the section that provided more detail on what the bitbake -e and bitbake -e recipe commands provide in the way output. (From yocto-docs rev: 1dcdb6781105f046328271e2b4ba7d875b222dcf) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-09-28ref-manual: Provided an introductory text to the devtool ref.Scott Rifenbark
I put in some introductory material for the new devtool quick reference chapter. (From yocto-docs rev: dc46f47692a533ac2450bf459c098435c57e6c07) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-09-28documentation: devtool upgrade and quick ref changes to mult manualsScott Rifenbark
Did the following: * Added the devtool upgrade flow to the SDK manual. * Removed the devtool Quick Reference from the dev-manual and added it as a new chapter to the ref-manual. * Made sure all the links and cross-references work now with the moved material. * Updated the Make file so that the manual set builds correctly regarding the new chapter in the ref-manual. * Created cross-referencing notes in both the sdk-manual and the dev-manual to the newly located devtool Quick Reference chapter. (From yocto-docs rev: fda0bf68b3654b1b96407d552c5254657465b5fc) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-09-23ref-manual: Updates to PKGDESTWORK and do_packagedataScott Rifenbark
Fixes [YOCTO #10248] Provided more accurate descriptions for this variable and task. (From yocto-docs rev: 422fa705165748230470fffc4fcc543ee38b1f2e) 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-20 07:00:11 +0000