summaryrefslogtreecommitdiffstats
path: root/documentation
Commit message (Collapse)AuthorAgeFilesLines
* poky.yaml.in: increase required disk space to 140GHEADmasterAntonin Godard10 hours1-3/+3
| | | | | | | | | | | | | | | Increase the minimum size requirement to 140G, after running a build with distro Poky. The size after rm_work has increase of only 1G, so leave the current value for MIN_DISK_SPACE_RM_WORK. Also, update the comment to mention that this is for distro Poky. It was mentioned in commit message 285ba689ce3a ("manuals: update disk space requirements"), but not in the comment here. (From yocto-docs rev: dbc6137cd13f982a7fd4d1b2df79dccb177db0fc) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/terms.rst: sort entriesAntonin Godard10 hours1-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 Godard10 hours1-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 Godard10 hours1-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>
* Makefile: add a checks ruleAntonin Godard10 hours1-2/+5
| | | | | | | | | | | | | | | | The checks rule can be run to perform some checks on the docs. For now it only includes running the check-glossaries script. This rule should only run basic checks or should not prevent the user from building the docs in case of failure. This rule can be used in the future to run additional checks on the documentation. (From yocto-docs rev: 1d9a4a52fa9f2e2eb7f282324f85a46b28128fbf) 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 Godard10 hours2-0/+96
| | | | | | | | | | | | | | | | | | | | 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>
* migration-guides/release-notes-5.3: updatesAntonin Godard10 hours2-5/+648
| | | | | | | | | | | | Update the release notes and migration manual for 5.3. This covers commits from c4a5e590b53b ("rust-llvm: Compile llvm to use dynamic libraries") to 2a832e6af1b6 ("orc: set CVE_PRODUCT") in Poky. (From yocto-docs rev: c8d852ad63219d067e497a77d489a4011b0d0a26) 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 Godard10 hours5-11/+11
| | | | | | | | | | | | | 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 Godard10 hours1-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 Godard10 hours1-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 Godard10 hours4-13/+13
| | | | | | | | | | | 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 Godard10 hours1-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 Godard10 hours1-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 Godard10 hours1-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 Godard10 hours1-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 Godard10 hours1-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 Godard10 hours2-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 Godard10 hours1-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 Godard10 hours1-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 Godard10 hours4-168/+9
| | | | | | | | | | | | | 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 Godard10 hours1-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 Godard10 hours2-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 Godard10 hours1-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 Godard10 hours1-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 Godard10 hours1-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>
* dev-manual: add a hash equivalence server setup documentAntonin Godard10 hours4-13/+137
| | | | | | | | | | | | | | | | | | Add a small document to describe how to start a Hash Equivalence server with bitbake-hashserv, the reference server provided by BitBake. Update reference to hash equivalence in other places in the documentation to mention this document. Move the note from the concepts document to the new document, as a warning note. [YOCTO #15921] (From yocto-docs rev: 4ff998336efdc507de1311e43bf8f4a6258c610a) 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 Godard10 hours1-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>
* overview-manual/yp-intro.rst: fix broken link to articleErik Lindsten10 hours1-1/+1
| | | | | | | | (From yocto-docs rev: b9680ad83ad3fc5e2b87594f7c62c057134d198b) Signed-off-by: Erik Lindsten <erik@awto.se> 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 Godard8 days2-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 Godard8 days2-14/+1
| | | | | | | | | | 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 Godard8 days1-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 Godard8 days2-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. Day8 days1-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>
* migration-guides: add release notes for 5.0.11Lee Chee Yang8 days2-0/+220
| | | | | | | | (From yocto-docs rev: a17f47f21805cf636a0568b46bd5a6ed5cfd7306) 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>
* migration-guides: add release notes for 5.2.2Lee Chee Yang8 days2-0/+251
| | | | | | | | (From yocto-docs rev: a9da828a7a10a5a2c2dbed6c4bba8aac0517cd51) 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>
* dev-manual/start.rst: added missing command in Optimize your VHDX file using ↵Marco Cavallini8 days1-0/+1
| | | | | | | | | | | | | | | | | | | DiskPart After compact vsdisk you have to detach it before exiting otherwise the vdisk remains attached. DISKPART> select vdisk file="<path_to_VHDX_file>" DISKPART> attach vdisk readonly DISKPART> compact vdisk DISKPART> detach <------------ new missing command DISKPART> exit (From yocto-docs rev: 1cc65ddf1a074f61fe5a63d222f3079b7fcb4c1e) Signed-off-by: Marco Cavallini <m.cavallini@koansoftware.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual/start.rst: remove basic setup for hash equivalenceAntonin Godard8 days1-6/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | Quoting Alexander Kanavin [1]: > 1. BB_HASHSERVE and BB_SIGNATURE_HANDLER do not set up or start a > server, they set up the hash equivalence client built into bitbake. > > 2. The above client configuration (used by poky) also starts a private > server that is specific to a particular build directory. So hash equiv > information would not be shared between multiple build directories, > and this will cause sstate mismatches (as reported in the bug), if > sstate is shared. This setup does not shed light on the potential of the hash equivalence feature. So for now, remove this basic setup, and later rework the concepts (or create a new) document that explains how to set up a hash equivalence server shared between builds. [1]: https://lore.kernel.org/r/CANNYZj_kvLsZG3sgH+nPu9B=pqWBU785w0SGHGdQqB4UW-DtmA@mail.gmail.com Suggested-by: Alexander Kanavin <alex.kanavin@gmail.com> (From yocto-docs rev: 231fc9e710ab34db60263f8ae01d4f5970579203) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual/start.rst: remove shared PERSISTENT_DIR mentionsAntonin Godard2025-07-151-4/+10
| | | | | | | | | | | | | Remove the shared PERSISTENT_DIR mention introduced by 3954eda78f22 ("dev-manual/start.rst: mention that PERSISTENT_DIR should be shared too"), as it should _not_ be shared. Instead recommend setting up a hash equivalence server. (From yocto-docs rev: f9f1c87424d307d2df60024bc448bd6778605cf8) 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>
* overview-manual/concepts.rst: fix sayhello hardcoded bindirAntonin Godard2025-07-111-2/+2
| | | | | | | | | | Replace the hardcoded /usr/bin by ${bindir}, as it should be. Reported-by: Thomas Perrot <thomas.perrot@bootlin.com> (From yocto-docs rev: 576677eae6960dbc2d2ececeba0fde5bba7bb69f) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* overview-manual/concepts.rst: mention PERSISTENT_DIR for user configurationAntonin Godard2025-07-111-0/+3
| | | | | | | | | | The PERSISTENT_DIR directory can also be customized to be shared, so mention it in the list of configuration variables in local.conf. (From yocto-docs rev: f3aa0e8f0d15f036b65253c1e0036eb7e1e16088) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual/start.rst: mention that PERSISTENT_DIR should be shared tooAntonin Godard2025-07-111-0/+5
| | | | | | | | | | | | | | | In the "Development environment summary", we mention that the shared state dir can be shared for developers, but PERSISTENT_DIR should be shared as well, otherwise bugs described in [1] can happen. [1]: https://bugzilla.yoctoproject.org/show_bug.cgi?id=15921 [YOCTO #15921] (From yocto-docs rev: 3954eda78f22f205cbd31857f5b0992900fe7b02) 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>
* test-manual/understand-autobuilder.rst: mention hashequiv serverAntonin Godard2025-07-111-0/+6
| | | | | | | | | | The autobuilder also uses a shared Hash Equivalence server, so mention it here too. (From yocto-docs rev: a96640f98c91f147e05cf132efab114b1e7dc8eb) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* poky.yaml.in: increase minimum RAM from 8 to 32Antonin Godard2025-07-111-1/+1
| | | | | | | | | | In the light of the recent LLVM addition, and other such heavier recipes, increase the minimum RAM requirement from 8Gb to 32Gb. (From yocto-docs rev: 3055affc8a37a40d03206140e47caf3d1437ec35) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* migration-guides: add release notes for 4.0.28Lee Chee Yang2025-07-112-0/+225
| | | | | | | | (From yocto-docs rev: 6959193fddb039c34384fcc391195fdd7fd3dbb8) 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/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>
* Add a document on limiting host resourcesAntonin Godard2025-07-112-0/+139
| | | | | | | | | | | | | | Add a "Limiting the Host Resources Usage" document to share the different techniques that can be used to limit the host resources usage. We do have a document to document how to speed up a build, so this document comes right after. [YOCTO #15111] (From yocto-docs rev: 584b8b30cd884ff6c62efcff9e9b566476a84589) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* conf.py: improve SearchEnglish to handle terms with dotsEnrico Jörns2025-07-041-3/+3
| | | | | | | | | | | | | | | | | | | | | | | | While search queries already handled words with hyphens correctly, they did not do so for words with dots. To fix this, we - enhance the word tokenizer to treat both dots ('.') and hyphens ('-') as valid characters within words. (For robustness, explicitly exclude dots/hyphens at the start or end of a word from indexing.) - adjust query processing to avoid splitting on dots in search input This allows search queries to correctly match terms such as 'local.conf', 'site.conf', and similar ones now. Fixes: [YOCTO #14534] (From yocto-docs rev: 80084a4cabdf7f61c7e93eda8ddbd5bc7d54e041) Signed-off-by: Enrico Jörns <ejo@pengutronix.de> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bsp-guide: fix branch listing commandBo Sun2025-07-041-1/+1
| | | | | | | | | | | | Replace 'git branch -al' with 'git branch -a' to correctly show both local and remote branches. The '-l' option is unnecessary and may cause confusion. (From yocto-docs rev: 46aa3bb398c50af0f29acd2c1a05ee232d0de5b9) Signed-off-by: Bo Sun <bo@mboxify.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-08-09 08:51:45 +0000