summaryrefslogtreecommitdiffstats
path: root/documentation
AgeCommit message (Collapse)Author
2015-10-27toaster-manual: Added new Toaster functionality descriptions.Scott Rifenbark
Flow and usage information has changed. Changes here reflect that from the Toaster Team. (From yocto-docs rev: 9774dec014b6d13623988b0d7c050c9e6deaad6f) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-10-27ref-manual: Updated the rootfs*.bbclass description.Scott Rifenbark
Fixes [YOCTO #8298] Added "rootfsdebugfile" class to the list of classes in this general class description. (From yocto-docs rev: ad2f6e1d22c9453b0d28cdc0b53558efa1dcc212) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-10-21ref-manual: Updated the allarch class description.Andre Draszik
Added a patch to include a note from Andre. Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-10-21ref-manual: Updated the MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS variableCalifornia Sullivan
MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS won't always grab your out-of-tree module recipe since the kernel recipe's PACKAGES_DYNAMIC variable provides kernel-module-*. This patch documents that your out-of-tree module needs to explicitly set its PACKAGES variable to avoid this behavior. (From yocto-docs rev: 2c51eae23b634cdace5a119ee1a6c8e8ba76dc45) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-10-21ref-manual: Added the 1.8 to 2.0 migration section.Scott Rifenbark
(From yocto-docs rev: 494fc31bbaee6b0c1912d00d3249cc7044e43988) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-10-21dev-manual: Added notes to clarify use of pkg-configScott Rifenbark
Fixed [YOCTO #8168] I placed a couple notes in the "Configuration" and "Compilation" sections within the "Writing a New Recipe" section. These notes point out that the build system (as of release 1.7) now disables several *-config scripts. The user should be using "pkg-config" to ensure proper pathname construction and location of these types of scripts. (From yocto-docs rev: a46fd0f7b4d5da7bf3b218441ec5b9a6ef552266) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-10-21ref-manual: Added correct class name as part of pkgconfig descriptionScott Rifenbark
I was refering to the class as "pkg-config". This was incorrect. I fixed it in the opening sentence to use "pkgconfig". (From yocto-docs rev: c8400b362704093d4c2c891f521c11818eb506a8) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-10-21ref-manual: Fixed typo in 1.6 migration section for BitBakeScott Rifenbark
In Section 5.5.3.2 bb.fetch.encodeurl: Use bb.fetch.encodeurl changed to bb.encodeurl: Use bb.fetch.encodeurl Reported-by: Olivier Dugas <dugaso@sonatest.com> (From yocto-docs rev: bec0f98f2383b231a1d453932a14b07038febd36) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-10-21ref-manual, dev-manual: Applied feedback to edit several classesScott Rifenbark
Fixes [YOCTO #8298] Updated several classes with feedback from Jose Lamego of Intel. The feedback fixed some class groupings so that previously isolated classes could be bundled under common classes (e.g. autotools*.bbclass). I scrubbed the cross-references for cases where a particular class became "undocumented." The cross-references now point to the bundled class entry in the ref-manual. (From yocto-docs rev: 07a533cb41ad26d202f4e303f2dbc7d7bf26e076) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-10-21ref-manual: Added three PACKAGE_FEED_* variable descriptionsScott Rifenbark
Fixes [YOCOT #8301] Added descriptions for PACKAGE_FEED_ARCHS, PACKAGE_FEED_BASE_PATHS, and PACKAGE_FEED_URIS variables. The build system uses these three variables to construct a set of final package feed URIs. (From yocto-docs rev: 53447af460932caa5b2b7637894657eb9fd2e84d) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-10-21toaster-manual: Updated the json file example bits to be currentScott Rifenbark
Fixes [YOCTO #8428] (From yocto-docs rev: d719f76c6fb3d33b4633d2d64d448bf225af3298) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-10-21ref-manual: Updated the image-swab.bbclass descriptionJohn Maxin
Fixes [YOCTO #8439] The "image-swab" class depends on "strace" package being on the build host. I added that fact to the note where we say the class is not maintained. (From yocto-docs rev: 503f4199b3c0bcfcd333dbab025b40f9508a6820) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-10-21toaster-manual: New section on PREFERRED_VERSIONScott Rifenbark
Added a new section in the interface use area that describes how to build a version of a recipe that is not the default version. Four new figures were added to support the description. (From yocto-docs rev: 232a875fb8fff97ce0578cf50b2a102bdaed1758) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-10-21ref-manual: Added many new class descriptions.Scott Rifenbark
Fixes [YOCTO #8298] (From yocto-docs rev: bff0119d2e13922cdd7b0772f6ed4ff74afe3c26) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-10-21toaster-manual: Added note for creating virtual environmentScott Rifenbark
Added a note strongly suggesting that the user should set up this virtual environment even though it is not required. (From yocto-docs rev: 1e5f5c7e36eb8541d0d0e2c7e5d37d65c84946bf) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-10-21toaster-manual: Updates to example toasterconf.json fileScott Rifenbark
Fixes [YOCTO #8428] The changes to the .json file are now shown in the documentation. (From yocto-docs rev: 5636632f0a2f0d79d632c72037c4306cfad3ec75) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-10-21dev-manual: Added CentOS packages to enable runtime tests on QEMUScott Rifenbark
Fixes [YOCTO #8412] Forgot about CentOS. I have added that item in. (From yocto-docs rev: f298ef74d7366ef01b9b1efcf5b0824a6e1aa742) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-10-21adt-manual: Fixed PMS typoScott Rifenbark
Fixes [YOCTO #8419] There was a typo in the section that indicated the file extensions for various Package Management Systems. The one for RPM used a file extension of ".rms". I fixed it to ".rpm". (From yocto-docs rev: 7b303a789d4f11aed6ebc83d734a27442a531b52) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-10-21ref-manual: Updates to clarify Fetcher URL directory parametersScott Rifenbark
Updated the SRC_URI variable description to cross-reference the "Fetchers" section in the BitBake User Manual and added some more Fetcher URL parameters specific to certain fetchers. This was done to help clarify how to put fetched code into specific directories. Also updated the bin_packages.bbclass description to have a better example. Used a git:// fetcher example and provided some specific URL parameters. (From yocto-docs rev: 7133b49092096c253ffce99f39d4fa6db7810061) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-10-21toaster-manual: Updated the section for setting up virtual env.Scott Rifenbark
The section for setting up a Python virtual environment has gone from "optional" to "required". I re-worded the section as such. (From yocto-docs rev: 3a20244c8b0b594723c0b35c8808bb96a210d63a) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-10-21dev-manual: Added package requirements for runtime QEMU testingScott Rifenbark
Fixes [YOCTO #8412] Added another bullet item that lists the required packages per distributions needed to enable the runtime QEMU tests. (From yocto-docs rev: f7e42f9b069e0fd3b419b571554669a89bc843e6) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-10-21ref-manual: Added linuxloader.bbclass reference description.Scott Rifenbark
(From yocto-docs rev: f33dbbd740ddd9dc88154373dc824e63d832ca0c) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-10-21Makefile: Updated the make file to not create toaster-manual pdfScott Rifenbark
(From yocto-docs rev: a9babbc10603a2dd984fb633e85f3b3d93e43ac7) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-10-21dev-manual: Updated devtool build --help exampleMaciej Borzecki
The wrong command was in the help example in the note. (From yocto-docs rev: a1ba70d1dcc680c2ddfb8fd5c544f57a29745cbc) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-10-21documentation: Updated files to support 2.0 release.Scott Rifenbark
These updates included editing the poky.ent file so that DISTRO and related variables are now 2.0. Also updated all the title pages to have the manual revision table correct. Finally, used my email for the manuals. (From yocto-docs rev: deae61bfbb528ea0ced82399a78260a7f34a7a11) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-10-21toaster-manual: Removed "dizzy" and replaced with "jethro"Scott Rifenbark
(From yocto-docs rev: 3cae958e49c091b2820631fc500171bb068eabf5) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-10-21ref-manual: Added descriptions for 5 new variables and 2 tasks.Scott Rifenbark
Fixes [YOCTO #8019] Added new descriptions for five kernel variables and two tasks. (From yocto-docs rev: 834aebb75dce1c905b1e0f142d0d7de6bb44e7d4) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-10-21dev-manual: Updated the Marking Packages information.Scott Rifenbark
Fixes [YOCTO #8375] Applied some suggested simpler wording for this bulleted item of information. Also, did some paragraph editing for better organization. (From yocto-docs rev: fd3e277b01ed6fd3580a1c008b1ac05bcfb98f38) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-10-21ref-manual: Added oe-seltest package requirements sections.Scott Rifenbark
Running oe-selftest requires some Python packages for all the supported distros. I added new sections in there to cover these requirements. Fixes [YOCTO #8290] (From yocto-docs rev: a8654267405df9ffb2f4d59d3de4a7eb3653893e) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-10-21adt-manual: Updated the build toolchain section with more detail.Scott Rifenbark
Fixes [YOCTO #8368] Apparently there is confusion on how to build a cross-toolchain using Eclipse and the Yocto plug-in. Specifically on setting the MACHINE variable, the bblayers.conf stuff, and the preferences in Eclipse to find things. I added a couple key things to the section that describes using the OpenEmbedded build system to build out the toolchain. (From yocto-docs rev: 68c399e2560600cb3a5951c93d51e2cf1f610ff9) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-10-21adt-manual: Updated some hard-coded distro valuesScott Rifenbark
I found four occurances of "1.8" used in manual. These needed to be set to "&DISTRO;" so that they resolve to the latest YP release. (From yocto-docs rev: 9db8a2a04085623588e51740a45ee58c500649f6) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-10-21dev-manual: Updated the multilib example.Scott Rifenbark
Fixes [YOCTO #8256] Applied some review comments to the multilib example. The syntax was incorrect. (From yocto-docs rev: 4e8abf17374535be3b168525ed2bec66fb1ce759) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-10-21ref-manual: Updated the EXCLUDE_FROM_SHLIBS descriptionScott Rifenbark
Fixes [YOCTO #8066] Applied some review comments to the variable's description. (From yocto-docs rev: 35b28f3b86cdb76ae3dc431b5f538b4d078b694f) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-10-21ref-manual: Updated EXCLUDE_FROM_SHLIBS description.Scott Rifenbark
Fixes [YOCTO #8066] Applied some review edits to the variable's description in the glossary. Also, changed the name of the variable to be correct. (From yocto-docs rev: f3ab503301db9d22cb85da0f7518d266f230bd3d) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-10-21ref-manual: Updated distrodata.bbclass exampleScott Rifenbark
Fixes [YOCTO #8237] The use of this class no longer requires including the laundry list of files that was provided in the section. It just needs the INHERIT statement now. Removed the include statements. (From yocto-docs rev: c31a5a3a78d265dea68c1c72c4eea6c2f80c839a) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-10-21ref-manual: Added new description for PACKAGE_EXCLUDE_COMPLEMENTARYScott Rifenbark
Fixes [YOCTO #7906] I added a new description for the variable. (From yocto-docs rev: 2a99b80abeee05a11aba9ab339d989a7d616b597) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-10-21dev-manual: Fixed typo in path for wic pluginsUwe Kleine-Konig
Fixes [YOCTO #7910] Three occurrances of this typo were fixed. (From yocto-docs rev: f538137c93d4b34c6d5836d9b21b687fb79ae182) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-10-21ref-manual: Added new EXCLUDE_FROM_SHLIB variableScott Rifenbark
Fixes [YOCTO #8066] Added a new description to the variable glossary. (From yocto-docs rev: ccb23c5a318f1640718ed41dc7ea2fd1bb8a43a1) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-10-21ref-manual: Added new variable description for SKIP_FILEDEPSScott Rifenbark
Fixes [YOCTO #8067] Added a new file description. (From yocto-docs rev: 9c60c6157660be6557732bbdc2398e2783ac68d2) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-10-21yocto-project-qs, ref-manual: Replaced "yum" with "dnf"Scott Rifenbark
Fixes [YOCTO #8159] Fedora and CentOS have deprecated "yum" and have come up with "dnf" as the package manager. This happened at the end of 2014. I have replaced the occurrences in the manual appropritely. (From yocto-docs rev: 14c80ecc8d6a4f9bf355dd84657d339782da83f0) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-10-21ref-manual: Added cross-reference phrase to some variablesScott Rifenbark
Fixes [YOCTO #8233] The IMAGE_POSTPROCESS_COMMAND and IMAGE_PREPROCESS_COMMAND variables were missing a linked cross-reference to the IMAGE_ROOTFS variable. I added the linked references. (From yocto-docs rev: a36b447ca105b3d63b7cfd085c77b071275e0dab) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-10-21dev-manual: Changed multilib exampleScott Rifenbark
Fixes [YOCTO #8256] The suggested multilib example in the "Using Multilib" section was broken. I replaced the lib32-connman library with the lib32-glib-2.0 library. (From yocto-docs rev: fa302dd1b7d71c880815fdc4b9a6764c095d476d) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-10-21dev-manual: Added note about building out Autotools projectsScott Rifenbark
Fixes [YOCTO #8261] Errors are being generated to Eclipse users when building an Autotools project. I added a note with steps to avoid the errors. (From yocto-docs rev: 7b915bab1b8a321f81453ad00886945c294a1d60) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-07-28ref-manual: New description for KERNEL_CLASSES variable.Ross Burton
(From yocto-docs rev: 9bb5b40cdcb2f41f59758fb29fddba9103109934) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-07-28dev-manual: Applied review edits to devtool section.Scott Rifenbark
(From yocto-docs rev: 2b04710ccb1c63c4dafc2abbb79f5a7feddf43e9) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-07-28poky.ent: Added "findutils" and "which" packages to Fedora essentials.Scott Rifenbark
(From yocto-docs rev: c025721df30b85518fe62f47c1e6e2fc2453d6d2) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-07-28kernel-dev: Added 'make defconfig' details for own source workScott Rifenbark
I added some detail about what really happens when you use the 'make defconfig' command when working with your own sources. Fixes [YOCTO #6611] (From yocto-docs rev: 653c7726e024dcaa908127f0df1d1856f26f4ff0) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-07-28dev-manual: Added a "biosfilename" item to the runqemu command section.Leonardo Sandoval
Poky's commit edde3e58da00adf9ef3a8cc687268f6e24294c7c included the biosfilename option on the runqemu script. (From yocto-docs rev: 3c834547ace29c14bce6afa0369a727f3afbd650) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-07-28ref-manual: Added glossary description for BB_ALLOWED_NETWORKS.Scott Rifenbark
Added a new description. (From yocto-docs rev: e17fe8da8a9d2cbca54dd45451b35103d7d89fa0) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-07-28yocto-project-qs and others: Rewrite of the QSScott Rifenbark
This was a complete re-write of the YP Quick Start in an attempt to streamline it, remove unecessary detail, and make it flow better with the examples. In doing so, many manuals were affected due to section headings being renamed, information being moved, etc. Here is a list of the changes by manual: Makefile - Removed two figures from TARFILE list for the yocto-project-qs. Added building-an-image.png to the ref-manual TARFILE list. Added using-a-pre-build-image.png to the adt-manual TARFILE list. Repositioned 'eclipse' in the adt-manual TARFILE list. adt-manual: Fixed a cross-reference so that it goes to the new 'Building Images' section that is within the YP QS. Added new section 'Example Using Pre-Build Binaries and QEMU' to hold the information that was formerly in YP QS. dev-manual: Removed a cross-reference into the YP QS that promised how to configure the most efficent build. Changed a cross-reference into the YP QS from 'The Packages' to 'The Build System Packages'. Changed a cross-reference into the YP QS from 'Building an Image' to 'Building Images'. Changed a text reference from the YP QS to the adt-manual. Moved the bit about getting YP files by using the YP website from the YP QS to the dev-manual. Changed a cross-reference into the YP QS from 'Using Pre-Built Binaries and QEMU' to 'Example Using Pre-built Binaries and QEMU', which was moved to the adt-manual. ref-manual: Changed a cross-reference into the YP QS from 'What You Need and How You Get It' to 'Setting Up to Use the Yocto Project'. Moved the note about if your system has oss4-dev in the packages area in the YP QS to the appropriate area in the ref-manual. Moved the introduction information regarding building an image along with the figure from YP QS to the ref-manual's section on building images. toaster-manual: Changed a cross-reference into the YP QS from 'What You Need and How You Get It' to 'Setting Up to Use the Yocto Project'. yocto-project-qs: Complete rewrite that changed many section headings and removed much detail, which was placed in other manuals. (From yocto-docs rev: da4ed8147b04963a700caa784bda709c57b4eb6e) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>