summaryrefslogtreecommitdiffstats
path: root/documentation
AgeCommit message (Collapse)Author
2022-01-17dev-manual: stop mentioning nightly buildsMichael Opdenacker
While nightly builds are still run, they only produce test files and reports. They are no longer a solution to use the latest code. (From yocto-docs rev: ace9f81ade851bb1b0d98a050007fffbc62b938d) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-01-17ref-manual: Drop TUNEABI, TUNEABI_WHITELIST, TUNEABI_OVERRIDEMichael Opdenacker
Following their removal from openembedded-core (From yocto-docs rev: bf98f5a15c33e75315cd14e653f253ef078da614) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-01-17ref-manual/classes.rst: add setuptools3-baseTim Orling
Add setuptools3-base class Deprecate distutils3* classes. [YOCTO #14610] (From yocto-docs rev: 0e9838e5a2096932d081a9a05a25c4fa0d6dc714) Signed-off-by: Tim Orling <tim.orling@konsulko.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-01-17ref-manual/variables.rst: add SETUPTOOLS_*_ARGSTim Orling
Add SETUPTOOLS_BUILD_ARGS variable which can be used to pass additional arguments to `setup.py build`. Add SETUPTOOLS_INSTALL_ARGS variable which can be used to pass additional arguments to `setup.py install`. [YOCTO #14610] (From yocto-docs rev: 4e8c911b73f511f1fb7b557f12d5c87129bc2593) Signed-off-by: Tim Orling <tim.orling@konsulko.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-01-17ref-manual/variables.rst: add SETUPTOOLS_SETUP_PATHTim Orling
Add SETUPTOOLS_SETUP_PATH for setuptools3 class. Deprecate DISTUTILS_SETUP_PATH and drop mention of ref-classes-setuptools3 as that class has moved to new variable. [YOCTO #14610] (From yocto-docs rev: 6a314a9217206f572289b484e59076483391868c) Signed-off-by: Tim Orling <tim.orling@konsulko.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-01-17manuals: simplify references to class sectionsMichael Opdenacker
Replace ":ref:`classname.bbclass <ref-classes-classname>`" section by ":ref:`ref-classes-classname`" section because each section has "classname.bbclass" as title, therefore the result is the same. (From yocto-docs rev: e3f438e4a71b155bd09bc7988c8e5626a063fde3) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Reviewed-by: Quentin Schulz <foss+yocto@0leil.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-01-17migration-guides: prepare for release 3.5Michael Opdenacker
(From yocto-docs rev: e0bef3c086645127b743d127b8f6e8925138b9dd) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-01-10manuals: add reference to GIR_EXTRA_LIBS_PATH plus minor improvementsMichael Opdenacker
Fixes [YOCTO #14533] (From yocto-docs rev: 84001d5d4258dad9e3663ea842ecc291d9e1a7dd) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-01-10dev-manual: update bitbake.conf sample for static libsMichael Opdenacker
(From yocto-docs rev: 0762a24cb20e23d4903402bea109ae8d1d85ef5e) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-01-10manuals: document hash equivalenceMichael Opdenacker
(From yocto-docs rev: 7fad0873207980a747f79b2ce29ec0dc6c6c3cdf) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-01-10poky.yaml: centos-7 python36-pip -> python3-pipTim Orling
In CENTOS7_HOST_PACKAGES_ESSENTIAL, change python36-pip to python3-pip. The python36-pip package was obsoleted by python3-pip in RHEL 7.7+ https://src.fedoraproject.org/rpms/python-pip/c/6771a1c54f5c7ac333c7af644c055da670027f6c?branch=epel7 (From yocto-docs rev: df5d499f86e0cf2b6316778c7c390d64f5f1367c) Signed-off-by: Tim Orling <tim.orling@konsulko.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-01-07documentation/README: trivial typo fixMichael Opdenacker
(From yocto-docs rev: f3f252c08a8ae9b492d766fd8a7168baf7467a07) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-01-07ref-manual: fix patch documentationMax Krummenacher
The do_patch implementation does not apply patches from an entry in SRC_URI pointing to a directory. Remove the claim that this is implemented. (From yocto-docs rev: de1156b6d95a2d1738807f0b0525edd0b58fc0e9) Signed-off-by: Max Krummenacher <max.krummenacher@toradex.com> Reviewed-by: Quentin Schulz <foss+yocto@0leil.net> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-01-07ref-manual: Fix module_conf typoRobert Joslyn
Modules specified as part of module_conf must be listed in KERNEL_MODULE_PROBECONF, not KERNEL_MODULE_AUTOLOAD. (From yocto-docs rev: 5720fb534dc343675f8be6369b9661512e3968f2) Signed-off-by: Robert Joslyn <robert.joslyn@redrectangle.org> Reviewed-by: Quentin Schulz <foss+yocto@0leil.net> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-01-07quick start manual: update Share State and Hash Equivalence settingsMichael Opdenacker
(From yocto-docs rev: 8668f070a5f2bf70f71f1ac53d2fac1b0faff82d) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-01-07manuals: replace "rootfs" by "root filesystem"Michael Opdenacker
Almost everyone understands "rootfs", but "root filesystem" is real English. (From yocto-docs rev: 3d610f15e5b6be3435e9e81e4498a676671e5b39) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-01-07overview-manual: fix typoMichael Opdenacker
(From yocto-docs rev: 595d3e77855aeed31537a5e58a4426d7cc0b21f5) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-01-07documentation: add comment to releases.rst switchers.jsMichael Opdenacker
To let release developers know that they don't need to update these files in release branches other than "master". (From yocto-docs rev: 00f71afae92e5967a0422824841d4d4db682d235) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-01-07ref-manual: document overlayfs-etc image featureVyacheslav Yurkov
(From yocto-docs rev: 62c7cea1b916c04bfd5c25e0011424b90d5272a1) Signed-off-by: Vyacheslav Yurkov <uvv.mail@gmail.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-01-07ref-manual: add overlayfs-etc classVyacheslav Yurkov
(From yocto-docs rev: c11da26609e02f0c0b43efacb4642141d990ebaa) Signed-off-by: Vyacheslav Yurkov <uvv.mail@gmail.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-01-03releases: update to include 3.1.13Michael Halstead
Adding 3.1.13 to documentation switcher and release list. (From yocto-docs rev: 24fe6a752cdec66a3d34d390fa645726ed3725b8) Signed-off-by: Michael Halstead <mhalstead@linuxfoundation.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-12-13documentation: conf.py: add knob for loading appropriate objects.invQuentin Schulz
Yocto Project releases use a specific Bitbake release. Currently the bitbake: mapping is pointing to the current master version of Bitbake documentation. This is an issue if some links disappear over time and someone is still building old documentation (which is the case on the YP autobuilder for example). Also, the documentation at the current master version of Bitbake might not be correct for the Yocto Project version associated with the doc the user is currently looking at, potentially causing confusion. In master branch, nothing needs to be done. For release branches, the bitbake_version variable needs to be set accordingly. See https://wiki.yoctoproject.org/wiki/Releases for the mapping. Cc: Quentin Schulz <foss+yocto@0leil.net> (From yocto-docs rev: 457a591a46c57519046f9e3f8bffd632bb2275ea) Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-12-13docs: dev-manual: common-tasks: highlight creating your own layer is not ↵Quentin Schulz
required Three's been some feedback saying that people actually missed that paragraph and thought creating the layer by hand was the only way to do it instead of leveraging bitbake-layers create-layer tool. Let's try to make it a bit more obvious one does not need to create the layer by hand by putting the paragraph into a note. (From yocto-docs rev: 2b171d267ae37d467f8437c4739f32e5253049b3) Signed-off-by: Quentin Schulz <foss@0leil.net> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-12-13make the documentation a bit more inclusiveQuentin Schulz
Except the name of variables which can't be changed only in the documentation for obvious reasons and workflow or developement explanations around the use of the "master" branch which cannot be replaced with "development" branch instead, most of the non-inclusive words that appear in https://inclusivenaming.org/word-lists/tier-1/ should have been replaced in this patch. (From yocto-docs rev: 2755f35060084f7af356091de9dc144f85530fe2) Signed-off-by: Quentin Schulz <foss+yocto@0leil.net> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-12-13ref-manual: remove newline string in PREMIRRORSMichael Opdenacker
According to the syntax simplification brought by https://git.openembedded.org/bitbake/commit/?id=044fb04d (From yocto-docs rev: 19090efa1268fcb1fcfd3a2dc637d10d8a50dfad) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-12-13misc manuals: add further class referencesMichael Opdenacker
(From yocto-docs rev: 0693f1f8466a118dc707a9c17d5ca528b4ea368a) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-12-13ref-manual: add more class referencesMichael Opdenacker
(From yocto-docs rev: f4610b060968c481c68d0411b82201c302050b71) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-12-13migration-guides: add more class referencesMichael Opdenacker
(From yocto-docs rev: 29031a9da0f1a500a8b2b6a642ee553a352255f8) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-12-13dev-manual: how to purge duplicate sstate cache filesMichael Opdenacker
(From yocto-docs rev: 113400eb47c13617f08b415bc9ddb4526429049c) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-12-13manuals: add hyperlinks to files in meta-skeletonMichael Opdenacker
This makes the manuals easier to use. Note the care to keep the paths visible, so that people reading a printed version still know where to find the files. (From yocto-docs rev: 501917f65530f14ea686b69d6e96407c3f970a28) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-12-13releases.rst: move gatesgarth to outdated releases sectionAnuj Mittal
(From yocto-docs rev: 0a21e78e4593ef2417f4a08b23246ad3c93a566e) Signed-off-by: Anuj Mittal <anuj.mittal@intel.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-12-13dev-manual: remove warning about += and :appendMichael Opdenacker
No longer necessary since a warning was added to BitBake (https://git.openembedded.org/bitbake/commit/?id=8c31e75557dc6a8d8f407b5d24d6327889a3e3b1) (From yocto-docs rev: f3069c927f24c5d1942c9bcc4f55bb77cd262c0e) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-12-13ref-manual: drop support for Fedora 30-32Michael Opdenacker
These versions have reached their end of life and we don't test them any more. (From yocto-docs rev: e4ff50fadbf61bf29015e9eded2584731c5d2bb2) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-12-13ref-manual: drop support for Ubuntu 16.04Michael Opdenacker
There are no more free updates to Ubuntu 16.04 We can no longer test the latest updates to this distro. (From yocto-docs rev: 752636d8924f0aaae1e8df61affef3310ae91aa0) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-12-12releases: update to include 3.4.1Michael Halstead
Adding 3.4.1 to documentation switcher and release list. (From yocto-docs rev: 7d503d765f5a8ade226c897a17aecd0856104af1) Signed-off-by: Michael Halstead <mhalstead@linuxfoundation.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-11-21ref-system-requirements.rst: Add openSUSE Leap 15.2 to list of supported distrosSteve Sakoman
(From yocto-docs rev: 895ce3b9dda96a049c92754cf06eb34635097861) Signed-off-by: Steve Sakoman <steve@sakoman.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-11-21documentation: prepare for 3.1.12 releaseMichael Opdenacker
(From yocto-docs rev: d97525982602db05e31b89a9076c93420974fd68) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-11-21ref-system-requirements.rst: Add Fedora 33 and 34 to list of supported distrosSteve Sakoman
(From yocto-docs rev: b85b532b8360756798c08482b94758d5df55f5ed) Signed-off-by: Steve Sakoman <steve@sakoman.com> Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-11-21ref-system-requirements.rst: Add Debian 11 to list of supported distrosSteve Sakoman
(From yocto-docs rev: aa212ce6c6fb9b92e0cf4e32ae8d2458aab4a055) Signed-off-by: Steve Sakoman <steve@sakoman.com> Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-11-21ref-manual: simplify SRC_URI referenceMichael Opdenacker
After some features that also apply to BitBake were moved to the BitBake manual. (From yocto-docs rev: 1415521656427f351ab2d3f8bc498130c4653396) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-11-21ref-manual: BBFILES_DYNAMIC - fix punctuation and quoting issuesMichael Opdenacker
(From yocto-docs rev: a798e1172ac507549ad36c0cfd4b92f53a1bef87) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-11-21ref-manual: remove reference to TOPDIRMichael Opdenacker
Already described in BitBake's manual As it is not specific to OE / Yocto Project (From yocto-docs rev: 150d5e938e9f413ade8bd6211ee7d55a2819a431) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-11-21ref-manual: generalize definition of "container layer"Robert P. J. Day
Given that there seems to be little value in being excruciatingly pedantic about whether a container layer has a valid layer as a top-level directory, expand the definition to allow either. (From yocto-docs rev: 95e5df9a51a7cda6588af523a3a0d6752613f189) Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-11-19releases: update to include 3.3.4Michael Halstead
Adding 3.3.4 to documentation switcher and release list. (From yocto-docs rev: 468e8bfb4b9bed662f1b32b0563339d0816a7e98) Signed-off-by: Michael Halstead <mhalstead@linuxfoundation.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-11-07manuals: start of documentation standards documentMichael Opdenacker
This first version specifies how to create consistent SGV graphics (From yocto-docs rev: 370b9e34e9092c9eed22df2e8b2d0bb979487e5c) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-11-07kickstart: update busybox note regarding PARTUUIDRoss Burton
As of oe-core c996cabf the default BusyBox configuration supports PARTUUID, so update the note to reflect this. (From yocto-docs rev: cfd0498c6a981bcdc4b6bd03cb5f8dd42f0b39fc) Signed-off-by: Ross Burton <ross.burton@arm.com> Reviewed-by: Quentin Schulz <foss@0leil.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-11-07ref-manual: update overlayfs classVyacheslav Yurkov
Describe how to use a generated helper service to set up a proper systemd dependency chain. (From yocto-docs rev: c8c1f7e852830dae4468da70e1ac732d7bbce06f) Signed-off-by: Vyacheslav Yurkov <uvv.mail@gmail.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-11-07manuals: correct "take affect" by "take effect"Michael Opdenacker
(From yocto-docs rev: aeaf46f78b940744ce2e160e78b244395087e8e7) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-11-07ref-manual: improve documentation for SDKMACHINERoss Burton
(From yocto-docs rev: 69bfb07772e7d358bb532191189a2518d1046178) Signed-off-by: Ross Burton <ross.burton@arm.com> Reviewed-by: Quentin Schulz <foss@0leil.net> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2021-10-26releases: update to include 3.4 honisterMichael Halstead
Adding 3.4 to the release switcher and incrementing dev to say 3.5. (From yocto-docs rev: a171e88bc572e45d700d257a9de521520b4d5d5e) Signed-off-by: Michael Halstead <mhalstead@linuxfoundation.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>