summaryrefslogtreecommitdiffstats
path: root/documentation
Commit message (Collapse)AuthorAgeFilesLines
* dev-manual: add bblock documentationJulien Stephan2024-11-094-0/+142
| | | | | | | | | | | | | | bblock is a helper tool to lock/unlock tasks and recipes to specific signatures. Add a documentation page for it. (From yocto-docs rev: e882cb3e5816d081eb05cb83488f286cca70e0c6) 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-091-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: 2d7795833fb044e2377f042998fe139cd1543d97) 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>
* styles: vocabularies: Yocto: add sstateJulien Stephan2024-11-091-0/+1
| | | | | | | | | | | | | | Add sstate as an accepted word to avoid errors when runnign make stylecheck. (From yocto-docs rev: ae3d79adfaefe86cff55b6fca6e2250cba040b67) 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 1c50726296e876747ea3f862729e953f025ce619) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* documentation: Makefile: add SPHINXLINTDOCS to specify subset to sphinx-lintJulien Stephan2024-11-092-12/+21
| | | | | | | | | | | | | | | | | | | | | make sphinx-lint runs sphinx-lint on the whole documentation which can be long and reports a lot or errors/warnings. Let's add a new SHPINXLINTDOCS variable to allow specifying a subset, just as VALEDOCS does. Keep variable assignment aligned and also use $(SOURCEDIR) by default for SPHINXLINTDOCS and VALEDOCS variables. Also update the README file and fix a typo in Link checking section title. (From yocto-docs rev: c478ef829433c431456835bca240df44ffe8fcca) Signed-off-by: Julien Stephan <jstephan@baylibre.com> 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 3dfe7b5c746af31de74f67cf88214e5d52bdb65d) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* README: add instruction to run Vale on a subsetJulien Stephan2024-11-091-0/+8
| | | | | | | | | | | | | | | | make stylecheck runs Vale on the whole documentation which can be long and reports a lot of errors/warnings. We can run Vale on a subset using the VALEDOCS variable, so update documentation to highlight it. (From yocto-docs rev: e75064520f86c9fd674acff3dd16c88dcc489ba6) Signed-off-by: Julien Stephan <jstephan@baylibre.com> 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 262237f72534c983e178231cb6839ed69709c443) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* conf.py: rename :cve: role to :cve_nist:Antonin Godard2024-11-0949-832/+832
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Newer versions of Sphinx already define a :cve: role that points to cve.org, instead of the role we defined in conf.py that points to nvd.nist.gov. Rename our role to :cve_nist: to avoid warnings (treated as errors). This is also backwards compatible, meaning we can build the doc with an older Sphinx if needed. The file were automatically replaced with following command: find . -name '*.rst' -exec sed -i 's/:cve:/:cve_nist:/g' {} \+ Cherry pick: * remove changes to release-notes-5.1.rst, does not exist on this branch. * release-notes-5.0.4.rst: apply the command to this file as it was treated previously. Suggested-By: Quentin Schulz <quentin.schulz@cherry.de> Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> (From yocto-docs rev: 5b86879b3b5f3c51bc7fa5dd2848cf1153a22242) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 15fa3b7e85dde50d7236c1738ad607531cc654b8) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* release-notes-4.0: update BB_HASHSERVE_UPSTREAM for new infrastructureSteve Sakoman2024-11-091-1/+1
| | | | | | | | | | Public hashserver is now at hashserv.yoctoproject.org:8686 (From yocto-docs rev: 5aeb6a6b2799fb72abbfb272271e3175eca14b37) Signed-off-by: Steve Sakoman <steve@sakoman.com> 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-091-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: cf679f2aa05ef1b5872d97820629375a5c7f4610) 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-091-11/+7
| | | | | | | | | | | | Previous outputs were missing some commands and options, some others were obsolete. (From yocto-docs rev: a0b1cec6f572cf7edd0575c70612ee27fe1239b3) 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-091-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: fb5bbfbe7138ad5643b2929dd77d8cb79bc9c74c) 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-091-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: e69a050d6f2350701f1042750b4e38739d3b6402) 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>
* migration-guide: add release notes for 4.0.22Lee Chee Yang2024-10-302-0/+197
| | | | | | | | | | | (From yocto-docs rev: 74369923b34b879275cd1d5af6d73e57be757078) Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com> Reviewed-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 9563855ccd92e21fb6f8320c96a3a83e115c947e) 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-301-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: 0ed10e173457bf28338115a063cfa42c88a541d8) 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-301-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: 098dd6eaa072b96ba34c15616f973f1c03eaee75) 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-301-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: a030626167905034e24589119453ca6f5fb41cfe) 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>
* overview-manual: concepts: add details on package splittingAntonin Godard2024-10-301-5/+56
| | | | | | | | | | | | | | | | | | | | | | | | | | | The package splitting section of the overview manual currently lacks any explanation of how package splitting is implemented and redirects to the package class, which is not really understandable for newcomers to the project. This patch adds a short explanation of what is done: * How the PACKAGES variable is defined. * How the FILES variable is defined. * How the two work together. * How to add a custom package. This should give enough details to a new user on what package splitting achieves and how to add a custom package. Adresses [YOCTO #13225] Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> (From yocto-docs rev: ccda7c8bb890a290fb41e104f6d818076f4eeaa8) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 143c3cacdec36c9d7ab81c89bbcc12c0c3936bd9) 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-301-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: 5958b3c7546d71fdd1693c26747e0196c6aaf277) 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>
* release-notes-5.0.rst: NO_OUTPUT -> NO_COLORRobert Yang2024-10-301-1/+1
| | | | | | | | | | | (From yocto-docs rev: 5becb08c498cf7cd2af006ed3b0422e39f1ab6b6) Signed-off-by: Robert Yang <liezhi.yang@windriver.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> (cherry picked from commit ac4c4455d40dc0852d95461a3a10d687d2aedd6e) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual: merge patch-status-* to patch-statusAntonin Godard2024-10-301-6/+2
| | | | | | | | | | | These are not distinct anymore and check for any patches in any layer. (From yocto-docs rev: a27e4c426bfb039c9a2a4b7971a74c1fc05e6274) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 300c585909743754e0e6662d48d43834c031b835) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual: add missing OPKGBUILDCMD variableAntonin Godard2024-10-301-0/+7
| | | | | | | | | (From yocto-docs rev: 207dcc17f065760b6a28e762195ed2c48db95935) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit a6a2c8e48995200c9c3be7096f34d912427de145) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual: add missing EXTERNAL_KERNEL_DEVICETREE variableAntonin Godard2024-10-301-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: 1a8c810eaab846379c6fc37960c7e41a5c7af9ba) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 6566ffceab3780dc5ecbfe26f786ebe6ff17e693) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual: add missing TESTIMAGE_FAILED_QA_ARTIFACTSAntonin Godard2024-10-301-0/+5
| | | | | | | | | | | | This variable lists space-separated paths on the target to retrieve onto the host, when inheriting testimage. (From yocto-docs rev: 519a149521a01156c51b472d246ce0b01a74dbfc) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 2537642d2cdf844dc5f6027fb3097aac52162c1f) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual: add missing CVE_CHECK manifest variablesAntonin Godard2024-10-301-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: ec12435c8068c3fb78f11c9a550827e25beb6d67) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 14131a42a7ea8bbae2165c1b8dbcabd5f28b2b22) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual: introduce CVE_CHECK_REPORT_PATCHED variableAleksandar Nikolic2024-10-301-0/+6
| | | | | | | | | | | (From yocto-docs rev: e84fca10400b0f2862d7d0344fb19df5b1e6dc62) Signed-off-by: Aleksandar Nikolic <an010@live.com> Reviewed-by: Michael Opdenacker <michael@opdenacker.org> Signed-off-by: Alexandre Belloni <alexandre.belloni@bootlin.com> (cherry picked from commit f585a68a8f35f31814e408dd973ea7345adbbacf) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* migration-guides: add release notes for 5.0.4Lee Chee Yang2024-10-302-0/+213
| | | | | | | | (From yocto-docs rev: 659579ec4e5e1011c362cb51fe9d94c0e69a5b47) Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* migration-guide: add release notes for 4.0.21Lee Chee Yang2024-10-112-0/+167
| | | | | | | | (From yocto-docs rev: a854b398db797394677ac8e15b5459373c1c3cd3) Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com> Signed-off-by: Alexandre Belloni <alexandre.belloni@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* doc/features: describe distribution feature pni-nameJörg Sommer2024-09-251-0/+4
| | | | | | | | | (From yocto-docs rev: d71081dd14a9d75ace4d1c62472374f37b4a888d) 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: Steve Sakoman <steve@sakoman.com>
* doc/features: remove duplicate word in distribution feature ext2Jörg Sommer2024-09-251-1/+1
| | | | | | | | (From yocto-docs rev: ff4e9d2e516c57c1d0664462ff588666c1fd93a0) Signed-off-by: Jörg Sommer <joerg.sommer@navimatix.de> Signed-off-by: Alexandre Belloni <alexandre.belloni@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* migration-guides: add release notes for 5.0.3Lee Chee Yang2024-08-262-0/+315
| | | | | | | | (From yocto-docs rev: fd4654df2d9eb36cae872dca4d23341ed5f9be91) Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com> Signed-off-by: Alexandre Belloni <alexandre.belloni@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* migration-guide: add release notes for 4.0.20Lee Chee Yang2024-08-262-0/+132
| | | | | | | | (From yocto-docs rev: 9b822bab8d351a120ebcdbc0d43d709921b88dca) Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com> Signed-off-by: Alexandre Belloni <alexandre.belloni@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual: fix typo and move SYSROOT_DIRS exampleMatthias Pritschet2024-08-261-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: 74cdaccd4cbe208de037b3b35c2cf0b8aa334748) Signed-off-by: Matthias Pritschet <matthias@pritschet.eu> Signed-off-by: Alexandre Belloni <alexandre.belloni@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* migration-guides: add release notes for 5.0.2Lee Chee Yang2024-07-122-0/+246
| | | | | | | | (From yocto-docs rev: 09e321d7cbd5bd7071a0c138e6d0c424fb086269) Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com> Signed-off-by: Alexandre Belloni <alexandre.belloni@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* migration-guides: add release notes for 4.0.19Lee Chee Yang2024-07-122-0/+160
| | | | | | | | | | | add release notes for 4.0.19. (From yocto-docs rev: ac201a70a5a5fd2c2e4549debbac84bc6aef662f) Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com> Reviewed-by: Michael Opdenacker <michael@opdenacker.org> Signed-off-by: Alexandre Belloni <alexandre.belloni@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* migration-notes: add release notes for 5.0.1Lee Chee Yang2024-07-122-0/+135
| | | | | | | | | | add release notes for 5.0.1 (From yocto-docs rev: 50b50d9680a49949a34371a45ae9dd1ff0755832) Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com> Signed-off-by: Alexandre Belloni <alexandre.belloni@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* docs: brief-yoctoprojectqs: explicit version dependency on websockets python ↵Quentin Schulz2024-05-091-2/+5
| | | | | | | | | | | | | | | | | | | module We now check that the websockets module version is at least 9.1 in bitbake itself so we can specify more precisely what "recent version" means. While at it, list which distributions have a recent enough websockets python module in their package feed and give some hint at how to support other distributions. Cc: Quentin Schulz <foss+yocto@0leil.net> (From yocto-docs rev: 875dfe69e93bf8fee3b8c07818a6ac059f228a13) Signed-off-by: Quentin Schulz <quentin.schulz@cherry.de> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* ref-manual: update releases.svgMichael Opdenacker2024-05-061-38/+61
| | | | | | | | | | - Make Scarthgap a current release - Add Styhead (From yocto-docs rev: 41ddae07a73da38eb82b00146fd970402b4ac5a7) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* release-notes-5.0: update Repositories / Downloads sectionLee Chee Yang2024-05-061-0/+55
| | | | | | | (From yocto-docs rev: cdce92a0f1595b4cf7b7797f5f95a2d8d8f7d376) Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* migration-notes: add release notes for 4.0.18Lee Chee Yang2024-05-062-0/+192
| | | | | | | | | | add release notes for 4.0.18 (rc1). (From yocto-docs rev: 9be2db28278774676e9fd6919603fc06d27a3676) Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* documentation/poky.yaml.in: drop mesa/sdl from essential host packagesAlexander Kanavin2024-05-061-6/+6
| | | | | | | | | | | They used to be required for qemu graphics support, but neither is being for anything anymore. (From yocto-docs rev: 3c11dfd49902cd8962fc6c732158c3c43ce9c34e) Signed-off-by: Alexander Kanavin <alex@linutronix.de> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* docs: add support for scarthgap 5.0 releaseMichael Halstead2024-05-062-10/+12
| | | | | | | | | Prepared for Scarthgap release. Add references to Styhead. (From yocto-docs rev: 1b5f2ac75c069f972cdd9c6691519d50a5f8e468) Signed-off-by: Michael Halstead <mhalstead@linuxfoundation.org> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* brief-yoctoprojectqs: Update to the correct hash equivalence server addressRichard Purdie2024-05-021-1/+4
| | | | | | | | Also add a note about needing python websockets installed. (From yocto-docs rev: 9dfe3d2dcba8bb2d2e277ff2204862dc8b77c8b9) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* release-notes-5.0: update recipes changesLee Chee Yang2024-04-241-3/+7
| | | | | | | | | | | | update recipes changes in 5.0 rc4. update new recipes, license changes, patched cve and recipes version changes. (From yocto-docs rev: 0fc86205668d122d4e550a5eae301cd6997f8a71) Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: standards.md5: add standard for project namesMichael Opdenacker2024-04-241-15/+18
| | | | | | | | | | | | | | | | Set a new standard to introduce project names with single quotes, so that they appear in generated text with an italic font, to make them easier to distinguish from command names and from ordinary English words. Rework and move the standard for command and file names to make the whole description "flow" better. (From yocto-docs rev: fa6700af56213a5079eaa8d9683f3c2b2fc93740) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> CC: Quentin Schulz <quentin.schulz@theobroma-systems.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* release-notes: add a few more new featuresPaul Eggleton2024-04-241-2/+30
| | | | | | | | | | | | Add some features I missed earlier (patchtest, Toaster, hash equivalence enhancements, screenshot-based UI test, USERADD_DEPENDS). (From yocto-docs rev: 774f0ba6345592571c7c7cff495f2b15dca21f25) 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 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>
* release-notes: additional features and one known issue for 5.0Paul Eggleton2024-04-161-5/+71
| | | | | | | | | | | | Add additional features and tweak some existing entries. Also add one known issue for gpgme. (From yocto-docs rev: 0cdc0afd3332459d30cfc8f4c2e62bdcc23f5ed5) 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>
* migration: extend migration guide for 5.0Paul Eggleton2024-04-161-8/+76
| | | | | | | | | | Add a few missing entries based upon combing through the release commits, as well as minor tweaks to existing items. (From yocto-docs rev: 0680ee719edaa31a52f9cb7bd5138b402b1b26ce) Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* release-notes: add CVEs, recipe upgrades and contributors for 5.0Paul Eggleton2024-04-161-1/+562
| | | | | | | | | | | | * Add CVEs from commits * Add recipe upgrades using layer index branch comparison * Add contributors from commits (From yocto-docs rev: 4cf6b62939c226fb9c49b7d61f3d95075a9cd8bd) 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>
* dev-manual: update custom distribution sectionPaul Eggleton2024-04-161-4/+30
| | | | | | | | | | | | | | In keeping with the addition of the motd message pointing out that the poky DISTRO is a reference distribution, adjust the opening of the Creating Your Own Distribution section to match. Additionally, add a section on the end pointing out what users need to consider if they just take a copy of the poky distribution and modify it. (From yocto-docs rev: 3dc812e7255ba7c0ddd7b43b9b1319ea4ef3161e) 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>
* dev-manual: update reference to sstate-cache-management scriptPaul Eggleton2024-04-161-1/+1
| | | | | | | | | | | | | * Script is now .py * In the example, we would most likely be within the build directory already, so the path would be just "sstate-cache" not "build/sstate-cache" (From yocto-docs rev: a655ef8f5fee98e55277cbd40a092fcae697cbae) 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>