summaryrefslogtreecommitdiffstats
path: root/documentation
AgeCommit message (Collapse)Author
2019-09-10ref-manual: Remove documentation for the removed gnome classAdrian Bunk
When removed all it did was inherit gnomebase gtk-icon-cache gconf mime which would also be the most trivial replacement. Most of the time not all of these classes were needed, and it is recommended to use only the ones actually required. (From yocto-docs rev: a0a3a8318a1488ad2fb00b29f1cf26a9d6701be2) Signed-off-by: Adrian Bunk <bunk@stusta.de> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-09-10ref-system-requirements: add Debian 10 to supported distribution listRoss Burton
Debian 10 is a supported distribution now, so add it to the documentation. (From yocto-docs rev: 77ff109cf7dbe1858e9959c4b9f1225d0a1c5e32) Signed-off-by: Ross Burton <ross.burton@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-09-10ref-manual: Remove documentation for the removed bluez5 distro featureAdrian Bunk
bluez4 was removed even from meta-oe 2 years ago, which made made the bluez5 feature for selecting between bluez4 and bluez5 mandatory for using the bluetooth feature. The backfilled bluez5 feature has been removed, including the bluetooth class that helped recipes for selecting between bluez4/bluez5. Recipes can replace ${BLUEZ} with bluez5. (From yocto-docs rev: 025e2b5797b987b0260d7410e2e6d7283f5a7e91) Signed-off-by: Adrian Bunk <bunk@stusta.de> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-09-06ref-manual: sync list of image types with sourceScott Rifenbark
(From yocto-docs rev: fc2817a4ca75efcb556c84ba5c6edcb4d703a78f) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-09-06poky-end: Added "pylint3" package to Ubuntu essentials.Scott Rifenbark
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-09-06Update to KERNEL_DEVICETREE variable.Adrian Bunk
Corrected the requirements for the KERNEL_DEVCIETREE variable example. (From yocto-docs rev: 0502910c81f4d669457155ed5f52d5fa775d8d6d) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-09-06dev-manual: Updated "Creating a Team Development Environment"Scott Rifenbark
This section needed the wording updated. (From yocto-docs rev: dd9e09273e9e5d5b6b43bf508f50d4d57e0dc569) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-09-06ref-manual: Updates to "Building Your Recipe"Scott Rifenbark
(From yocto-docs rev: 6aa1fe818c284c1d740ce8063d58c664e73d380d) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-09-06ref-manual: Updated the "AS" variableScott Rifenbark
(From yocto-docs rev: ebd659999da3c465e1dbe3fb07d5eedbb6ff4c8f) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-07-18ref-manual: Removed "python2" mention in example.Scott Rifenbark
We are not using Python2. I removed this instance in the ref manual. The variable "PYTHON_PN" referenced Python 2. It no longer does. (From yocto-docs rev: bd2ed0c640e12e8010ebff0aaba77e8fe367d63e) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-07-18ref-manual: Fixed typo for BBMULTICONFIG variable.Scott Rifenbark
There was a typo in the BBMULTICONFIG variable description. It appeared as "BBMULTIFONFIG". I fixed it. (From yocto-docs rev: c53b1bb6e588f9ee87cb8ab85fc8c3985257a37a) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-07-18dev-manual: Provided proper link titleScott Rifenbark
In the "Enabling GObject Introspection Support" section, a link existed to the "Known Issues" section further down in the chapter. The target of the link was missing and appeared as the placeholder "xxx". I put in the proper link. (From yocto-docs rev: 8d0d1b2104f08e888075bc0ae0bed4f0ec2f4ea6) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-07-18sdk-manual: Updated devtool to talk about oe-local-files.Scott Rifenbark
Fixes YOCTO #13079 Bug is about making sure the section on the devtool command talks about oe-local-files. Two devtool commands (modify and upgrade) needed to mention the role of the oe-local-files area and how it is used during these commands. I updated the appropriate sections: * Use devtool modify to Modify the Source of an Existing Component * Use devtool upgrade to Create a Version of the Recipe that Supports a Newer Version of the Software. (From yocto-docs rev: 70ed68eca6dcb5b1f1b5638fd27a7b513b65661e) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-07-18overview-manual: Fixed manual history tableScott Rifenbark
Missing information for some of the releases put back in. (From yocto-docs rev: f4c09ab9eda925c16946d9d6cf58d1e40d8f6a07) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-06-18dev-manual: Fixed grammar issue.Scott Rifenbark
Fixed in "Selecting an Initialization Manager" section. Extraneous word needed removed. (From yocto-docs rev: ab97d36299a7a648bc3f3325175d8ab633ad2d1a) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-06-18overview-manual: Updated SCM sectionScott Rifenbark
Fixes [YOCTO #10098] I updated the "Source Control Managers (Optional)" section to reference the "Fetchers" section in the BB manuual. (From yocto-docs rev: 0c014fba509d3ec28236e63a7bd2355b447c4acf) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-06-18ref-manual: Updated "npm.bbclass" section.Scott Rifenbark
I provided a general link to the wiki on npm software. Also, updated the section to point to the new section on how to create NPM packages, which is in the dev-manual. (From yocto-docs rev: 03fd635d06d64a53ad00196919350a45942731ce) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-06-18dev-manual: Updated the "Working with Packages" listScott Rifenbark
I added the "Creating node package manager (NPM) packages section link to the list. Also, made some edits to make the capitalization consistent in the list items. (From yocto-docs rev: d3e345cd3f44e9588c5fe8f0560e1859df0ff496) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-06-18Makefile: Updated to support new NPM package creation sectionScott Rifenbark
The newly created section on how to create NPM packages required a figure. I added the figure to both the dev-manual and mega-manual tarballs creation areas. (From yocto-docs rev: 5109274d107b6d3ae6be3f71a20379cb6abb39d6) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-06-18dev-manual: Added new section for creating NPM packagesScott Rifenbark
Fixes [YOCTO #10098] This is a new section in the development tasks manual that describes how to create Node Package Manager (NPM) packages. I put the section in the "Working with Packages" section. (From yocto-docs rev: d7acd9f27418d414854d25bb27842407edfe7dda) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-06-07ref-manual: Grammar correctionScott Rifenbark
I left out the word "not" in a key sentence in the new "Checking on the Upgrade Status of a Recipe" section. Little words can make big differences. (From yocto-docs rev: 46a524a0d6c9e2ed6428039a4454e384a6ef648d) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-06-07ref-manual: Updates to check-recipe-upgrade devtool commandScott Rifenbark
I updated the section to include more detail on what the user sees in the returned table. (From yocto-docs rev: 671279548dde7f356888ba1ad1551b8bb1f70a65) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-06-07ref-manual: do_checkpkg - added link to checking upgrade statusScott Rifenbark
I show the "devtool check-upgrade-status" command as part of the "do_checkpkg" task section. I added a cross-reference link to the "Checking on the Upgrade Status of a Recipe" section in the ref-manual. (From yocto-docs rev: 034054f431cc9f0e61c8e156eed66bdf6e1198a1) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-06-07dev-manual: Added check-upgrade-status blurb to upgrading recipesScott Rifenbark
The section "Upgrading Recipes" covers several ways of upgrading a recipe. I added some stuff in the introductory area that mentions the fact a user might want to check the upgrade status of a recipe first. (From yocto-docs rev: bd2fd8d0a91b64455c282ebf4974e40874274f46) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-06-07ref-manual: New section "Checking Upgrade Status of a Recipe"Scott Rifenbark
I added a new section showcasing the "devtool check-upgrade-status" command. Also, added a note in the "Upgrading a Recipe" section" to tell the reader they might want to check on a recipe's upgrade status before upgrading a recipe. (From yocto-docs rev: 974f63fe8836fccd51f12b511c23644235cbd4b4) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-06-07ref-manual: Udated devtool help output examples.Scott Rifenbark
Specifically missing was the "devtool check-upgrade-status" command. (From yocto-docs rev: beaa40e8d1037f237ab588ec6ce256b8c3a18543) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-06-07ref-manual: Removed "distutils-tools" class.Scott Rifenbark
This class was removed for 2.7 and I took the reference section out of the class area. (From yocto-docs rev: daf786bebb0286d2ced46c97957d80a94c921c56) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-06-07ref-manual: Removed bugzilla.bbclassScott Rifenbark
The migration section noted this class as becoming obsolete. I removed it from the class reference section. (From yocto-docs rev: 63128888242493fb5671f11a2e5e470f2da6b22a) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-06-07dev-manual, ref-manual: removed "distrodata" classScott Rifenbark
Ousted these since it was noted in the migration section that the class had been removed. Modified all references to the removed class as needed. (From yocto-docs rev: 7000acc76da6b7ee850b799347ab9083663c7e6a) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-06-07ref-manual: Updated "do_fetch" to have a link to "Fetchers"Scott Rifenbark
Fixes [YOCTO #10098] This task needed to cross-reference the "Fetchers" section, which is in the BitBake User Manual. (From yocto-docs rev: c8862f4c8cc43777acead0e93fc728f2e8be4641) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-06-07sdk-manual: Added link to BB manual fetcher section.Scott Rifenbark
In the "Use devtool upgrade to Create a Version of the Recipe that Supports a Newer Version of the Software" section, we reference "fetchers" but do not link to the section on them in the BB manual. I added a link. (From yocto-docs rev: 633ac78daa2ab3bdde17ecb1a203f6addd6ee4af) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-06-07ref-manual: Remove irda featureAdrian Bunk
IrDA support was removed in upstream kernel 4.17, and irda-utils as well as the feature are now also removed. (From yocto-docs rev: 5650b3c733310b4d478440449d427de417946c81) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-05-15ref-manual: Added "npm" information to the SRC_URI variable.Scott Rifenbark
(From yocto-docs rev: 644cf94333ef289e9d0719f46b76f712f4807573) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-05-15overview-manual: Updated SMC section to link to fetchersScott Rifenbark
Fixes [YOCTO #10098] I did some re-writing here and also linked over to the "Fetchers" section, which is in the BitBake User Manual. (From yocto-docs rev: a2ba04bcf13dd1c68cba5a79ae9e7d4c8fbcdf59) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-05-12dev-manual: Added cross-link to "Fetchers" section in BB manual.Scott Rifenbark
Fixes [YOCTO #10098] Inside the "Fetching Code" section we mention fetchers but have no links for more information to the "Fetchers" section in the BibBake User Manual. I have added a link. (From yocto-docs rev: 5224bb7b7a3c0f081b066a45865fd326aa068fc9) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-05-12bsp-guide: More corrections to the BSP Kernel Recipe exampleScott Rifenbark
After reading this over, I needed to explicitly state the *.bb and *.bbappend file names. It is clear now. (From yocto-docs rev: 901b76d9f94c33da15382068dc933d765cddade5) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-05-12ref-manual: Updated PREFERRED_VERSION variable to use 5.0Scott Rifenbark
I changed the PREFERRED_VERSION_linux-yocto example to use the 5.0 linux-yocto kernel rather than the 4.12 version. (From yocto-docs rev: 334554dd87f5372066d55246384ed5205aaf1f86) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-05-12bsp-guide: Updated the BSP kernel recipe example.Scott Rifenbark
There were some issues with this. The example stated using an append file and the file was actually named as a regular recipe file. I fixed that. Also, I updated the PREFERRED_VERSION_linux-yocto variable from "4.12" to "5.0" to be more up-to-date. (From yocto-docs rev: 933a668ef73b417587b4a8091b834db220611bd6) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-05-07documentation: Cleaned up "plug-in"/"plugin" terminology.Scott Rifenbark
The YP manual set was using the plugin term inconsistently. It was appearing as "plugin" as well as "plug-in". The plugins in the project are all named without a hyphen. The term itself is either/or according to Google. I have changed all references to plugin so that they do not use a hyphen. (From yocto-docs rev: 715bb58e2347c5e37a49da7d9e3e230503672337) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-05-07bsp-guide: Updated the "beaglebone-yocto.conf" example.Scott Rifenbark
This listing had gone stale. I updated the actual listing to match what is in poky repository and adjusted the various variable explanations affected. (From yocto-docs rev: 44ccb6ea7301ffa43c89f7a4f28265ea28725f99) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-05-07ref-manual: Updated the "Container Layer" term.Scott Rifenbark
I removed the incorrect "meta-intel" layer for the example and replaced it with the better "meta-openembedded" layer. Reported by: Robert P. J. Day <rpjday@crashcourse.ca> (From yocto-docs rev: eed35c97aa53efdcdb9a270555774a7c3a0e3b69) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-05-07bsp-guide: Removed inaccurate "container layer" references.Scott Rifenbark
I left only the single mention of "container layers" and changed the example from "meta-intel" to OpenEmbedded's meta-openembedded layer. Reported-by: Robert P. J. Day <rpjday@crashcourse.ca> (From yocto-docs rev: 8aa4de2be19c001f19cc540e2f7b33ca71f6be60) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-05-07documentation: Prepared for 2.8 releaseScott Rifenbark
poky.ent - variables all set up for 2.8 mega-manual.sed - "2.7" replaced with "2.8" <folder>.xml - manual revision history tables updated. (From yocto-docs rev: 6092a9282cbd397a2f64ca74361f862ea76b0e28) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-05-07ref-manual: Review comments applied to 2.7 migration section.Scott Rifenbark
(From yocto-docs rev: 81ced4c68631d4d63efec206e5453b00d8fcc786) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-05-07poky.ent: changed 2.7 release variable date to "May 2019"Scott Rifenbark
(From yocto-docs rev: 0c94c5c2c4300a9b91ab2be866d8781a79d2f62d) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-05-07ref-manual: Added Fedora 29 to the supported distros list.Scott Rifenbark
(From yocto-docs rev: 196bc35669e81b269d4576f552bdecc191bbc80a) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-05-07ref-manual: Added "License Value Corrections to migration.Scott Rifenbark
(From yocto-docs rev: 398a60005b9ce63e6ee141dfb8a71e8ae2bf2d86) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-05-07ref-manual: Added Eclipse removal for migration section.Scott Rifenbark
(From yocto-docs rev: 06409e5fa0080f76f68d9f98b3c9f5a4edfcc948) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-05-07ref-manual: Inserted Migration 2.7 section.Scott Rifenbark
(From yocto-docs rev: 238ddd62995420741c2b97ccfa7d2c533b72837c) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-05-07dev-manual: Added reasoning blurb to "Viewing Variables" section.Scott Rifenbark
I put a new introductory paragraph in the "Viewing Variables" section that alludes to why you might want to see variables. Also, I linked to the section "Modifying Variable Values" in the BB manual. (From yocto-docs rev: 6e18524ba62d2ff1231184467b0dd24dab33cfe6) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>