summaryrefslogtreecommitdiffstats
path: root/documentation
Commit message (Collapse)AuthorAgeFilesLines
...
* ref-manual: Explain the project is not validated against WSL but people may ↵Alejandro Hernandez Samaniego2020-04-061-6/+9
| | | | | | | | | | still use it (From yocto-docs rev: c55378d8a5597b3760dd9aae766af735a61a6158) Signed-off-by: Alejandro Hernandez Samaniego <alejandro@enedino.org> Signed-off-by: Alejandro Hernandez Samaniego <alhe@linux.microsoft.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* yocto-docs: remove refrence to mpc8315e-rdbakuster2020-03-246-19/+1
| | | | | | | (From yocto-docs rev: 8768196b4a313df794bf21937da4bf92de858463) Signed-off-by: Armin Kuster <akuster808@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: add rpcgen tool to required packagesGoran Cengic2020-03-211-3/+3
| | | | | | | | | | | | | On recent distros the following error appears without rpcgen host tool: ERROR: The following required tools (as specified by HOSTTOOLS) appear to be unavailable in PATH, please install them in order to proceed: rpcgen (From yocto-docs rev: 66a491e77e1b97a831515d4ac8e0245540d7242a) Signed-off-by: Goran Cengic <cengic@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: Update YP manual notes with pointer to docs MLRobert P. J. Day2020-03-119-54/+72
| | | | | | | | | | 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>
* dev-manual: phrase should read "inherit packagegroup"Robert P. J. Day2020-03-111-1/+1
| | | | | | | (From yocto-docs rev: 446204632ac9e8de3ce0b22df6fa2bb7605b9bce) Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Remove python from UBUNTU_HOST_PACKAGES_ESSENTIALKhem Raj2020-03-111-1/+1
| | | | | | | | | | Ubuntu 20.04 doesn't have python package and therefore this list fails to install, python3 is required anyway so removing python is perhaps ok (From yocto-docs rev: a41567a4ee462c704a29ad5944a0c824d7eb840c) Signed-off-by: Khem Raj <raj.khem@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual-common-tasks: Fix runall referenceRichard Purdie2020-03-111-1/+1
| | | | | | | | [YOCTO #13715] (From yocto-docs rev: 91fbf02ae126bcabfeb43525db620bbd36d5f583) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: Updates to reflect that MACHINE defaults to qemux86-64Mark Asselstine2020-03-115-25/+29
| | | | | | | | | | | | | | | | | | | | | | | | 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>
* Adding memoriam to scottrifJefro2020-01-311-0/+5
| | | | | | | | | | Added a few comment lines in Makefile to commemorate Scott's contributions (From yocto-docs rev: 07c88e2724a223b26694c98c0e976d735aee00e6) Signed-off-by: Jefro <jefro@jefro.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Remove accidentally added filesRichard Purdie2020-01-073-832/+0
| | | | | | (From yocto-docs rev: 35f2ae3795a09bdee6d5dd0217f1f5091d8f1ecb) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* YP 3.1 Docs: Updated Manual revision tables.Scott Rifenbark2019-12-1612-59/+856
| | | | | | | | | | 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>
* poky.ent: Updated variables for YP 3.1Scott Rifenbark2019-12-161-5/+5
| | | | | | | (From yocto-docs rev: 28606ba4bd9994b854ebc790810dfdfb06538c55) 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-0911-42/+87
| | | | | | | | | | | * 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>
* dev-manual: Removed duplicate paragraph for selecting init manager.Scott Rifenbark2019-12-091-9/+0
| | | | | | | (From yocto-docs rev: d22e9762cc26b5f5454b446022ee308ffe90e1ef) 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>
* mega-manual: Updated mega-manual Bitbake manual search pathScott Rifenbark2019-11-101-6/+6
| | | | | | | | | | | using ../.. instead of ../../.. Fixes [YOCTO #13553] (From yocto-docs rev: 6611a4726167e8597417e132661a29ec411266cc) 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-232-3/+31
| | | | | | | | | | | | | | | 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-232-11/+16
| | | | | | | | | | | | | 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-2311-45/+45
| | | | | | | | | | 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>
* dev-manual: Added info to "Selecting an Initialization Manager"Scott Rifenbark2019-10-231-0/+41
| | | | | | | (From yocto-docs rev: c402ebcb51b6400d79c62ff44aeae57db982565e) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* poky.ent: Updated the release date to October 2019Scott Rifenbark2019-10-231-1/+1
| | | | | | | (From yocto-docs rev: 21042fd8ad463c996e554f52359a599ee7d35c12) 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>
* kernel-dev: don't use _append +=Ross Burton2019-10-151-3/+3
| | | | 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-092-11/+19
| | | | | | | | | | | | | | | | 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>
* poky-end: Added "pylint3" package to Ubuntu essentials.Scott Rifenbark2019-09-061-1/+1
| | | | 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>
* dev-manual: Updated "Creating a Team Development Environment"Scott Rifenbark2019-09-061-3/+2
| | | | | | | | | 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>
* 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>
* dev-manual: Provided proper link titleScott Rifenbark2019-07-181-1/+2
| | | | | | | | | | | | 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>
* sdk-manual: Updated devtool to talk about oe-local-files.Scott Rifenbark2019-07-181-12/+73
| | | | | | | | | | | | | | | | | | | 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>
* overview-manual: Fixed manual history tableScott Rifenbark2019-07-181-0/+5
| | | | | | | | | 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>
* dev-manual: Fixed grammar issue.Scott Rifenbark2019-06-181-1/+1
| | | | | | | | | | 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>
* overview-manual: Updated SCM sectionScott Rifenbark2019-06-181-5/+6
| | | | | | | | | | | | 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>