summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual
Commit message (Collapse)AuthorAgeFilesLines
* ref-manual/structure.rst: extend PERSISTENT_DIR descriptionAntonin Godard8 days1-0/+11
| | | | | | | | | | | | | | Extend the description of PERSISTENT_DIR to mention that it should not be shared between builds. Add a note on sharing the hash equivalence database by setting up a server and not sharing the file in this directory. [YOCTO #15727] (From yocto-docs rev: 0ff0233770b77f9e74f4241dfb555dac2741d8b9) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/kickstart.rst: add extra-partition-spacePierre-Loup GOSSE2025-09-161-1/+11
| | | | | | | | | | | | | | | | After commits 47533f20a7ec ("wic: rename wks flag --extra-space to --extra-filesystem-space") and c7f51c23fd268 ("wic: add --extra-partition-space option to set unused space") in openembedded-core, document the new Wic-specific option extra-partition-space and rename the extra-space option to extra-filesystem-space. CC: Alexander Kanavin <alex.kanavin@gmail.com> (From yocto-docs rev: cba5dbb32a24c9e20e5a6066ec382cf7ff9b93e2) Signed-off-by: Pierre-Loup GOSSE <pierre-loup.gosse@smile.fr> Reviewed-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/variables.rst: expand IMAGE_OVERHEAD_FACTOR glossary entryJoao Marcos Costa2025-09-161-0/+6
| | | | | | | | | | | | | | | | | | | | | | There's a (second) overhead factor applied in images generated with Wic, and this is already documented in the .wks reference. However, the IMAGE_OVERHEAD_FACTOR entry does not mention it, and by looking at the partition sizes (e.g. with parted) one may find it confusing that they don't match with the expected rootfs size (e.g. in a scenario where the extra space is "0" and IMAGE_OVERHEAD_FACTOR="1.0"). This second overhead is already documented, though: https://docs.yoctoproject.org/ref-manual/kickstart.html#command-part-or-partition Mention the '--overhead-factor' option in the glossary entry and add a reference to the wks documentation. (From yocto-docs rev: b9040e20b015e9b02683ec3014e4ade5eb59d41a) Signed-off-by: Joao Marcos Costa <joaomarcos.costa@bootlin.com> Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/terms.rst: sort entriesAntonin Godard2025-08-081-13/+13
| | | | | | | | | | | | | | | | | | | | | | | documentation/scripts/check-glossaries returns: WARNING: ref-manual/terms.rst: entries are not properly sorted: --- original_list +++ sorted_list @@ -17,8 +17,8 @@ LTS Metadata Mixin +OpenEmbedded Build System OpenEmbedded-Core (OE-Core) -OpenEmbedded Build System Package Package Groups Poky (From yocto-docs rev: e3c05f82596239c12dcb9871e6dac434c46bacec) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/variables.rst: sort variablesAntonin Godard2025-08-081-129/+129
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | documentation/scripts/check-glossaries returns: WARNING: ref-manual/variables.rst: entries are not properly sorted: --- original_list +++ sorted_list @@ -12,8 +12,8 @@ ASSUME_PROVIDED ASSUME_SHLIBS AUTO_LIBNAME_PKGS +AUTO_SYSLINUXMENU AUTOREV -AUTO_SYSLINUXMENU AUTOTOOLS_SCRIPT_PATH AVAILTUNES AZ_SAS @@ -28,8 +28,8 @@ BB_CACHEDIR BB_CHECK_SSL_CERTS BB_CONSOLELOG +BB_CURRENT_MC BB_CURRENTTASK -BB_CURRENT_MC BB_DEFAULT_TASK BB_DEFAULT_UMASK BB_DEFER_BBCLASSES @@ -188,13 +188,13 @@ CVE_CHECK_REPORT_PATCHED CVE_CHECK_SHOW_WARNINGS CVE_CHECK_SKIP_RECIPE +CVE_CHECK_STATUSMAP +CVE_CHECK_VEX_JUSTIFICATION CVE_DB_INCR_UPDATE_AGE_THRES CVE_DB_UPDATE_INTERVAL CVE_PRODUCT CVE_STATUS CVE_STATUS_GROUPS -CVE_CHECK_STATUSMAP -CVE_CHECK_VEX_JUSTIFICATION CVE_VERSION CVSDIR CXX @@ -254,9 +254,8 @@ EXCLUDE_FROM_WORLD EXTENDPE EXTENDPKGV +EXTERNAL_KERNEL_DEVICETREE EXTERNAL_KERNEL_TOOLS -EXTERNAL_KERNEL_DEVICETREE -KERNEL_LOCALVERSION EXTERNAL_TOOLCHAIN EXTERNALSRC EXTERNALSRC_BUILD @@ -267,8 +266,8 @@ EXTRA_OECMAKE EXTRA_OECONF EXTRA_OEMAKE +EXTRA_OEMESON EXTRA_OESCONS -EXTRA_OEMESON EXTRA_USERS_PARAMS EXTRANATIVEPATH FAKEROOT @@ -300,8 +299,8 @@ FIT_KEY_GENRSA_ARGS FIT_KEY_REQ_ARGS FIT_KEY_SIGN_PKCS +FIT_PAD_ALG FIT_SIGN_ALG -FIT_PAD_ALG FIT_SIGN_INDIVIDUAL FIT_SIGN_NUMBITS FIT_UBOOT_ENV @@ -431,6 +430,7 @@ KERNEL_IMAGE_NAME KERNEL_IMAGETYPE KERNEL_IMAGETYPES +KERNEL_LOCALVERSION KERNEL_MODULE_AUTOLOAD KERNEL_MODULE_PROBECONF KERNEL_PACKAGE_NAME @@ -505,15 +505,15 @@ OBJCOPY OBJDUMP OE_BINCONFIG_EXTRA_MANGLE -OECMAKE_GENERATOR OE_INIT_ENV_SCRIPT OE_SHARED_UMASK OE_TERMINAL -OEROOT +OECMAKE_GENERATOR OEQA_REPRODUCIBLE_TEST_LEAF_TARGETS OEQA_REPRODUCIBLE_TEST_PACKAGE +OEQA_REPRODUCIBLE_TEST_SSTATE_TARGETS OEQA_REPRODUCIBLE_TEST_TARGET -OEQA_REPRODUCIBLE_TEST_SSTATE_TARGETS +OEROOT OLDEST_KERNEL OPKG_MAKE_INDEX_EXTRA_PARAMS OPKGBUILDCMD @@ -691,11 +691,11 @@ SPDX_ARCHIVE_PACKAGED SPDX_ARCHIVE_SOURCES SPDX_CUSTOM_ANNOTATION_VARS +SPDX_INCLUDE_COMPILED_SOURCES SPDX_INCLUDE_SOURCES -SPDX_INCLUDE_COMPILED_SOURCES SPDX_NAMESPACE_PREFIX +SPDX_PACKAGE_URL SPDX_PACKAGE_VERSION -SPDX_PACKAGE_URL SPDX_PRETTY SPDXLICENSEMAP SPECIAL_PKGSUFFIX @@ -707,12 +707,12 @@ SPL_SIGN_KEYNAME SPLASH SPLASH_IMAGES -SRCREV_FORMAT SRC_URI SRC_URI_OVERRIDES_PACKAGE_ARCH SRCDATE SRCPV SRCREV +SRCREV_FORMAT SRCTREECOVEREDTASKS SSTATE_DIR SSTATE_EXCLUDEDEPS_SYSROOT @@ -779,9 +779,9 @@ TARGET_PREFIX TARGET_SYS TARGET_VENDOR +TC_CXX_RUNTIME TCLIBC TCMODE -TC_CXX_RUNTIME TEMPLATECONF TEST_EXPORT_DIR TEST_EXPORT_ONLY @@ -804,9 +804,9 @@ TOOLCHAIN TOOLCHAIN_HOST_TASK TOOLCHAIN_HOST_TASK_ESDK +TOOLCHAIN_NATIVE TOOLCHAIN_OPTIONS TOOLCHAIN_OUTPUTNAME -TOOLCHAIN_NATIVE TOOLCHAIN_TARGET_TASK TOPDIR TRANSLATED_TARGET_ARCH @@ -860,13 +860,13 @@ UBOOT_SUFFIX UBOOT_TARGET UBOOT_VERSION -UKIFY_CMD UKI_CMDLINE UKI_CONFIG_FILE UKI_FILENAME UKI_KERNEL_FILENAME UKI_SB_CERT UKI_SB_KEY +UKIFY_CMD UNKNOWN_CONFIGURE_OPT_IGNORE UNPACKDIR UPDATERCPN @@ -897,7 +897,7 @@ WKS_FILES WORKDIR XSERVER +XZ_MEMLIMIT XZ_THREADS -XZ_MEMLIMIT ZSTD_COMPRESSION_LEVEL ZSTD_THREADS (From yocto-docs rev: 5cc4f262844a202553112a01f7203c9220d30fae) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/variables.rst: fix the glossaryAntonin Godard2025-08-081-2/+2
| | | | | | | | | | | | documentation/scripts/check-glossaries returns: WARNING: ref-manual/variables.rst: The variable EFI_PROVIDER shouldn't be in the glossary. WARNING: ref-manual/variables.rst: The variable ZSTD_THREADS shouldn't be in the glossary. (From yocto-docs rev: 4d3952414d109f9c9ebb029f3e20018664eacc86) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* Add a script to validate documentation glossariesAntonin Godard2025-08-081-0/+6
| | | | | | | | | | | | | | | | | | | | Instead of tracking the glossary manually, add a small script that checks if it is properly sorted. Add two comments between the start and end of the glossary for the script to know where it's located. The script also checks if the variables are properly sorted. It uses difflib and returns the diff if there's a difference between the unsorted and sorted list. Messages beginning with "WARNING:" are reported by the Autobuilder, which is the reason for this format. (From yocto-docs rev: 416d50c0c322eb88bf13353a198db7211e4d665a) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* docs-wide: fix space around equal assignmentsAntonin Godard2025-08-081-3/+3
| | | | | | | | | | | | | Since commit 24772dd2ae6c ("parse/ConfHandler: Add warning for deprecated whitespace usage") in BitBake, a warning is printed when there are no spaces around an `=` assignment. Adjust the documentation to show good examples only. (From yocto-docs rev: 77ce1544dd793036b1135817c02e090138fe6407) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/qa-checks.rst: add space around equal warningAntonin Godard2025-08-081-0/+16
| | | | | | | | | | | | | After commit 24772dd2ae6c ("parse/ConfHandler: Add warning for deprecated whitespace usage") in BitBake, a warning is printed is there's a missing space around an equal assignment in recipes. Add a qa-check entry to qa-checks.rst. (From yocto-docs rev: da2e9d45a4c70c5d78d225277a85cc4173e4ee7a) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/tasks.rst: do_package_qa: update link to qa checksAntonin Godard2025-08-081-1/+1
| | | | | | | | | | | Link to the updated qa-checks document that contains the entire list of checks. The insane class was recently updated to remove all its checks description and move them to qa-checks.rst. (From yocto-docs rev: 0fcd1a352ae364bee191e7d160b2fec35431fcfd) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* docs-wide: update wic source plugin namesAntonin Godard2025-08-082-3/+3
| | | | | | | | | | | WIC plugins were renamed after commit 2de444fc3ef4 ("wic: plugins source bootimage/isoimage rename to allow be imported") in OE-Core. They no longer contain dashes, but underscores. (From yocto-docs rev: 7224d7733e9e0f423475e1b9c5b48aff0de1f744) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/classes.rst: document the testexport classAntonin Godard2025-08-081-0/+16
| | | | | | | | | | | This class has been in OE-Core for a while but never documented in the reference manual. Add some description for it and link to the existing documentation on it. (From yocto-docs rev: 362a331255525fc853dab3af4ec905c417fabb0b) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/variables.rst: document CVE_CHECK_VEX_JUSTIFICATIONAntonin Godard2025-08-081-0/+7
| | | | | | | | | | Added by commit c0fa3d92cefa ("spdx30: Allow VEX Justification to be configurable") in OE-Core. (From yocto-docs rev: cee3eb30cc736d990f2232ede0bc6d9686a63713) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/variables.rst: document OE_SHARED_UMASKAntonin Godard2025-08-081-0/+5
| | | | | | | | | | Added by commit ce32daa9843b ("bitbake.conf/sstate: Introduce OE_SHARED_UMASK to standarise shared area umask") in OE-Core. (From yocto-docs rev: b0a6f80a3216faf6c6add785aab2257a53b667dc) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/classes.rst: document the go-mod-update-modules classAntonin Godard2025-08-081-0/+15
| | | | | | | | | | Added by commit 34bb889ffaae ("classes/go-mod-update-modules: add class to generate module list") in OE-Core. (From yocto-docs rev: b1a9848d2bba9e1392d153ff992304b83b259318) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/variables.rst: document UBOOT_VERSIONAntonin Godard2025-08-081-0/+6
| | | | | | | | | | Added by commit debc691853e2 ("u-boot: Allow for customizing installed/deployed file names") in OE-Core. (From yocto-docs rev: a9a4bcc754b9400fa6d3c0297e86771f03325590) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/variables.rst: document SPL_DTB_BINARYAntonin Godard2025-08-082-0/+8
| | | | | | | | | This variable is part of uboot-sign but not documented. (From yocto-docs rev: 05eb461cb1da76ad9cbaf634da7f47447b3f6765) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/variables.rst: add link for BB_DEFER_BBCLASSESAntonin Godard2025-08-081-0/+3
| | | | | | | | | | Added by commit 8e741b2e885a ("ast/BBHandler: Add support for BB_DEFER_BBCLASSES") in BitBake. (From yocto-docs rev: bf3c2ade55e4d90dd50f39d01405352cd48c1703) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/variables.rst: document the FIT_CONF_PREFIX variableAntonin Godard2025-08-081-0/+4
| | | | | | | | | | Added by commit 7892ee3dc37d ("kernel-fitimage: allow overriding FIT configuration prefix") in OE-Core, but never documented. (From yocto-docs rev: 860891492b96eb127af5e7bab6348fca12167c68) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* Drop the icecc class and related variablesAntonin Godard2025-08-082-161/+2
| | | | | | | | | | | | | Dropped by commit ecf8c386cf83 ("classes/recipes-devtools: Drop icecc from OE-Core") in OE-Core. Remove documentation for the class and the related variables. Remove the references to this class. (From yocto-docs rev: 30c9413c5106bcbcc1600ef16b8d0cece86d8158) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/variables.rst: document PSEUDO_INCLUDE_PATHSAntonin Godard2025-08-081-0/+7
| | | | | | | | | | Added by commit 2502da81709f ("bitbake.conf/pseudo: Switch from exclusion list to inclusion list") in OE-Core. (From yocto-docs rev: 5fc49ee007d22c7dc28c11ea579c804881b9cb8f) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/variables.rst: document TESTSDK_SUITESAntonin Godard2025-08-082-0/+9
| | | | | | | | | | The TESTSDK_SUITES variable can be used to control the list of test modules run with the testsdk class. (From yocto-docs rev: fbc6db0ab525c7e46774c01fc595f30d6d0fe3c1) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/variables.rst: document KMETA_CONFIG_FEATURESAntonin Godard2025-08-081-0/+13
| | | | | | | | | | The KMETA_CONFIG_FEATURES variable defines kernel-yocto features to enable. (From yocto-docs rev: 1a9f68b875a78c1c7681ed300111399de97631e6) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/variables.rst: document SPDX_PACKAGE_URLAntonin Godard2025-08-081-0/+6
| | | | | | | | | Used for SPDX3 software_packageUrl field. (From yocto-docs rev: 108549dae76a582bc98d3b7bd976e0239a6b92a6) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/tasks.rst: add documentation for do_recipe_qaAntonin Godard2025-08-081-0/+11
| | | | | | | | | | Document the do_recipe_qa task in classes.rst and link to the insane class documentation. (From yocto-docs rev: d3f172b600413b58ee51c70e9dd4f69b32fdc5f8) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/system-requirements.rst: update supported distributionsAntonin Godard2025-08-081-28/+29
| | | | | | | | | | | | | | | | | | | | | | Update the distributions to match the list of workers on the Autobuilder. This list was generated with the help of yocto-autobuilder-helper/scripts/yocto-supported-distros. Also: - Sort the lists alphabetically. - Decrease spacing between entries for readability. - Remove older Ubuntu distributions that are not tested on the Autobuilder anymore. - Fill the second list with EOL distros still running on the Autobuilder. - Empty the third list as it does not make sense to maitain on the master branch. (From yocto-docs rev: 56a7e8c209e804896558d759525d0c0317ac0ff5) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: gather all QA checks in qa-checks.rstAntonin Godard2025-08-012-752/+476
| | | | | | | | | | | | | | | | | There was duplication between qa-checks.rst and the doc for the insane class, so move all of the QA checks in this qa-checks.rst. Remove the documentation for these checks from classes.rst and link to the qa-checks.rst document from there. For QA checks that were only documented only in classes.rst, add them to qa-checks.rst. Also sort qa-checks by their names in qa-checks.rst. (From yocto-docs rev: dc984e5f54c38748603243053fde8b4d078ba586) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/classes.rst: drop obsolete QA errorsAntonin Godard2025-08-011-13/+0
| | | | | | | | | | Drop after commit 068d38214307 ("insane: remove obsolete QA errors") from OE-Core. (From yocto-docs rev: e5667ae2da1805327ecfff68300c0c460da49b91) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/classes.rst: insane: drop cve_status_not_in_dbAntonin Godard2025-08-011-5/+0
| | | | | | | | | | This was dropped by commit 452e605b55ad ("cve-check: annotate CVEs during analysis"). (From yocto-docs rev: 55aedec94dce3e3c0541ffaea666cff02d63a708) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: document new toolchain classes and variablesAntonin Godard2025-08-012-0/+158
| | | | | | | | | | | Document the new classes under classes/toolchain as well as PREFERRED_TOOLCHAIN* and TOOLCHAIN variables, which allow selecting the toolchain. For now there's "gcc" and "clang" as available toolchain. (From yocto-docs rev: 69a9568f8bd7ed57efddab507a4294ad3408f4dd) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* variables.rst: remove references to obsolete tar packagingRobert P. J. Day2025-08-011-10/+4
| | | | | | | | | | | The tar packaging format was removed some time ago. Also, add some minor grammatical tweaking. (From yocto-docs rev: 8e9fd1ca232f3c1e8be51cb881a68b4745ee548a) Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/structure.rst: remove shared PERSISTENT_DIR mentionsAntonin Godard2025-07-151-11/+0
| | | | | | | | | | | PERSISTENT_DIR should _not_ be shared, I got that wrong in my previous commit 741aa29898dc ("ref-manual/structure.rst: update with info on PERSISTENT_DIR"). Remove these mentions. (From yocto-docs rev: 4c7fc7a6e9b0b957bcf0deb66adb0a6d9ebead00) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/structure.rst: update with info on PERSISTENT_DIRAntonin Godard2025-07-111-1/+13
| | | | | | | | | | | | Since we mention that SSTATE_DIR can be shared for multiple builds, also mention that PERSISTENT_DIR should be shared alongside SSTATE_DIR. [YOCTO #15921] (From yocto-docs rev: 741aa29898dc7f34ebd423ff7565334b2c89e18c) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/variables.rst: make reference to new limiting-resources docAntonin Godard2025-07-111-7/+25
| | | | | | | | | | For host resource limiting variables, make a reference to the new "Limiting the Host Resources Usage" document. (From yocto-docs rev: 161a8549441e8c38791ab7f63001b2a15a39d2f2) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/yocto-project-supported-features: update contact for meta-intelLee Chee Yang2025-07-041-1/+1
| | | | | | | | (From yocto-docs rev: 083f4c60128d16756c78f61c4cade49e11764034) Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: classes: add recipe-naming QA testRoss Burton2025-07-041-0/+4
| | | | | | | | | | Add documentation for the new recipe-naming recipe QA test. (From yocto-docs rev: 8f9ad9681c18412e9eedc014e686b1b72e458687) Signed-off-by: Ross Burton <ross.burton@arm.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/yocto-project-supported-features: add ppc maintainersAdrian Freihofer2025-06-301-1/+2
| | | | | | | | | | | | | | | | PowerPC (32-bit) remains relevant for our use cases, and we aim to maintain support as long as it is feasible with reasonable effort. For transparency, our primary focus is on maintaining core-image-minimal. Support for more complex images may be limited unless additional contributors join, as ongoing testing and maintenance of these images may not be feasible otherwise. (From yocto-docs rev: 63f0053f0f0201529bfad3e3f1b0211ac40ad1c2) Signed-off-by: Adrian Freihofer <adrian.freihofer@siemens.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/variables.rst: document BB_GIT_DEFAULT_DESTSUFFIXAntonin Godard2025-06-301-0/+7
| | | | | | | | | | Recently added in BitBake with 378db0fdd95f ("fetch2/git: allow overriding default unpack directory with a variable"). (From yocto-docs rev: c696f78107a4e0a26329faad11212eb7949e0c70) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: correct references to WORKDIR to account for recent do_unpack ↵Alexander Kanavin2025-06-302-14/+4
| | | | | | | | | | changes (From yocto-docs rev: 2e83260484c102fe7b788585cbdd7ca91ba91d85) Signed-off-by: Alexander Kanavin <alex@linutronix.de> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: drop a sentence about a 'legacy way' to specify UNPACKDIRAlexander Kanavin2025-06-301-2/+1
| | | | | | | | | | | | This wasn't specific, and is obsolete: UNPACKDIR should not be set by recipes at all, except in very special circumstances (e.g. gcc/clang unpacking into work-shared). (From yocto-docs rev: a880d94d70c7ed1da8e40a02dae43ff1699941a6) Signed-off-by: Alexander Kanavin <alex@linutronix.de> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: document KERNEL_SPLIT_MODULES variableDixit Parmar2025-06-301-0/+21
| | | | | | | | | | | | This variable controls the kernel module spliting. [YOCTO #15771] (From yocto-docs rev: 198179d9c6231b5934d4fb6ede716d1dcb1442bb) Signed-off-by: Dixit Parmar <dixitparmar19@gmail.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/yocto-project-supported-features: Set riscv32 maintainers as TBDRichard Purdie2025-06-241-1/+1
| | | | | | | | This isn't committed to by anyone at this point to mark as TBD. (From yocto-docs rev: 6b45207c8db40ef416f12348e066601975a0ca36) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/yocto-project-supported-features: Update to match current statusRichard Purdie2025-06-201-10/+13
| | | | | | | | A few items were in the wrong sections or needed clarification, tweak accordinly. (From yocto-docs rev: 85e58c4fc5d1be9a2ea9ed6b813d0168e3162dab) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* Add SPDX_INCLUDE_COMPILED_SOURCES documentationDaniel Turull2025-06-201-0/+22
| | | | | | | | | | | | | | | Adding documentation for the new feature to store in SPDX only the compiled sources. Merged in oe-core: c6a2f1fca76fae4c3ea471a0c63d0b453beea968 - spdx: add option to include only compiled sources CC: Antonin Godard <antonin.godard@bootlin.com> (From yocto-docs rev: 4dbc63ed1381fe47723d6ba5b7baf2a3b7fd19aa) Signed-off-by: Daniel Turull <daniel.turull@ericsson.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* tree-wide: make the :doc: directive use absolute pathsQuentin Schulz2025-06-203-4/+4
| | | | | | | | | | | | | | | | | | | This makes all :doc: directives use an absolute paths (with the root directory being documentation/ in the repo). This is then consistent across the whole source and is easier to review and move files around, you just need to know where a file is located relative to documentation/ directory and use that. This gets rid of paths looking in parent directory with '..' as well as expecting a file to be in the same directory as the other file it points to via the :doc: directive. (From yocto-docs rev: b9457f2005b0bea49c54e9727eb30e9458084886) Signed-off-by: Quentin Schulz <quentin.schulz@cherry.de> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: replace kernel-fitimage by kernel-fit-imageAdrian Freihofer2025-06-202-100/+179
| | | | | | | | (From yocto-docs rev: 93c92dd2837708ba00a4ca47667e60d7bb09430b) Signed-off-by: Adrian Freihofer <adrian.freihofer@siemens.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: classes: nativesdk: move note to appropriate sectionQuentin Schulz2025-06-201-10/+10
| | | | | | | | | | | | | | The nativesdk- prefix to the recipe filename should only be used when using the inherit method as the BBCLASSEXTEND method will do some magic when generating the "implicit" name of the recipe. This matches the instructions for the native class. (From yocto-docs rev: 15fe239e1e62b9add737aa732dd7f5e9948ee03d) Signed-off-by: Quentin Schulz <quentin.schulz@cherry.de> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: classes: reword to clarify that native/nativesdk options are ↵Quentin Schulz2025-06-201-2/+4
| | | | | | | | | | | | | | | | | | exclusive We explain how to create a native (nativesdk) recipe in two different ways via a bullet list but reading quickly the instructions may mislead one into doing both options whereas they are incompatible. This rewords both the nativesdk and native sections so that the second bullet point starts with an Or and explicit that this applies to target recipes. (From yocto-docs rev: 6d0d338a5f2686ddeee5eed7b6e05f3db800d33a) Signed-off-by: Quentin Schulz <quentin.schulz@cherry.de> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/yocto-project-supported-features: move meta-exein to primaryAntonin Godard2025-06-171-4/+4
| | | | | | | | | | Exein is a platinum member and has primary support (https://www.yoctoproject.org/members). (From yocto-docs rev: b13bccbf3fb1890ac428a396f8c5081057edf555) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/yocto-project-supported-features: add a contact for meta-armRoss Burton2025-06-171-1/+1
| | | | | | | | | | Set the contact address for meta-arm. (From yocto-docs rev: 8ad91366ed89204affef6a72bd403b0d0a4525fa) Signed-off-by: Ross Burton <ross.burton@arm.com> Signed-off-by: Antonin Godard <antonin.godard@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-10-04 09:42:09 +0000