summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual/variables.rst
Commit message (Collapse)AuthorAgeFilesLines
* ref-manual/variables.rst: improve the PKGV documentationAntonin Godard2025-05-251-0/+17
| | | | | | | | | | It may be confusing for users that source control information is not present in the BitBake environment. Document it as a warning block. (From yocto-docs rev: ba0a321e5c623a9c716be7a451fdd60fae5b26b4) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/variables.rst: HOST_CC_ARCH: fix wrong SDK referenceAntonin Godard2025-05-251-2/+1
| | | | | | | | | | | | | When building for nativesdk recipes, HOST_CC_ARCH equals SDK_CC_ARCH, not BUILDSDK_CC_ARCH which doesn't exist. Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> (From yocto-docs rev: 50cf8b92b6f37ecc7f696f6687980e68cb8286e5) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 08fc3446cb13b5bd8781874d2d996899ce12b082) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/variables.rst: document HOST_*_ARCH variablesAntonin Godard2025-05-251-0/+27
| | | | | | | | | | | | | These variables control the flags for the assembler, compiler and linker, but depend on the context. Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> (From yocto-docs rev: cfc7bce0b7368a6ecfaef7c7df6222f1a6076e9b) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit f8eb33569a5e8cadc036855e2d95eee77e627cb4) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/variables.rst: document missing SDK_*_ARCH variablesAntonin Godard2025-05-251-0/+15
| | | | | | | | | | | | | These variables control the flags for the assembler, compiler and linker when building for nativesdk recipes. Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> (From yocto-docs rev: 028bdce97d62e200e032da6d0c54c0c4109e5a97) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit c08f6d3c8aee86264c069b7c30850cb02de76076) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/variables.rst: add missing documentation for BUILD_* variablesAntonin Godard2025-05-251-20/+230
| | | | | | | | | | | | | | | | | | | | These toolchain variables are used in a native context. Some of the BUILD_* variables missed documentation. Also, some of the base commands were also not there so document them. Some of existing BUILD_* variable documentation were missing the note about their usage in a native context, so add it too so that all BUILD_* variables are documented the same way. [YOCTO #15719] Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> (From yocto-docs rev: f16a641086a7c3546b599a5996c4f7a6db04967e) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 87103afa1cb6690e9aaa87ca1f23e45eaaa359ac) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/variables.rst: add manpage links for toolchain variablesAntonin Godard2025-05-251-9/+11
| | | | | | | | | | | | Use the :manpage: role to provide links to common toolchain utilities. Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> (From yocto-docs rev: f021874bff4e7d30419371564fef41fcfd6d6976) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 7023e5f176efde05a6798476712c8a4e006a6b0d) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation/conf.py: define a manpage urlAntonin Godard2025-05-251-2/+1
| | | | | | | | | | | | | | | | By defining the manpages_url we can use the :manpage: role in the documentation for providing links to manpages. See: https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-manpages_url Replace existing manpages links to use this role. Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> (From yocto-docs rev: f5c964f41ed0f9a9740769e40aabf543df274c03) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 4e63cd74cd1a330ea5e96bb04243a90f607b2857) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/variables.rst: document autotools class related variablesAntonin Godard2025-05-251-0/+17
| | | | | | | | | Document the AUTOTOOLS_SCRIPT_PATH and the CONFIGURE_SCRIPT variables. (From yocto-docs rev: 1065f57bc029e58570de6bb28062c17130e8a102) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/variables.rst: WATCHDOG_TIMEOUT: fix recipe nameAntonin Godard2025-05-251-2/+2
| | | | | | | | | | | | This variable affects the watchdog-config recipe, not the watchdog recipe. (From yocto-docs rev: 619ab9da0c3a121776bbbedc55c64a4e9631e497) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit d3350c38910c47c76ed17f24579120013589ca1f) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: remove OE_IMPORTSRoss Burton2025-03-131-8/+0
| | | | | | | | | | | | | | | | oe-core no longer supports OE_IMPORTS[1], so remove the documentation. [1] oe-core 1f56155e ("base: Switch to use addpylib directive and BB_GLOBAL_PYMODULES") (From yocto-docs rev: f0324b8f14881227336f84325cdebd0518e17796) Signed-off-by: Ross Burton <ross.burton@arm.com> Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit d03dad11974ada7a99b4406e2350b9f5f0acc746) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual: Add missing variable IMAGE_ROOTFS_MAXSIZEWeisser, Pascal2025-03-061-0/+6
| | | | | | | | | | | | | | This patch adds the missing documentation of variable IMAGE_ROOTFS_MAXSIZE to the reference manual. (From yocto-docs rev: 9a1802e70d37c29da750b1156eea7cce1e123f56) Signed-off-by: Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 1dcc8cf7c49da449b324a7bd6bb22effe1d53d70) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual: move runtime-testing section to the test-manualAntonin Godard2025-01-091-10/+10
| | | | | | | | | | | | | | | In the same fashion as the previous commit ("ref-manual/packages: move ptest section to the test-manual"), move the runtime testing section of the development tasks manual to the test environment manual. Add a link to it from the test-manual/intro document. (From yocto-docs rev: 8ac3e2eb1dd4149b24af03666813dc6d94df466d) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 6b44257874858db3aa426d3e84a79c41cb4937a3) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual/packages: move ptest section to the test-manualAntonin Godard2025-01-091-1/+1
| | | | | | | | | | | | | | | | [ YOCTO #15106 ] It makes more sense to document ptests in the test-manual. Since ptests are still related to packages, keep a link to ptests from packages.rst to the test-manual. Reported-by: Yoann Congal <yoann.congal@smile.fr> (From yocto-docs rev: b79d1c8d501418d20c024c92b0ace755dd6b1c88) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit b389c06b709e4791e1cce5e8a5b58f6b0cd03a14) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* SSTATE_MIRRORS/SOURCE_MIRROR_URL: add instructions for mirror authenticationAntonin Godard2025-01-091-0/+53
| | | | | | | | | | | | | | | | | | | | | [ YOCTO #15218 ] There are different ways of configuring the build host when authentication to a mirror (SSTATE_MIRRORS or SOURCE_MIRROR_URL) is required. Document these methods, and begin with the preferred approach which is to edit ~/.netrc appropriately. When that is not possible, specifying the credentials from the URL is also possible, so document it as well. Reported-by: peter.zsifkovits@at.bosch.com Tested-by: Antonin Godard <antonin.godard@bootlin.com> # Debian 12 container (From yocto-docs rev: fbe43aaa28bd0e0ec3884595e07d5d4c59116fb5) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 4c303cce0627e0f2ce52e72597541e220585aaed) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* 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>
* 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-111-0/+3
| | | | | | | | | | | | | | 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>
* 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-291-22/+18
| | | | | | | | | | | | | | | | | 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: 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: 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 new retain class and variablesAntonin Godard2024-10-111-0/+35
| | | | | | | | | | 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 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>
* 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-291-0/+5
| | | | | | | | | | | | 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: 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: variables: Update default INHERIT_DISTRO valueGeoff Parker2024-04-161-1/+1
| | | | | | | | | | | Add remove-libtool and create-spdx to INHERIT_DISTRO defaults per meta/conf/distro/defaultsetup.conf (From yocto-docs rev: a5193a97d774dd6aad09fc756fcd362638d7d2fe) Signed-off-by: Geoff Parker <geoffrey.parker@arthrex.com> Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/variables: add new variables for v5.0Joao Marcos Costa2024-04-121-0/+16
| | | | | | | | | | Add variables newly referenced in release-notes-5.0. (From yocto-docs rev: 1d064cf0e260a1271c2fad7cd01bb154361f6691) Signed-off-by: Joao Marcos Costa <joaomarcos.costa@bootlin.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: variables: document CVE_DB_INCR_UPDATE_AGE_THRES variableYoann Congal2024-04-121-0/+5
| | | | | | | | (From yocto-docs rev: 7f1db309205f9c3cb0b44b6d75d6c65c928787e2) Signed-off-by: Yoann Congal <yoann.congal@smile.fr> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: fix trailing spacesMichael Opdenacker2024-04-081-16/+16
| | | | | | | | | Fixing errors reported by "make sphinx-lint" (From yocto-docs rev: ef6b650c31c4320314564bb85a45eebde3fd98c1) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: add documentation of the variable SPDX_NAMESPACE_PREFIXBELOUARGA Mohamed2024-03-191-0/+5
| | | | | | | | | | | The documentation of the variable SPDX_NAMESPACE_PREFIX does not exist. This variable is used to change the prefix of some links in SPDX docs. (From yocto-docs rev: 85c56d8f7f65875628ab63abf661705b26f55224) Signed-off-by: BELOUARGA Mohamed <m.belouarga@technologyandstrategy.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: use "manual page(s)"Michael Opdenacker2024-03-191-1/+1
| | | | | | | | | | Instead of "manpage(s)" or "man page(s)". To address one of the errors reported by "make stylecheck" (From yocto-docs rev: 86f5f5cd385f09c48c4cf0b1ab222d6e1e7c7e54) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: document VIRTUAL-RUNTIME variablesMichael Opdenacker2024-03-061-5/+32
| | | | | | | | | | | | | | Document the convention to use variables prefixed by VIRTUAL_RUNTIME. Add references to the new term where possible. Another reason is that such variables are recommended in a warning issued by meta/classes-global/insane.bbclass (From yocto-docs rev: 11e1ba97edac979868f199e43c1004db6678044c) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Reported-by: Tim Orling <ticotimo@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: variables: adding multiple groups in GROUPADD_PARAMGeoff Parker2024-03-061-0/+8
| | | | | | | | | | | Add missing documentation on how to add multiple groups with a single GROUPADD_PARAM:${PN} (From yocto-docs rev: e55d2aa6a0ee58ee980de2a6ca8d531c7c0cd44a) Signed-off-by: Geoff Parker <geoffrey.parker@arthrex.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: variables: correct sdk installation default pathJohan Bezem2024-03-061-1/+5
| | | | | | | | | | | | | | | | | | The SDKPATH variable seems mistakenly identified as the default path where the SDK will be installed by the generated installation script, unless option '-d' or a manual input overrides this default. The intended variable is SDKPATHINSTALL. SDKPATH indicates where the SDK is being composed and built. The definitions have been added/updated. (From yocto-docs rev: d5b9c4b9c443cc728a11fd1e0a26a11aac8ee2c5) Signed-off-by: Johan Bezem <jbezem.extern@arri.de> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: variables: remove PYTHON_PNKhem Raj2024-02-241-14/+0
| | | | | | | | | | | PYTHON_PN is on its way out, therefore it's good to remove it from documentation so its use is not promoted anymore. (From yocto-docs rev: 74180c0f6bcdeadbd6f9a69d26f733c716f420fd) Signed-off-by: Khem Raj <raj.khem@gmail.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: suppress excess use of "following" wordMichael Opdenacker2024-02-241-4/+4
| | | | | | | | | | | | | | | | | | To simplify the style, replace "Following is" and "Following are" by "here is" and "here are", sounding more natural. In some cases, also go further by simplifying "Here are/is xxx" by "xxx are/is" when the "are" or "is" are not two far at the end of the sentence. In some cases too, completely remove the sentence, when it's redundant with the preceding title. (From yocto-docs rev: 52ba6bb16c73cbc2c0e77496d5226c49bce786f5) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> CC: Daniel Ammann <daniel.ammann@bytesatwork.ch> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>