summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual
AgeCommit message (Collapse)Author
2020-08-16Documentation: Prepared for 3.0.4 releaseakuster
(From yocto-docs rev: 9f51be3a11b7422aba3617a90a98336c3c75f71e) Signed-off-by: Armin Kuster <akuster808@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-05-17Documentation: Prepared for 3.0.3 releaseakuster
(From yocto-docs rev: 9d522e747d2715aa0b2fe4c81cacc34bfad3e1a3) Signed-off-by: Armin Kuster <akuster808@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2020-02-06Documentation: Prepared for 3.0.2 releaseakuster
Add release date for 3.0.2. (From yocto-docs rev: ac75b463b23ae6258c1e6f3bbdefc398f3a03d43) Signed-off-by: Armin Kuster <akuster808@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-12-16YP 3.0.1 Docs: Fixed manual revision tables.Scott Rifenbark
I had a duplicate "October 2019" release in the dev-manual. Also, I forgot the year for the "October 2019" release entry. (From yocto-docs rev: 1d2a6d6c4d0f283dcf2627c9494b204859edd340) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-12-09YP 3.0.1 Documentation: Set up the 3.0.1 release.Scott Rifenbark
* Updated poky.ent * Updated mega-manual.sed * Updated <manual>.xml with release date (From yocto-docs rev: 6418138ce8d9f2fa1e3d4ef10ec6187584d15f2c) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-11-10ref-manual: Added 3.0 migration section.Scott Rifenbark
(From yocto-docs rev: c247f87e657cb63c8fd6a79b38ad66affe8c52a7) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-10-23ref-manual, dev-manual: Added CMake toolchain files.Scott Rifenbark
Fixes [YOCTO #12760] Updated the cmake.bbclass description to tell what directory to insall custom CMake toolchain files into. Also, updated the two areas in the "Writing a New Recipe" section that mention CMake. Placed a couple notes there concerning the same directory stuff. (From yocto-docs rev: a65cd2c4c062d4ae388191b9d6708b4fadffaa3f) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-10-23ref-manual: Updated the BUSYBOX_SPLIT_SUID variable.Scott Rifenbark
Fixes [YOCTO #13596] (From yocto-docs rev: 015991b26ed091385cfb94f13e00c6a964c20160) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-10-23ref-manual, dev-manual: Clean up of a commitScott Rifenbark
Alejandro Enedino Hernandez Samaniego <aehs29@gmail.com> commited a change to these manuals (see 9e79e96cad66316c1b4ee608723edfa763f0f9ef) and did not use YP documentation standards for the content. I cleaned up the text and tabbing. (From yocto-docs rev: 9c95799322e1830a5faae0980384ab10b6504007) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-10-23ref-manual: Removed deprecated link to ref-classes-bluetoothScott Rifenbark
This was in a moving to YP version 1.8 migration section. (From yocto-docs rev: b87f0882c39524747004fafc4d1caf58b3344c3a) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-10-23documenation: Changed "2.8" to "3.0".Scott Rifenbark
I was using "2.8" throughout the manual set instead of "3.0". Updated all aspects to "3.0". (From yocto-docs rev: db19937e98c59d4d2a9ce89877be3c8e0b05991a) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-10-23ref-manual: 2nd pass 3.0 migrationScott Rifenbark
Turned "2.8" into "3.0". Nobody told me about skipping 2.8 and 2.9. (From yocto-docs rev: 13819f0651c48adae9d1a8d6d19341ba5ee44978) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-10-23ref-manual: First pass of 2.8 migration changes (WIP)Scott Rifenbark
(From yocto-docs rev: 2c0f6cd921132caa4f49c34ac592db68be27761a) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-10-09ref-system-requirements: update support distribution listRoss Burton
Add Fedora 30 and Ubuntu 19.04. Swap openSUSE 42.3 for Leap 15.1. Remove huge comment of old distributions. (From yocto-docs rev: 8fe3040a68c0aee44c4a6dcd5088b61d6908b0f9) Signed-off-by: Ross Burton <ross.burton@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-10-09documentation: Update multiconfig syntax and explanation on BBMULTICONFIGAlejandro Enedino Hernandez Samaniego
The syntax to use multiconfig builds changed from multiconfig:foo:target to mc:foo:target. Clarify that BBMULTICONFIG defines additional configurations along with the one coming from local.conf. Fix these changes on both the dev manual and the reference manual. (From yocto-docs rev: 9e79e96cad66316c1b4ee608723edfa763f0f9ef) Signed-off-by: Alejandro Enedino Hernandez Samaniego <aehs29@gmail.com> 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 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-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-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-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-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-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-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-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-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-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-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-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-07ref-manual: Removed all references to EclipseScott Rifenbark
Links updated as needed. (From yocto-docs rev: acd5a75314b023f613be24b7512f991f8455e325) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-05-07Documentation: Removed customization.xsl files for EclipseScott Rifenbark
The help files for YP manuals used in the Eclipse application are no longer supported. I removed the individual *-customization.xsl files for the individual YP manuals. (From yocto-docs rev: 8c19244298b2c95ac92a398a5b6d3aca788f075e) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-04-09ref-manual: Updated BB_GENERATE_MIRROR_TARBALLSScott Rifenbark
Updated the description to tell the user they can safely clean up the DL_DIR after creating tarballs of the source files from downloaded repos. (From yocto-docs rev: 6aff69632ea3102b6389ea510e1e3fa5bf1c2123) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-03-26ref-manual: Removed DISK_DESCRIPTION variable from glossaryScott Rifenbark
(From yocto-docs rev: 0bc99a673376e70279a353f654287068c59a0b03) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2019-03-19ref-manual: Fixed SRC_URI cut-and-paste error.Filip Jareš
The update fixes a copy-paste-and-forget-to-update-everything error in the documentation of the `SRC_URI` entry in the Reference Manual. The `maxdate` paragraph just repeated what is there for the neighboring `mindate` paragraph which was incorrect. (From yocto-docs rev: bbeb096222d42a31adcb358a85f8fe6c4120416a) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>