summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual
Commit message (Collapse)AuthorAgeFilesLines
* manuals: Update YP manual notes with pointer to docs MLRobert P. J. Day2020-03-111-6/+8
| | | | | | | | | | Update the "Manual Notes" section of numerous YP manuals with a reference to the recently-introduced YP documentation mailing list. (From yocto-docs rev: a10fe36c864b8f1a71c6a8eb7e1f6a4eef2f5171) Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: Updates to reflect that MACHINE defaults to qemux86-64Mark Asselstine2020-03-111-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | meta-yocto commit 69ddecdb1516 [local.conf.sample: change default MACHINE to qemux86-64] switched the default MACHINE from 'qemux86' to 'qemux86-64' but some documents which either explicitly mentioned the default, or where this was implicit didn't receive an equivalent update. Where it made sense we continue this change in default to the docs. In other places, such as the kernel-dev manual, we note the new default and instruct the user how to switch back to 'qemux86'. Eventually we should probably update the kernel-dev manual to use the default, but for now the intention was to limit the impact of these changes. Note that ext3 has also been replaced with ext4 for image generation, so while we are modifying runqemu lines to qemux86-64 we also make the change to reference ext4 such that the runqemu commands will function properly. (From yocto-docs rev: 8c1d8ab1170f47a2c2692beb903ab0b7c6835b7b) Signed-off-by: Mark Asselstine <mark.asselstine@windriver.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Add a tips on how to achieve whitelisting of licensesPeter Kjellerstedt2020-03-111-0/+19
| | | | | | | | | | | | It is sometimes more appropriate to define the licenses that are allowed to be used rather than the ones that are not permitted. This adds a tips on how this can be achieved by using AVAILABLE_LICENSES and some Python set arithmetics. (From yocto-docs rev: dd26d8a9f89402a9828bf02f2e65054d4c0f406f) Signed-off-by: Peter Kjellerstedt <peter.kjellerstedt@axis.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Add a variable description for AVAILABLE_LICENSESPeter Kjellerstedt2020-03-111-0/+24
| | | | | | | (From yocto-docs rev: 275ea2bb30693315ebea659a82065b75066e13b6) Signed-off-by: Peter Kjellerstedt <peter.kjellerstedt@axis.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Update the documentation for USERADD_ERROR_DYNAMICPeter Kjellerstedt2020-03-111-8/+25
| | | | | | | | | | | | | | * Update USERADD_ERROR_DYNAMIC[doc] and the first paragraph to match the definition in meta/conf/documentation.conf. * Add a note explaining the differences in behavior when setting USERADD_ERROR_DYNAMIC to "warn" and "error" respectively. [YOCTO #12932] (From yocto-docs rev: 28cd546f3fe1eadd73ba71f9fe9a558538e69b0f) Signed-off-by: Peter Kjellerstedt <peter.kjellerstedt@axis.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Add missing/remove extraneous quotesPeter Kjellerstedt2020-03-112-13/+11
| | | | | | | (From yocto-docs rev: 542e362bf06c2d71ee6e30f5728ad5476f035c6e) Signed-off-by: Peter Kjellerstedt <peter.kjellerstedt@axis.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: The sanity_info file has moved from build/conf to build/cachePeter Kjellerstedt2020-03-111-1/+1
| | | | | | | (From yocto-docs rev: 813dd1a2ce48df08b92d821700380d5d231e6760) Signed-off-by: Peter Kjellerstedt <peter.kjellerstedt@axis.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* YP 3.1 Docs: Updated Manual revision tables.Scott Rifenbark2019-12-161-15/+5
| | | | | | | | | | Scrubbed so subsequent releases are relevant to the initial release only. (From yocto-docs rev: 7bb2c4f851aa968eb05b11c5471b81962f268eba) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* YP Documentation: Set up for YP 3.1 releaseScott Rifenbark2019-12-091-1/+6
| | | | | | | | | | | * Updates to poky.ent * Updates to mega-manual.sed * Updates to all <manual>.xml files for date (From yocto-docs rev: 5f752ef0193cb60cd5d46a63e99ffcd02107e0c2) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Removed blank lines from 3.0 migratrion section.Scott Rifenbark2019-11-101-46/+0
| | | | | | | (From yocto-docs rev: a3c4701e0b6fc90aaa7138c1fd772e0d8ad7e3a6) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Completed the 3.0 migration section.Scott Rifenbark2019-11-101-29/+476
| | | | | | | (From yocto-docs rev: 1f996ce595b91e2dba55bdeeb2a558eb8a16c195) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual, dev-manual: Added CMake toolchain files.Scott Rifenbark2019-10-231-0/+8
| | | | | | | | | | | | | | | 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>
* ref-manual: Updated the BUSYBOX_SPLIT_SUID variable.Scott Rifenbark2019-10-231-2/+3
| | | | | | | | | 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>
* ref-manual, dev-manual: Clean up of a commitScott Rifenbark2019-10-231-2/+2
| | | | | | | | | | | | | 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>
* ref-manual: Removed deprecated link to ref-classes-bluetoothScott Rifenbark2019-10-231-4/+3
| | | | | | | | | 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>
* documenation: Changed "2.8" to "3.0".Scott Rifenbark2019-10-231-2/+2
| | | | | | | | | | 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>
* ref-manual: 2nd pass 3.0 migrationScott Rifenbark2019-10-231-11/+11
| | | | | | | | | | 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>
* ref-manual: First pass of 2.8 migration changes (WIP)Scott Rifenbark2019-10-231-0/+98
| | | | | | | (From yocto-docs rev: 2c0f6cd921132caa4f49c34ac592db68be27761a) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-system-requirements: update support distribution listRoss Burton2019-10-091-50/+4
| | | | | | | | | | | | | 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>
* documentation: Update multiconfig syntax and explanation on BBMULTICONFIGAlejandro Enedino Hernandez Samaniego2019-10-091-2/+2
| | | | | | | | | | | | | | | | 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>
* ref-manual: Remove documentation for the removed gnome classAdrian Bunk2019-09-101-15/+0
| | | | | | | | | | | | | | 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>
* ref-system-requirements: add Debian 10 to supported distribution listRoss Burton2019-09-101-0/+1
| | | | | | | | | 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>
* ref-manual: Remove documentation for the removed bluez5 distro featureAdrian Bunk2019-09-102-38/+0
| | | | | | | | | | | | | | | | 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>
* ref-manual: sync list of image types with sourceScott Rifenbark2019-09-061-1/+3
| | | | | | | (From yocto-docs rev: fc2817a4ca75efcb556c84ba5c6edcb4d703a78f) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* Update to KERNEL_DEVICETREE variable.Adrian Bunk2019-09-061-9/+3
| | | | | | | | | | 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>
* ref-manual: Updates to "Building Your Recipe"Scott Rifenbark2019-09-061-6/+6
| | | | | | | (From yocto-docs rev: 6aa1fe818c284c1d740ce8063d58c664e73d380d) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated the "AS" variableScott Rifenbark2019-09-061-1/+1
| | | | | | | (From yocto-docs rev: ebd659999da3c465e1dbe3fb07d5eedbb6ff4c8f) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Removed "python2" mention in example.Scott Rifenbark2019-07-181-2/+1
| | | | | | | | | | | 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>
* ref-manual: Fixed typo for BBMULTICONFIG variable.Scott Rifenbark2019-07-181-1/+1
| | | | | | | | | | 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>
* ref-manual: Updated "npm.bbclass" section.Scott Rifenbark2019-06-181-2/+5
| | | | | | | | | | | 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>
* ref-manual: Grammar correctionScott Rifenbark2019-06-071-1/+1
| | | | | | | | | | | | 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>
* ref-manual: Updates to check-recipe-upgrade devtool commandScott Rifenbark2019-06-071-6/+43
| | | | | | | | | | 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>
* ref-manual: do_checkpkg - added link to checking upgrade statusScott Rifenbark2019-06-071-0/+3
| | | | | | | | | | | | 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>
* ref-manual: New section "Checking Upgrade Status of a Recipe"Scott Rifenbark2019-06-071-0/+72
| | | | | | | | | | | | | | 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>
* ref-manual: Udated devtool help output examples.Scott Rifenbark2019-06-071-36/+34
| | | | | | | | | | 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>
* ref-manual: Removed "distutils-tools" class.Scott Rifenbark2019-06-071-5/+0
| | | | | | | | | | 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>
* ref-manual: Removed bugzilla.bbclassScott Rifenbark2019-06-071-12/+0
| | | | | | | | | | 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>
* dev-manual, ref-manual: removed "distrodata" classScott Rifenbark2019-06-074-81/+20
| | | | | | | | | | | 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>
* ref-manual: Updated "do_fetch" to have a link to "Fetchers"Scott Rifenbark2019-06-071-1/+2
| | | | | | | | | | | | 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>
* ref-manual: Remove irda featureAdrian Bunk2019-06-071-4/+0
| | | | | | | | | | 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>
* ref-manual: Added "npm" information to the SRC_URI variable.Scott Rifenbark2019-05-151-0/+3
| | | | | | | (From yocto-docs rev: 644cf94333ef289e9d0719f46b76f712f4807573) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated PREFERRED_VERSION variable to use 5.0Scott Rifenbark2019-05-121-3/+3
| | | | | | | | | | 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>
* documentation: Cleaned up "plug-in"/"plugin" terminology.Scott Rifenbark2019-05-072-10/+10
| | | | | | | | | | | | | | 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>
* ref-manual: Updated the "Container Layer" term.Scott Rifenbark2019-05-071-10/+5
| | | | | | | | | | | 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>
* documentation: Prepared for 2.8 releaseScott Rifenbark2019-05-071-1/+6
| | | | | | | | | | | 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>
* ref-manual: Review comments applied to 2.7 migration section.Scott Rifenbark2019-05-071-33/+43
| | | | | | | (From yocto-docs rev: 81ced4c68631d4d63efec206e5453b00d8fcc786) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added Fedora 29 to the supported distros list.Scott Rifenbark2019-05-071-0/+1
| | | | | | | (From yocto-docs rev: 196bc35669e81b269d4576f552bdecc191bbc80a) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added "License Value Corrections to migration.Scott Rifenbark2019-05-071-12/+41
| | | | | | | (From yocto-docs rev: 398a60005b9ce63e6ee141dfb8a71e8ae2bf2d86) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added Eclipse removal for migration section.Scott Rifenbark2019-05-071-0/+11
| | | | | | | (From yocto-docs rev: 06409e5fa0080f76f68d9f98b3c9f5a4edfcc948) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Inserted Migration 2.7 section.Scott Rifenbark2019-05-071-0/+224
| | | | | | | (From yocto-docs rev: 238ddd62995420741c2b97ccfa7d2c533b72837c) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
generated by cgit v1.2.3-54-g00ecf (git 2.39.0) at 2024-05-11 16:53:18 +0000