summaryrefslogtreecommitdiffstats
path: root/documentation
Commit message (Collapse)AuthorAgeFilesLines
* ref-manual: classes: kernel: document automatic defconfig usageLuca Ceresoli2023-05-061-0/+7
| | | | | | | | | | | Since a very long time the kernel bbclass uses a defconfig file from SRC_URI automatically. Document this feature. (From yocto-docs rev: 220b25d7d47d46b0d85c616b88ead75fab917092) Signed-off-by: Luca Ceresoli <luca.ceresoli@bootlin.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: classes: kernel: remove incorrect sentence openingLuca Ceresoli2023-05-061-5/+5
| | | | | | | | | | | | "This means that" implies that this sentence is a consequence of the previous, but this is not the case, the two sentences being quite unrelated to each other. (From yocto-docs rev: 1f352ad21bb892e74bdb46aee791d0f86b150249) Signed-off-by: Luca Ceresoli <luca.ceresoli@bootlin.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: document FIT_ADDRESS_CELLSMichael Opdenacker2023-05-063-1/+33
| | | | | | | | (From yocto-docs rev: 81ee2e82a5bd0b7f1cb910bf266ceb808c05bba9) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> CC: Jamin Lin <jamin_lin@aspeedtech.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* migration/release-notes-4.3: Add extra notesRichard Purdie2023-05-062-1/+41
| | | | | | | | (From yocto-docs rev: c365f3d02ed880d4cd3f7970094249780d443b2f) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* migration-guides: start of 4.3 migration and release notesMichael Opdenacker2023-05-064-0/+138
| | | | | | | | | | From notes from Richard Purdie (From yocto-docs rev: 62fcaabd06558669034e8732b8d22a9c46e36cf2) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> CC: richard.purdie@linuxfoundation.org Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: variables.rst: don't mention the INIT_MANAGER "none" optionMichael Opdenacker2023-05-041-5/+0
| | | | | | | | | | | | | As it is mainly used for internal purposes, so not necessarily useful for regular users. OE-core "nodistro" uses it as a fallback to the default setting. (From yocto-docs rev: aa4d4034707d7c74488678e77d4f45d65782b2a7) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> CC: Richard Purdie <richard.purdie@linuxfoundation.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* docs: add support for mickledore (4.2) releaseMichael Halstead2023-05-042-8/+10
| | | | | | | | | | | This adds support for the Mickledore (4.2) release and update the current dev branch to Nanbield. (From yocto-docs rev: 5321befbfdc014d469b298bdd5b31d684231b2cb) Signed-off-by: Michael Halstead <mhalstead@linuxfoundation.org> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: system-requirements.rst: fix AlmaLinux variable nameMichael Opdenacker2023-05-031-1/+1
| | | | | | | (From yocto-docs rev: d84b771e2ca22fa7dd9525dc515d3972035366eb) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: init-manager.rst: add summaryMichael Opdenacker2023-05-031-0/+49
| | | | | | | | | Comparing init managers by features (From yocto-docs rev: 1039bbe55b5b7375e8dd969940bbd656115a5ab0) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* release-notes-4.2: remove/merge duplicates entriesLee Chee Yang2023-05-031-38/+10
| | | | | | | | (From yocto-docs rev: 6e4b1af0fed2b59909ac9db1be2aaf3e3b542b0c) Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: variables.rst: document KERNEL_DANGLING_FEATURES_WARN_ONLYMichael Opdenacker2023-04-281-0/+14
| | | | | | | | (From yocto-docs rev: dc59b636bb4319a3af552bce84929ddb22a479fb) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Reviewed-by: Bruce Ashfield <bruce.ashfield@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: expand init manager documentationMichael Opdenacker2023-04-283-43/+98
| | | | | | | | | | | | | | | | | | - Add details about INIT_MANAGER Correct the fact that "none" currently generates an image with "sysvinit", at least on Poky. This behaviour should probably be changed. - Expand the "Selecting an Initialization Manager" section. - Stop mentioning "rescue image" generation, as this is not detailed anywhere else. (From yocto-docs rev: fd99f2753b50b7ad6133b787b90331fcb3a35152) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> CC: Paul Eggleton <bluelightning@bluelightning.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* migration-guides: fixes and improvements to 4.2 release notesMichael Opdenacker2023-04-281-86/+72
| | | | | | | | | | | | | - Remove empty subsections (detailed elsewhere) - Fix bullet list syntax (missing leading empty line) - Fix a few CVE URLs - Add some references - Minor font and case fixes (From yocto-docs rev: ec63abf8b67458ad9f8d8942e0c327d3de93eef9) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* migration-guides: release-notes-4.0.9.rst: add missing SPDX infoMichael Opdenacker2023-04-281-0/+2
| | | | | | | | (From yocto-docs rev: 59b6dcc2ea952a76df96b6b8ae80cce5dcae4161) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> CC: Lee Chee Yang <chee.yang.lee@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: add "Mixin" termMichael Opdenacker2023-04-282-4/+12
| | | | | | | | | | Also add a target (and use) a target for the "Long Term Support Release" section. (From yocto-docs rev: 98d6f2066fcdb20e63b8da6ed52d0f3590b15195) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* overview-manual: development-environment: update text and screenshotsMichael Opdenacker2023-04-284-23/+11
| | | | | | | | | | | | | | | - Reduce the importance of https://downloads.yoctoproject.org/releases (mostly obsolete), mention only https://downloads.yoctoproject.org/releases/yocto/ - Update the corresponding text, especially the names of the components. - Update screenshots. (From yocto-docs rev: 9b2eb5f19f6121406ff7b72b846554f3016bc789) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: document SPDX_CUSTOM_ANNOTATION_VARSMichael Opdenacker2023-04-283-0/+75
| | | | | | | | | (From yocto-docs rev: 5811f4eb3e73aa5f8ca90e40ec6559a6d4d58fa3) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> CC: Saul Wold <Saul.Wold@windriver.com> CC: Joshua Watt <JPEWhacker@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* overview-manual: update section about source archivesMichael Opdenacker2023-04-282-34/+13
| | | | | | | | | | | | | | | | Except the "yocto" and "uninative" directories, everything under https://downloads.yoctoproject.org/releases/, in particular "bitbake". Point to https://downloads.yoctoproject.org/releases/yocto/ instead for people interested in tar archives. Simplify the description too, unnecessarily verbose. (From yocto-docs rev: 502b00003b1c84d7b419f01b87a6ab6a121a7ad9) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: variables.rst: add wikipedia shortcut for "getty"Michael Opdenacker2023-04-281-11/+8
| | | | | | | (From yocto-docs rev: 2f07fddce909d13a7175e713118af7730e2e5529) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: remove unused and obsolete fileMichael Opdenacker2023-04-281-11/+0
| | | | | | | (From yocto-docs rev: 707596c89e42b222df1f1659eb39a7574fba95e9) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: classes.rst: document devicetree.bbclassMichael Opdenacker2023-04-281-0/+43
| | | | | | | | | | | This addresses [YOCTO #15092] (From yocto-docs rev: f65816f5ea62e6c4301c0bd0c6aad91110963f9e) Signed-off-by: Luca Ceresoli <luca.ceresoli@bootlin.com> Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Reviewed-by: Luca Ceresoli <luca.ceresoli@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* release-notes-4.2: update RC3 changesLee Chee Yang2023-04-261-6/+7
| | | | | | | | | also fix typo for CVE-2023-24532. (From yocto-docs rev: daafb70e6d60fd7d00c8de736eca2c430db77ee8) Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* release-notes-4.2: add release notesPaul Eggleton2023-04-221-19/+828
| | | | | | | | | | | | | | | | Add new features, upgrades, CVEs, contributors and license changes based upon combing through the commits in the release. I haven't yet noted any known issues. Note: I had to add the upgrades list from the commits rather than from the layer index this time (as the branch comparison feature is unfortunately broken there at the moment), thus the format is a little different. (From yocto-docs rev: 4d6807e34adf5d92d9b6e5852736443a867c78fa) Signed-off-by: Paul Eggleton <bluelightning@bluelightning.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* release-notes-4.1: fix some CVE linksPaul Eggleton2023-04-221-6/+6
| | | | | | | | | | The "(ignored)" suffixes were included in the link value which broke the link. (From yocto-docs rev: bff0fb0e39f69101f036ddbc27a82c15047bdbcd) Signed-off-by: Paul Eggleton <bluelightning@bluelightning.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* migration-guides: extend migration guide for 4.2Paul Eggleton2023-04-221-34/+162
| | | | | | | | | | * Reorder and extend existing info a little * Add additional sections after combing through changes (From yocto-docs rev: 337d35d85b5b4361655549ea7eb6fdf5f55e7506) Signed-off-by: Paul Eggleton <bluelightning@bluelightning.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev/ref-manual: Document INIT_MANAGERPaul Eggleton2023-04-222-18/+21
| | | | | | | | | | | | The INIT_MANAGER variable was added in 3.0 but it seems we didn't get around to documenting it yet. I have added a variable glossary entry and made the basic adjustment of the "Using systemd Exclusively" section in the dev manual, however I think the latter section still needs work. (From yocto-docs rev: 602c0e8f770516256dab04edfd887377303c06bb) Signed-off-by: Paul Eggleton <bluelightning@bluelightning.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: move Initramfs entry from variables to termsPaul Eggleton2023-04-222-42/+42
| | | | | | | | | | It looks like this was accidentally added to the variable glossary instead of the terms list, so move it to the latter. (From yocto-docs rev: c9829dcae18cd2cb5f008081d841ca995b76b8bf) Signed-off-by: Paul Eggleton <bluelightning@bluelightning.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: add SDK_ARCHIVE_TYPEPaul Eggleton2023-04-221-0/+8
| | | | | | | | | | This appears to have been introduced back in 2019, but we missed documenting it. (From yocto-docs rev: 064a5d84890416362a1a7a337347abbe9afe485d) Signed-off-by: Paul Eggleton <bluelightning@bluelightning.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: add section link also to buildtools-extended entryPaul Eggleton2023-04-221-0/+4
| | | | | | | | | | I realise it's already in the buildtools entry above, but for completeness let's add it to the buildtools-extended entry as well. (From yocto-docs rev: d9db1d380120e976a30e9eddb86b391084178c94) Signed-off-by: Paul Eggleton <bluelightning@bluelightning.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: add FIT_CONF_DEFAULT_DTBPaul Eggleton2023-04-221-0/+4
| | | | | | | | | New variable in 4.2. (From yocto-docs rev: 1228ce16a33bd6f00e5399e4c381be808a272281) Signed-off-by: Paul Eggleton <bluelightning@bluelightning.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: document new patch-status-* QA checksPaul Eggleton2023-04-222-0/+30
| | | | | | | | | Newly added in 4.2. (From yocto-docs rev: 12e576fb6a932c4089651371c71c61fd1e96cd48) Signed-off-by: Paul Eggleton <bluelightning@bluelightning.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: add missing QA checks from previous releasesPaul Eggleton2023-04-221-7/+51
| | | | | | | | | | | | | | This section needs to be kept in sync with the "QA Error and Warning Messages" section (qa-checks.rst) - this is the other direction that tells folks what all of the values in WARN_QA / ERROR_QA are intended to do. Add the ones that we missed adding here for previous releases, and also use a proper reference for the buildhistory class in the entry for version-going-backwards. (From yocto-docs rev: 356a6e650bb1de66b806142f75a03bda57972a94) Signed-off-by: Paul Eggleton <bluelightning@bluelightning.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Remove references to package_tar classPaul Eggleton2023-04-224-75/+6
| | | | | | | | | This has been removed in 4.2. (From yocto-docs rev: a5dcaf95915deec5243ab2fd0711c63e98b2a661) Signed-off-by: Paul Eggleton <bluelightning@bluelightning.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* migration-guides: Add coverage of addpylib directivePaul Eggleton2023-04-223-7/+27
| | | | | | | | | | | | To complement what I am adding to the BitBake reference manual, add a section in the 4.2 migration guide, a reference in the structure section of the reference manual (where we talk about meta/lib) and adjust the release notes item to be a little more concise. (From yocto-docs rev: 0903e82a9da263c6d64aead03407eb377eb5bbfe) Signed-off-by: Paul Eggleton <bluelightning@bluelightning.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: add BB_CACHEDIRPaul Eggleton2023-04-221-0/+3
| | | | | | | | | | New in 4.2 (pointer to BitBake manual, changes sent separately for that). (From yocto-docs rev: a2112eb3f1084040ad48e392075297b4630b93e1) Signed-off-by: Paul Eggleton <bluelightning@bluelightning.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev/ref-manual: Remove references to INC_PRPaul Eggleton2023-04-222-49/+0
| | | | | | | | | | This technique is no longer used (nor necessary), let's just remove it to avoid any confusion. (From yocto-docs rev: 8f50d0bf22fea8064c112f52df06dbd6a85a7a83) Signed-off-by: Paul Eggleton <bluelightning@bluelightning.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: update for IMAGE_MACHINE_SUFFIX additionPaul Eggleton2023-04-221-31/+50
| | | | | | | | | | | | | | | | | IMAGE_MACHINE_SUFFIX is a new variable in 4.2, and there were some associated changes to how IMAGE_NAME, IMAGE_LINK_NAME, INITRAMFS_IMAGE_NAME and KERNEL_ARTIFACT_NAME are set by default. As a result, instead of repeating how KERNEL_ARTIFACT_NAME is set by default, let's just direct people to the entry for that variable so we only have to update one place. At the same time I noticed INITRAMFS_IMAGE_NAME was not documented at all, so add that in. (From yocto-docs rev: d53bf2878a268fb71785c73053e3657436f3f5ba) Signed-off-by: Paul Eggleton <bluelightning@bluelightning.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Add new RUST_CHANNEL variablePaul Eggleton2023-04-221-0/+5
| | | | | | | | | Newly added for 4.2. (From yocto-docs rev: 89b583413e616aafa5f853a7631cac0f97d387db) Signed-off-by: Paul Eggleton <bluelightning@bluelightning.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: add new SDK_ZIP_OPTIONS variablePaul Eggleton2023-04-221-0/+5
| | | | | | | | | Newly added for 4.2. (From yocto-docs rev: e599d82cb3377900632182d216925a2aa44d3989) Signed-off-by: Paul Eggleton <bluelightning@bluelightning.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* migration-guides: add release-notes for 4.0.9Lee Chee Yang2023-04-222-0/+248
| | | | | | | (From yocto-docs rev: cc2f1a4a106d36ec99b7c1bedfcc876839c0c20b) Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* migration-guides: update 4.2 migration and release notesMichael Opdenacker2023-04-132-12/+156
| | | | | | | | | | | | (From yocto-docs rev: 3aac9f8b57434f3852a78915c326074252177515) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> CC: Frederic Martinsons <frederic.martinsons@gmail.com> CC: Marta Rybczynska <rybczynska@gmail.com> CC: Paul Eggleton <paul.eggleton@linux.microsoft.com> CC: Alex Kiernan <alex.kiernan@gmail.com> CC: Alexis Lothoré <alexis.lothore@bootlin.com Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: variables: document VOLATILE_TMP_DIRMichael Opdenacker2023-04-131-0/+12
| | | | | | | | (From yocto-docs rev: 9e66f080b3609e5d51648feec4d6d7ff72644e9e) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> CC: Trevor Woerner <twoerner@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: improve and fix target for supported distrosMichael Opdenacker2023-04-063-4/+4
| | | | | | | | | | - Fix the location of the target for supported distributions - Improve the name of this target (From yocto-docs rev: 40f0cf9302b9f0ce01a1270977644b1b2fdfc650) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* Increase minimum GCC version to 8.0Ross Burton2023-04-041-1/+1
| | | | | | | | | | | | We've increased the minimum GCC version to 8.0[1] so update the documentation to match. [1] sanity.bbclass: Update minimum gcc version to 8.0 (From yocto-docs rev: c74254fa7406c76b26e47b968685115699f95c55) Signed-off-by: Ross Burton <ross.burton@arm.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: classes.rst: fix typoUlrich Ölmann2023-04-031-1/+1
| | | | | | | | (From yocto-docs rev: c6cc3403bcb4b12de74d89f563020669340592ed) Signed-off-by: Ulrich Ölmann <u.oelmann@pengutronix.de> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: fix typosUlrich Ölmann2023-04-031-2/+2
| | | | | | | | (From yocto-docs rev: 79aa7b7bf1690267b1e7900fdf10165be5b460af) Signed-off-by: Ulrich Ölmann <u.oelmann@pengutronix.de> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: add "LTS" termMichael Opdenacker2023-04-034-11/+17
| | | | | | | (From yocto-docs rev: 70536fa188101c8fdd6bbca8343829c4f798ef47) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: release-process.rst: major updatesMichael Opdenacker2023-04-032-16/+1264
| | | | | | | | | | | | - Introduce LTS releases - Fix stable release support duration - Update release notes - Add a diagram illustrating the release process (From yocto-docs rev: d87ef48873ba075a3632f1e2aeb5dc2f8a3400bb) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: release-process.rst: update testing sectionMichael Opdenacker2023-04-031-13/+5
| | | | | | | | | | - Remove note to section not carrying information about special hosts tools for oe-selftest - Add links to mentioned repositories CC: Ross Burton <ross.burton@arm.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: add minimum RAM requirementsMichael Opdenacker2023-04-033-0/+14
| | | | | | | | | | | | Measured by generating a "core-image-sato" image for a "qemux86-64" machine from an Ubuntu 22.04 VM with 4 cores. Less memory was not enough and caused Out of Memory failures. (From yocto-docs rev: a05f87929eed43cef673a8c2581899a8c9ccf462) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>