summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual
Commit message (Collapse)AuthorAgeFilesLines
* Update the documentation for SRCPVAntonin Godard2024-12-261-33/+26
| | | | | | | | | | | | | | | | | | | | | | | | The variable SRCPV is deprecated since 4.3. Instead of including SRCPV in PV, including the sign "+" is enough for bitbake to add the source control information to PKGV during the packaging phase. Update the documentation for SRCPV and the places where it was used. When instructions previously referred to SRCPV, replace by mentioning to include "+" in the assignment. In most examples, "+git" is added to PV as it is the most popular SCM. Simply adding "+" is also possible, although it is better practice to include the SCM name, so give that example. Update the gcompat example with l3afpad as it didn't include "+git" in its PV definition anymore. (From yocto-docs rev: 3866c09cc0460d25fefc0c831affd89633cf8a7b) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit ee16c96202e5027d1a8d7e89e11c25f127c78326) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* system-requirements.rst: add dependencies for pdf buildsAntonin Godard2024-12-171-0/+27
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | With the recent changes from commit bd6265ca323fac547a197bb516dc4a9ef3897508 ("doc: Makefile: add support for xelatex"), the list of dependencies needs to be updated. The initial list of dependencies was made for Ubuntu/Debian, and the packages were translated for the other distros using pkgs.org. Add them separately from the rest of the dependencies as they pull a _lot_ of additional dependencies (for LaTeX). Move the texlive-fncychap documentation dependency to the PDF specific dependency. Notes: - Fedora/OpenSUSE do not have the "lang-all" texlive collection, so install all available languages. - AlmaLinux does not seem to provide texlive-collection-fontsextra, texlive-collection-lang*, and texlive-collection-latexextra, so add a warning about that. (From yocto-docs rev: 01048d7de570a9d896c5aab294008396e2d78607) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 02c090718ac602f7d4760dd28dadbf0631668d49) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* system-requirements: update list of supported distrosAntonin Godard2024-12-171-0/+8
| | | | | | | | | | | To match the list in meta-poky/conf/distro/poky.conf. (From yocto-docs rev: 02de22c04e51e0ca43394b6d5df2adca0068ca1a) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit c9c3f6896e4bc967a9b394574532735babb70397) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* system-requirements: add fedora 39 to supported distrosAntonin Godard2024-12-171-0/+2
| | | | | | | | | (From yocto-docs rev: 5236193be5297366f23c930be1bf283956d6d257) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit dc7fd0e56fbfed77975f6b4ed2106331476ef7f3) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* Gather dependencies in poky.yaml.inAntonin Godard2024-12-171-9/+13
| | | | | | | | | | | | | | | | | | | We used to have packages here and there in system-requirements.rst for each distro. Instead, gather all the dependencies in poky.yaml.in so we have an overview of what we provide for each distro. Use yaml ">" to list the dependencies in alphabetical order, one entry per line, which makes them easier to read and compare among distros. Rename UBUNTU_… variables to UBUNTU_DEBIAN_…, since these are used for both distros. (From yocto-docs rev: e365a6d5c59f72f4e6a81a0267cbfcda61502d45) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 1ed6118b7cf1b5dcbfca753c83fa30fb97bf44ad) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual: use standardized method accross both ubuntu and debian for ↵Guénaël Muller2024-12-171-0/+17
| | | | | | | | | | | | | | | | | | locale install Modify locale installation method to be standard accross all debian-based distributions. Pre-existing method is available only on Ubuntu, locale-gen tool has no parameter in Debian. (From yocto-docs rev: f0a786c185ca4d8fa1e1f2f64e2af5465d9ac4aa) Signed-off-by: Guénaël Muller <guenael.muller@smile.fr> Reviewed-by: Yoann Congal <yoann.congal@smile.fr> Reviewed-by: Antonin Godard <antonin.godard@bootlin.com> Tested-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 30002019198a168e48537407bb928facb26af82a) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual: classes: fix bin_package descriptionAntonin Godard2024-12-091-17/+28
| | | | | | | | | | | | | | | | | | The previous bin_package description was confusing: it would instruct to use the git fetcher to extract the content of an RPM package using the `subpath` option - but that's not possible as the git fetcher can be used to clone a repository but not to do the extraction. Update the description by telling what it really does and what it doesn't do, and by giving an HTTPS+RPM example. Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> (From yocto-docs rev: 1c60116c666a742838129f0b83007d81f3c0e05d) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 305f024bf99ba02b153eed0cebe3d36594868497) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual: merge two separate descriptions of RECIPE_UPGRADE_EXTRA_TASKSAlexander Kanavin2024-12-091-6/+5
| | | | | | | | | | | | | The second description was added due to confusion over the variable rename in oe-core. (From yocto-docs rev: ff33f7c374c6079af4dc2609e9fb63d705598bc7) Signed-off-by: Alexander Kanavin <alex@linutronix.de> Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit b64fb34643343b364705df9c3bd64af91ed9d687) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* dev-manual: add bblock documentationJulien Stephan2024-11-112-0/+12
| | | | | | | | | | | | | | bblock is a helper tool to lock/unlock tasks and recipes to specific signatures. Add a documentation page for it. (From yocto-docs rev: 5692ad6f023289dda63567c1f79132854ae3899d) Signed-off-by: Julien Stephan <jstephan@baylibre.com> Reviewed-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit a082aa39840587d3af6c3f4a2c2747564ca37414) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual: variables: add SIGGEN_LOCKEDSIGS* variablesJulien Stephan2024-11-111-0/+44
| | | | | | | | | | | | | | | | Variables SIGGEN_LOCKEDSIGS, SIGGEN_LOCKEDSIGS_TASKSIG_CHECK and SIGGEN_LOCKEDSIGS_TYPES are used to lock specific tasks to specific signatures. They are used by bitbake -S <lockedsigs> and bblock, so add documentation for them. (From yocto-docs rev: 3351a0bdeddf7ea930ec9f80f596a9f11671775c) Signed-off-by: Julien Stephan <jstephan@baylibre.com> Reviewed-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 32e3995bed2836f549866ec3b8ad254bdda37dbf) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual: devtool-reference: document missing commandsAntonin Godard2024-11-021-0/+54
| | | | | | | | | | | | Give a brief description for important commands that made it into devtool or that were missing from this quick reference document. (From yocto-docs rev: 349e1a5194e3497d29de25a788ff429496517c3c) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 6238adae1b072c9e09c558038d397dfac6ec109f) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual: devtool-reference: refresh example outputsAntonin Godard2024-11-021-11/+7
| | | | | | | | | | | | Previous outputs were missing some commands and options, some others were obsolete. (From yocto-docs rev: 82e374974424f91d2bd59d86414e19b0297de82f) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 1c83037707b4c981a70c968ba04ded502f9bffbf) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual: release-process: add a reference to the doc's releaseAntonin Godard2024-11-021-0/+2
| | | | | | | | | | | | | | When reading the stable releases section, we want to know for which release the documentation was built. Use &DISTRO_NAME; to refer to the current release. Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> (From yocto-docs rev: da11223e77e3bfae79806cb9522fae03446dbf41) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 05ee6844d710beb844bbdac892888879847f6d22) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual: release-process: update releases.svg with month after "Current"Antonin Godard2024-11-021-9/+9
| | | | | | | | | | | | | | | | This way we put a timestamp on the image, so that someone looking at the image on an old release tarball has a representation of the release "as of <date>". Here set "Oct. 24" as it was the last time the file was updated. Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> (From yocto-docs rev: 5c933f4d5f1680b25e593fafa429870bbb52ecb2) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 7b62bbec900bc84a31e4686839e774ba7bd5ae9f) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual: release-process: refresh the current LTS releasesAntonin Godard2024-10-291-6/+9
| | | | | | | | | | | | | | Mention that Scarthgap the latest LTS in a bullet list next to Kirkstone. Reword the parapraph a bit to make it clearer after this change. Reviewed-by: Michael Opdenacker <michael.opdenacker@rootcommit.com> (From yocto-docs rev: 7d19dd0d5cc2037b8ad48d89633ae073c13586a9) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit afeded9939777d88bf4cb9ebf7a61aadd476642d) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual: release-process: update releases.svgAntonin Godard2024-10-291-561/+346
| | | | | | | | | | | | | * Add Walnascar release. * Remove dunfell, gatesgarth, hardknott, honister: these release are not supported anymore. Start from kirkstone, which is still supported. (From yocto-docs rev: 78f5cc6c6033477ddd253d53146481e9b885d271) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit aa9a580c8c57af4baa4fb24a43487fb7afc258e5) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual: faq: add q&a on class appendsAntonin Godard2024-10-291-0/+19
| | | | | | | | | | | | | | Add the suggestion by Richard to the FAQ, with some minor rewordings and additional punctuations. Suggested-by: Richard Purdie <richard.purdie@linuxfoundation.org> Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> (From yocto-docs rev: 7de91ada04715103776497971b34d28f24f7148a) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 2466a5e7973bf6e724f1cf0b42f838065847d283) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual: structure.rst: document missing tmp/ dirsAntonin Godard2024-10-291-2/+33
| | | | | | | | | | | | | | | | Document `hosttools/`, `pkgdata/` and add some more information on `work-shared/`. Adresses [YOCTO #14543]. Reported-by: Robert P. J. Day <rpjday@crashcourse.ca> Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> (From yocto-docs rev: e1ac30dfffddab6e82c708486f8a31f9ec4b1d58) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 372b5b4ca55819c294970b20aa8b8d8167144329) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* docs: Replace VOLATILE_TMP_DIR with FILESYSTEM_PERMS_TABLESNiko Mauno2024-10-291-19/+9
| | | | | | | | | | | | | | | | | The VOLATILE_TMP_DIR variable was removed and it's functionality replaced with a FILESYSTEM_PERMS_TABLES entry in https://git.yoctoproject.org/poky/commit/?id=2f46b6f27dfa3a9d5ad177900fcecfe64c3536f1 ("bitbake.conf: drop VOLATILE_TMP_DIR, use FILESYSTEM_PERMS_TABLES instead") (From yocto-docs rev: 92aef324d06f1f257fc3896b63c4c744d19c0853) Signed-off-by: Niko Mauno <niko.mauno@vaisala.com> Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Reviewed-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 1ef0eabaa07cc39075a040b99a5c11567d745408) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* docs: Replace VOLATILE_LOG_DIR with FILESYSTEM_PERMS_TABLESNiko Mauno2024-10-292-24/+21
| | | | | | | | | | | | | | | | | The VOLATILE_LOG_DIR variable was removed and it's functionality replaced with a FILESYSTEM_PERMS_TABLES entry in https://git.yoctoproject.org/poky/commit/?id=2f8806deb7655b37d6f8d12ff54680d6acf7a298 ("bitbake.conf: drop VOLATILE_LOG_DIR, use FILESYSTEM_PERMS_TABLES instead") (From yocto-docs rev: 8632cd1070da26f217046071c43dd2f877f2e608) Signed-off-by: Niko Mauno <niko.mauno@vaisala.com> Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Reviewed-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit b1c22561878ba618eb69e4c8784ea346b989a0ea) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual: fix ordering of insane checks listAntonin Godard2024-10-291-3/+3
| | | | | | | | | | | | | It should be before "perllocalpod" and after "patch-status". Reported-by: Quentin Schulz <quentin.schulz@cherry.de> Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> (From yocto-docs rev: 96ff6bd571a185b4e2c6174f2cc937994efe4cd5) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 1304b899cd4480f80eaeb6e58d57e87d3d2f6911) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual: add mission pep517-backend sanity checkAntonin Godard2024-10-111-0/+3
| | | | | | | | | New sanity check to check for PEP517-backend compliance. (From yocto-docs rev: 24e5bbeefe989e22ecdf5e86f48432e437330cc2) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: merge patch-status-* to patch-statusAntonin Godard2024-10-111-6/+2
| | | | | | | | | These are not distinct anymore and check for any patches in any layer. (From yocto-docs rev: 300c585909743754e0e6662d48d43834c031b835) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: add missing variable PRSERV_UPSTREAMAntonin Godard2024-10-111-0/+5
| | | | | | | (From yocto-docs rev: 94a590aad8d503c5d5528bff4d8ec07746ca9805) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: add missing OPKGBUILDCMD variableAntonin Godard2024-10-111-0/+7
| | | | | | | (From yocto-docs rev: a6a2c8e48995200c9c3be7096f34d912427de145) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: drop TCLIBCAPPEND variableAntonin Godard2024-10-111-13/+0
| | | | | | | | | | No longer required as TMPDIR can be shared for multiple lib providers nowadays. (From yocto-docs rev: 6690c0aee9e7f0dcc63ccbe19657b78963240610) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: add missing EXTERNAL_KERNEL_DEVICETREE variableAntonin Godard2024-10-111-0/+7
| | | | | | | | | | | This variable can be used to specify one or more compiled device tree or device tree overlays to use in addition to the one compiled by the kernel. (From yocto-docs rev: 6566ffceab3780dc5ecbfe26f786ebe6ff17e693) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: add missing image manifest variablesAntonin Godard2024-10-111-0/+29
| | | | | | | | | New variables that control the output of the image task manifests. (From yocto-docs rev: e46af38733ae581c4aa180efc226d8a34ea4e590) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: add missing TESTIMAGE_FAILED_QA_ARTIFACTSAntonin Godard2024-10-111-0/+5
| | | | | | | | | | This variable lists space-separated paths on the target to retrieve onto the host, when inheriting testimage. (From yocto-docs rev: 2537642d2cdf844dc5f6027fb3097aac52162c1f) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: drop siteconfig classAntonin Godard2024-10-111-9/+0
| | | | | | | | | | Removed as it was only used by ncurses and zlib and adding minimal added-value for a considerable amount of added runtime. (From yocto-docs rev: c35688a0f4cb115c63387cc15fd15ec57cb386fb) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: add new RECIPE_UPGRADE_EXTRA_TASKS variableAntonin Godard2024-10-111-0/+5
| | | | | | | (From yocto-docs rev: c80bc42afa40fd9eb5acaba24da3ad3b5915a254) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: add missing nospdx classAntonin Godard2024-10-111-0/+8
| | | | | | | (From yocto-docs rev: ec41a5bf1a49e5d83bb93a3438ba1cd01f613088) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: add new retain class and variablesAntonin Godard2024-10-112-0/+52
| | | | | | | | | | Document the new `retain` class with its configuration variables in the variable index. (From yocto-docs rev: b62f1be5dada0fb760ff7e0806b16225f7261560) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: add new vex classAntonin Godard2024-10-111-0/+25
| | | | | | | | | | Add a brief description on the new vex.bbclass that is used to generate metadata needed by external tools to check for vulnerabilities. (From yocto-docs rev: 32cf3414f5ed127f59119e38639bc8dbd57b7891) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: add missing CVE_CHECK manifest variablesAntonin Godard2024-10-111-0/+12
| | | | | | | | | | Variables that can be used for toggling creation of manifest and specifying the path to the output in the deploy directory. (From yocto-docs rev: 14131a42a7ea8bbae2165c1b8dbcabd5f28b2b22) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* doc/features: describe distribution feature pni-nameJörg Sommer2024-09-201-0/+4
| | | | | | | | | (From yocto-docs rev: c32b55b3403dcfd76a4694ff407d4b513e14c8f4) Signed-off-by: Jörg Sommer <joerg.sommer@navimatix.de> Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> Signed-off-by: Alexandre Belloni <alexandre.belloni@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* doc/features: remove duplicate word in distribution feature ext2Jörg Sommer2024-09-201-1/+1
| | | | | | | | (From yocto-docs rev: 20a5986ec3395f83e8469b08dd79f019e2051626) Signed-off-by: Jörg Sommer <joerg.sommer@navimatix.de> Signed-off-by: Alexandre Belloni <alexandre.belloni@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: added wic.zst to the IMAGE_TYPESJan Vermaete2024-08-221-0/+1
| | | | | | | | | (From yocto-docs rev: da5c0dae1101aae2db15f9f91c980e26c74eb739) Signed-off-by: Jan Vermaete <jan.vermaete@gmail.com> Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> Signed-off-by: Alexandre Belloni <alexandre.belloni@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: fix typo and move SYSROOT_DIRS exampleMatthias Pritschet2024-08-221-24/+24
| | | | | | | | | | | 1. Changed one letter (s/B/A), so the sentence is correct again. 2. Moved example from SYSROOT_DIRS_IGNORE into SYSROOT_DIRS section. (From yocto-docs rev: 7d762fbad07bf16a0a657169c09a3e402dabbe90) Signed-off-by: Matthias Pritschet <matthias@pritschet.eu> Signed-off-by: Alexandre Belloni <alexandre.belloni@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: add DEFAULT_TIMEZONE variableJörg Sommer2024-07-091-0/+7
| | | | | | | | | (From yocto-docs rev: 89323e4d95c7e98c685ad2843f037a291af08b02) Signed-off-by: Jörg Sommer <joerg.sommer@navimatix.de> Reviewed-by: Michael Opdenacker <michael@opdenacker.org> Signed-off-by: Alexandre Belloni <alexandre.belloni@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: add RECIPE_UPDATE_EXTRA_TASKS variableTim Orling2024-06-161-0/+7
| | | | | | | | | | | Document the new RECIPE_UPDATE_EXTRA_TASKS variable and give cargo-update-recipe-crates as a concrete example. (From yocto-docs rev: 9cc4e395571dcef58d9d8545c08d9fdf8070bb32) Signed-off-by: Tim Orling <tim.orling@konsulko.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: introduce CVE_CHECK_REPORT_PATCHED variableAleksandar Nikolic2024-06-161-0/+6
| | | | | | | | | (From yocto-docs rev: f585a68a8f35f31814e408dd973ea7345adbbacf) Signed-off-by: Aleksandar Nikolic <an010@live.com> Reviewed-by: Michael Opdenacker <michael@opdenacker.org> Signed-off-by: Alexandre Belloni <alexandre.belloni@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: introduce UNPACKDIR variableMichael Opdenacker2024-05-292-5/+9
| | | | | | | | | | | | Note that this doesn't touch the "Source Fetching" section in overview-manual/concepts.rst yet, as the unpack implementation may not be finalized yet. (From yocto-docs rev: 2c892663c3e2d72493ee29898e99335a1e45c01f) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Reviewed-by: Andrew Murray <amurray@thegoodpenguin.co.uk> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: variables: document PYPI_PACKAGE_EXT, PYPI_SRC_URITrevor Gamblin2024-05-291-0/+13
| | | | | | | | | | | These are variables that some Python recipes are starting to use, but there is no documentation for them currently in the reference manual. (From yocto-docs rev: 78cde86cc31f238b8b31569ac9df2eeb15ef5e33) Signed-off-by: Trevor Gamblin <tgamblin@baylibre.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: document NVDCVE_API_KEY variableNoe Galea2024-05-291-0/+15
| | | | | | | | | | | | | Add brief documentation of NVDCVE_API_KEY variable, that was added in 4.2.3, and emphasize that its use results in lower NVD API request times. (From yocto-docs rev: 9c7b452441bad2d7c929383d4665dfddb8f7ea72) Signed-off-by: Noe Galea <ngalea@thegoodpenguin.co.uk> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Reviewed-by: Andrew Murray <amurray@thegoodpenguin.co.uk> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: update releases.svgMichael Opdenacker2024-05-091-38/+61
| | | | | | | | | | - Make Scarthgap a current release - Add Styhead (From yocto-docs rev: 4ff729c58d462cf8513e6339a5518e1c5b56f54a) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: variables: add USERADD_DEPENDSPaul Eggleton2024-04-241-0/+6
| | | | | | | | | | New variable in 5.0. (From yocto-docs rev: 57a9117a8c4c020b2f643d6835af29b4e49f4f7f) Signed-off-by: Paul Eggleton <bluelightning@bluelightning.org> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: variables: add TARGET_DBGSRC_DIRPaul Eggleton2024-04-161-0/+4
| | | | | | | | | | New variable in 5.0. (From yocto-docs rev: 047780931ec8156d77ec10f3f051bd98b83714f8) 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: classes: cve_check: add note about remote patchesPaul Eggleton2024-04-161-0/+7
| | | | | | | | | | Document the change in behaviour in 5.0. (From yocto-docs rev: f7a223d4e78bee67107fa47e147208f57a2d9521) 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: add new python classesPaul Eggleton2024-04-161-0/+18
| | | | | | | | | | | Add brief documentation of python_maturin and python_mesonpy classes that were added in 5.0. (From yocto-docs rev: ce7dd61a928dec778a5df538701dfdeb26db0ebd) 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>