summaryrefslogtreecommitdiffstats
path: root/documentation
Commit message (Collapse)AuthorAgeFilesLines
...
* ref-manual: add overlayfs-etc classVyacheslav Yurkov2022-01-071-0/+46
| | | | | | | | (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>
* releases: update to include 3.1.13Michael Halstead2022-01-032-1/+2
| | | | | | | | | 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>
* documentation: conf.py: add knob for loading appropriate objects.invQuentin Schulz2021-12-131-1/+2
| | | | | | | | | | | | | | | | | | | | | | 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>
* docs: dev-manual: common-tasks: highlight creating your own layer is not ↵Quentin Schulz2021-12-131-9/+11
| | | | | | | | | | | | | | | | | 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>
* make the documentation a bit more inclusiveQuentin Schulz2021-12-1314-159/+151
| | | | | | | | | | | | | | | 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>
* ref-manual: remove newline string in PREMIRRORSMichael Opdenacker2021-12-132-12/+12
| | | | | | | | | | 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>
* misc manuals: add further class referencesMichael Opdenacker2021-12-133-19/+17
| | | | | | | (From yocto-docs rev: 0693f1f8466a118dc707a9c17d5ca528b4ea368a) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: add more class referencesMichael Opdenacker2021-12-134-30/+28
| | | | | | | (From yocto-docs rev: f4610b060968c481c68d0411b82201c302050b71) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* migration-guides: add more class referencesMichael Opdenacker2021-12-1311-19/+22
| | | | | | | (From yocto-docs rev: 29031a9da0f1a500a8b2b6a642ee553a352255f8) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: how to purge duplicate sstate cache filesMichael Opdenacker2021-12-131-1/+24
| | | | | | | (From yocto-docs rev: 113400eb47c13617f08b415bc9ddb4526429049c) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: add hyperlinks to files in meta-skeletonMichael Opdenacker2021-12-134-24/+21
| | | | | | | | | | | 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>
* releases.rst: move gatesgarth to outdated releases sectionAnuj Mittal2021-12-131-10/+10
| | | | | | | | (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>
* dev-manual: remove warning about += and :appendMichael Opdenacker2021-12-131-5/+0
| | | | | | | | | | 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>
* ref-manual: drop support for Fedora 30-32Michael Opdenacker2021-12-131-6/+0
| | | | | | | | | | 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>
* ref-manual: drop support for Ubuntu 16.04Michael Opdenacker2021-12-131-2/+0
| | | | | | | | | | 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>
* releases: update to include 3.4.1Michael Halstead2021-12-123-5/+6
| | | | | | | | | 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>
* ref-system-requirements.rst: Add openSUSE Leap 15.2 to list of supported distrosSteve Sakoman2021-11-211-0/+2
| | | | | | | (From yocto-docs rev: 895ce3b9dda96a049c92754cf06eb34635097861) Signed-off-by: Steve Sakoman <steve@sakoman.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: prepare for 3.1.12 releaseMichael Opdenacker2021-11-212-1/+2
| | | | | | | (From yocto-docs rev: d97525982602db05e31b89a9076c93420974fd68) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-system-requirements.rst: Add Fedora 33 and 34 to list of supported distrosSteve Sakoman2021-11-211-0/+4
| | | | | | | | (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>
* ref-system-requirements.rst: Add Debian 11 to list of supported distrosSteve Sakoman2021-11-211-1/+2
| | | | | | | | (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>
* ref-manual: simplify SRC_URI referenceMichael Opdenacker2021-11-211-116/+9
| | | | | | | | | | 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>
* ref-manual: BBFILES_DYNAMIC - fix punctuation and quoting issuesMichael Opdenacker2021-11-211-2/+4
| | | | | | | (From yocto-docs rev: a798e1172ac507549ad36c0cfd4b92f53a1bef87) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: remove reference to TOPDIRMichael Opdenacker2021-11-211-5/+0
| | | | | | | | | | 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>
* ref-manual: generalize definition of "container layer"Robert P. J. Day2021-11-211-4/+21
| | | | | | | | | | | | 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>
* releases: update to include 3.3.4Michael Halstead2021-11-193-2/+3
| | | | | | | | | 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>
* manuals: start of documentation standards documentMichael Opdenacker2021-11-073-3/+1273
| | | | | | | | | 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>
* kickstart: update busybox note regarding PARTUUIDRoss Burton2021-11-071-2/+3
| | | | | | | | | | | 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>
* ref-manual: update overlayfs classVyacheslav Yurkov2021-11-071-1/+15
| | | | | | | | | | | 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>
* manuals: correct "take affect" by "take effect"Michael Opdenacker2021-11-072-4/+4
| | | | | | | (From yocto-docs rev: aeaf46f78b940744ce2e160e78b244395087e8e7) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: improve documentation for SDKMACHINERoss Burton2021-11-071-11/+9
| | | | | | | | | (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>
* releases: update to include 3.4 honisterMichael Halstead2021-10-262-1/+8
| | | | | | | | | 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>
* docs: poky.yaml: updates for 3.4Michael Opdenacker2021-10-221-8/+8
| | | | | | | (From yocto-docs rev: d080c62f3ec489275b2f241ccea51cf127f4f782) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* releases.rst: fix release number for 3.3.3Michael Opdenacker2021-10-221-1/+1
| | | | | | | (From yocto-docs rev: 8e0e33663b4f7e58b02e3b5153e4164a7d3db20e) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Update how to set a useradd passwordDaiane Angolini2021-10-221-5/+11
| | | | | | | | | | Partial fix for [YOCTO 14605] (From yocto-docs rev: 3f3e5574ac9801ad92940168b61b532e0bd53a80) Signed-off-by: Daiane Angolini <daiane.angolini@foundries.io> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* migration-3.4: add some extra packaging notesPaul Eggleton2021-10-221-0/+9
| | | | | | | | | | Add some notes on minor packaging changes that I missed earlier. (From yocto-docs rev: a4f345f888b466bd1459b767c1b8cf8b9397e27e) Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* poky.yaml: fix lz4 package name for older Ubuntu versionsPaul Eggleton2021-10-221-1/+1
| | | | | | | | | | | | | It turns out that for Ubuntu, lz4 is the valid package name for newer versions (e.g. 20.04 LTS) but not for older ones (e.g. 18.04 LTS, where the correct package is liblz4-tool). In 20.04 the lz4 package includes liblz4-tool in its "provides" so it's best to list that one for now. (From yocto-docs rev: 2a4e259d2786c14b19a632b3a8f1a06383b6a80c) Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: fix description of SOURCE_DATE_EPOCHMichael Opdenacker2021-10-221-1/+1
| | | | | | | | | | Update the reference to the code that computes this default value for this variable. (From yocto-docs rev: b115a1c07f76d2cca37565ac678c21e0e6056fff) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: document SOURCE_DATE_EPOCHMichael Opdenacker2021-10-201-0/+17
| | | | | | | (From yocto-docs rev: 160d672641c52338ba499edfb66339a10b088490) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: rename "devpyshell" to "pydevshell"Michael Opdenacker2021-10-202-10/+10
| | | | | | | | | | This addresses [YOCTO #14531] after the "devpyshell" task was renamed to "pydevshell" in OE core. (From yocto-docs rev: 1056320e90545c8dff0fc71a5fde752295d4d6e4) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: document TOOLCHAIN_HOST_TASK_ESDKMichael Opdenacker2021-10-202-1/+10
| | | | | | | (From yocto-docs rev: 2adac164a2d4cf23c0372c1154709f2866d483fa) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* migration: tweak introduction sectionPaul Eggleton2021-10-201-4/+22
| | | | | | | | | | Ensure we have a brief introductory section and tweak the general migration considerations a little. (From yocto-docs rev: b127348bbc6a7a6e48ee14434fffc56e08aa9e02) Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* migration-3.4: add additional migration infoPaul Eggleton2021-10-201-0/+176
| | | | | | | | | | Add migration instructions gathered by combing the commits in this release. (From yocto-docs rev: 2fc89fa1d4e29d2498d5b736ffe85c1cdc8b62e7) Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* poky.yaml: add lz4 and zstd to essential host packagesPaul Eggleton2021-10-201-5/+6
| | | | | | | | | | These are now required so update the corresponding distro-specific lists used in the system requirements documentation. (From yocto-docs rev: 604deb5c30a8808a60187f81645fa08b67ef2de9) Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: remove meta classPaul Eggleton2021-10-201-9/+0
| | | | | | | | | This was recently removed so remove the reference to it. (From yocto-docs rev: 53f52adf212e35e7588a90e94b03b5cfae6f867c) Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* migration-3.4: tweak overrides change sectionPaul Eggleton2021-10-201-15/+19
| | | | | | | | | Minor grammar and readability improvements. (From yocto-docs rev: e33a809d139d52a8aa262a25fe3031a8882dee2e) Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: warn about license compliance issues when static libraries are usedMichael Opdenacker2021-10-081-0/+20
| | | | | | | | | This partly addresses [YOCTO #14407] (From yocto-docs rev: 444ca8900e8057562d2a71a77e6e6798aca3ce85) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: correct NO_GENERIC_LICENSE section titleMichael Opdenacker2021-10-081-2/+2
| | | | | | | | (From yocto-docs rev: 522841b4715295c6f399fc5affe2ade128d139ae) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Reviewed-By: Quentin Schulz <foss@0leil.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* overview-manual: simplify expressionMichael Opdenacker2021-10-081-1/+1
| | | | | | | (From yocto-docs rev: ea1e5d4214f30927119f0124ee8a80a558601161) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: remove errant /Jon Mason2021-10-081-2/+2
| | | | | | | | (From yocto-docs rev: 5a10c78c574eae48f50f5c912fd6534bdf99f71c) Signed-off-by: Jon Mason <jdmason@kudzu.us> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: use YOCTO_DL_URLJon Mason2021-10-083-26/+26
| | | | | | | | (From yocto-docs rev: e3ad609d9fce8d6729bf6cb553993bddba1785ae) Signed-off-by: Jon Mason <jdmason@kudzu.us> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
generated by cgit v1.2.3-54-g00ecf (git 2.39.0) at 2025-07-09 22:38:04 +0000