summaryrefslogtreecommitdiffstats
path: root/documentation
Commit message (Collapse)AuthorAgeFilesLines
* migration-guides: update the release notes for 5.2Antonin Godard10 days2-2/+399
| | | | | | | | | | | | | | Update the release note and migration guide for the 5.2 release. This release is not due until April 2025, but this catches up what has already been applied since 5.1. Precisely, this tracks the important changes between commits 8149e74258 and 87d7341465 in poky. (From yocto-docs rev: a51a94f0b228d570d915dff36a49132e90e93cf1) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/variables: document the PREFERRED_RPROVIDER variableAntonin Godard10 days1-0/+22
| | | | | | | | | | This variable is similar to the PREFERRED_PROVIDER variable but it denotes a runtime provider specifically. (From yocto-docs rev: 0b0b58070fceff6851a6e137f7f774e706205b32) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/variables: document the CARGO_INSTALL_LIBRARIES variableAntonin Godard10 days1-0/+9
| | | | | | | | | | This variable controls whether libraries compiled by recipes inheriting cargo are installed or not. (From yocto-docs rev: c42f80a12e9e71fa7dab9672fb3174ed006b214b) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/classes: document the yocto-check-layer classAntonin Godard10 days1-0/+20
| | | | | | | | | | | This class is used by the yocto-check-layer script to check if a layer complies to the Yocto Project Compatible status. Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> (From yocto-docs rev: b3fd3c268ac3f15e4050a983289fc63e62f4c823) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/variables: document the CHECKLAYER_REQUIRED_TESTS variableAntonin Godard10 days1-0/+11
| | | | | | | | | | | This was introduced in oecore by commit ce2e42ace2d15fb6745437cf0a7f07d28398ca12 ("insane: Split ERROR_QA into CHECKLAYER_REQUIRED_TESTS"). (From yocto-docs rev: 5b205e113015430f6d04e455af7c0d5643863fbc) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* Drop support for BB_DANGLINGAPPENDS_WARNONLYAntonin Godard10 days2-23/+17
| | | | | | | | | | | | | | | Support for this variable was dropped in BitBake, see commit fca9c9e3cb6f8e9f99bf51dc5e8a8d83f4c84c69 ("cooker: Drop support for BB_DANGLINGAPPENDS_WARNONLY"). Drop this variable here as well and rewrite the "Appending Other Layers Metadata With Your Layer" section to advise to rename the recipe and check if the bbappend is still relevant - otherwise to use BBWARN. (From yocto-docs rev: 10b59d09ebfb6c119995643ed68cb26092b6f2a4) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* Remove debug-tweaks referencesAntonin Godard10 days8-30/+29
| | | | | | | | | | | | | | | | | | | | | We no longer provide this feature, so remove documentation for it. In most cases, we can replace occurrences of "debug-tweaks" by "allow-empty-password empty-root-password allow-root-login post-install-logging" to achieve what this feature previously enabled. Subtle, but the default local.conf does not include post-install-logging, so in parts where there is mention of the default local.conf file, adjust the documentation to only mention the first three above. In the intro manual, instead of providing instructions that replace EXTRA_IMAGE_FEATURES entirely, provide ones that append EXTRA_IMAGE_FEATURES. (From yocto-docs rev: f0efd4c7df91863304b92514664bdd1fa62b1fbb) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/classes: document the cython classAntonin Godard10 days1-0/+9
| | | | | | | | | | | Small class added in oecore by commit 64b6e8580842949be58f97f4dff91d1f097c4020 ("classes-recipe: add cython class"). (From yocto-docs rev: 0979e02b71b6c91fa27cdeacd70036564fbe1a2d) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/variable: remove obsolete SETUPTOOLS_INSTALL_ARGSAntonin Godard10 days1-5/+0
| | | | | | | | | | | Remove in oecore by commit b4bdfc78e8e1cb8b86221bc55d80d601ea1a065f ("python3-cython: remove obsolete SETUPTOOLS_INSTALL_ARGS"). Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> (From yocto-docs rev: a32b39a4d9bda124e6c19aa1db522656b1e7e807) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/variables: document the WIC_SECTOR_SIZE variableAntonin Godard10 days1-0/+11
| | | | | | | | | | Added recently in oecore to control the sector size of wic images. Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> (From yocto-docs rev: 075d4ac67c94d6442ea384b5b0ec68b1aa34a4c3) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/variables: add missing entries to SDK_ARCHIVE_TYPEAntonin Godard10 days1-0/+2
| | | | | | | | | | Both added recently in oecore. Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> (From yocto-docs rev: 76b970718d237f60aefe02321d867bed3deb6069) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/variables: document the FIRMWARE_COMPRESSION variableAntonin Godard10 days1-0/+10
| | | | | | | | | Added in oecore after the 20241017 update. (From yocto-docs rev: 9073f575f169ab545198d82b69cca5f9e3db152f) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/classes: drop the migrate_localcount classAntonin Godard10 days1-8/+0
| | | | | | | | | | | | | This class is obsolete and was removed from openembedded-core with commits fca25fc4d7721f85f64c942307ebe7ba9f2fad3e ("migrate_localcount: Drop long obsolete code") and d0f35207f9e19b440393a79ebf621649c495738d ("bitbake: fetch2: remove localcount and use AUTOINC instead"). Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> (From yocto-docs rev: 0da4f50b2105e0ee2d992338b390e966f38a51c0) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual/variables: document the KERNEL_CONSOLE variableAntonin Godard10 days1-0/+13
| | | | | | | | | | | This variables holds the value of the `console` kernel command line parameter. Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> (From yocto-docs rev: ea638e85316d0bc5c9917cefacef168782e4d92b) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* reproducible-builds.rst: show how to build a single packageTrevor Gamblin10 days1-7/+15
| | | | | | | | | | | | | | | | Add a bit to the "Can we prove the project is reproducible?" section to show how OEQA_REPRODUCIBLE_TEST_TARGET can be used to test a single package (rather than the world build), as this may be useful for maintainers. [YOCTO #15619] (From yocto-docs rev: c4bc09f61621938086be377653121d6b4e62b570) Signed-off-by: Trevor Gamblin <tgamblin@baylibre.com> 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>
* set_versions.py: use backward-compatible python argument in runAntonin Godard2024-12-201-8/+8
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Some workers on the autobuilder reported the following error: File "./set_versions.py", line 102, in <module> subprocess.run(["git", "show", "yocto-%s" % release_series[activereleases[0]]], capture_output=True, check=True) File "/usr/lib64/python3.6/subprocess.py", line 423, in run with Popen(*popenargs, **kwargs) as process: TypeError: __init__() got an unexpected keyword argument 'capture_output' See https://valkyrie.yoctoproject.org/#/builders/34/builds/86. This is because capture_output was introduced in Python 3.7, and some of the support distributions are still on Python 3.6. Since capture_output is essentially just setting stdout and stderr to PIPE (https://github.com/python/cpython/blob/3.13/Lib/subprocess.py#L547), do it manually here to be compatible with older python versions. This is also the case for the "text" parameter, introduced in 3.7 to alias the universal_newlines parameter. Use "universal_newlines" to be backward-compatible. [ YOCTO #15687 ] Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> Tested-by: Quentin Schulz <quentin.schulz@cherry.de> # openSUSE Leap (From yocto-docs rev: 28850c974a3896895bc921c094071523218d6d07) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual/bmaptool.rst: simplify and fix instructionsMichael Opdenacker2024-12-201-5/+4
| | | | | | | | | | | | | | | | | | | - Remove duplicate instructions - Detail how to run bmaptool directly if you installed it on your host instead of building it through the ``bmaptool-native`` recipe, as running "oe-run-native bmaptool-native bmaptool ..." won't work in this case. - Use "chmod a+w" instead of "chmod 666", better advice, and only run "chmod" in the option that runs "oe-run-native" (From yocto-docs rev: 4afa71ef6e5bf1db126c80e6d987f588d0b5a086) Signed-off-by: Michael Opdenacker <michael.opdenacker@rootcommit.com> 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>
* dev-manual/bmaptool.rst: correct command for bmaptool-nativeMichael Opdenacker2024-12-201-1/+1
| | | | | | | | | | | | | | | | | Using only "bitbake bmaptool-native", running "oe-run-native bmaptool-native bmaptool ..." fails as follows: Error: Have you run 'bitbake bmaptool-native -caddto_recipe_sysroot'? Running the "bitbake bmaptool-native -caddto_recipe_sysroot" target is actually sufficient. (From yocto-docs rev: 72fe904a3bbb5e2c7279ab1f119c2beca200dcf2) Signed-off-by: Michael Opdenacker <michael.opdenacker@rootcommit.com> 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>
* dev-manual: fix styling of references to bmaptoolMichael Opdenacker2024-12-202-11/+11
| | | | | | | | | | | | | | | To follow the styling conventions when we are refering to the name of a tool instead of the command itself (documentation/standards.md). This also improves the HTML rendering of the bmaptools subsection. (From yocto-docs rev: c569d840c4b6f43e10629b6f1ff45189211e27a9) Signed-off-by: Michael Opdenacker <michael.opdenacker@rootcommit.com> 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>
* Update the documentation for SRCPVAntonin Godard2024-12-206-63/+47
| | | | | | | | | | | | | | | | | | | | | | 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: ee16c96202e5027d1a8d7e89e11c25f127c78326) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* system-requirements.rst: add dependencies for pdf buildsAntonin Godard2024-12-162-3/+76
| | | | | | | | | | | | | | | | | | | | | | | | | | | With the recent changes from commit bd6265ca323fac547a197bb516dc4a9ef3897508 ("doc: Makefile: add support for xelatex"), the list of dependencies needs to be updated. The initial list of dependencies was made for Ubuntu/Debian, and the packages were translated for the other distros using pkgs.org. Add them separately from the rest of the dependencies as they pull a _lot_ of additional dependencies (for LaTeX). Move the texlive-fncychap documentation dependency to the PDF specific dependency. Notes: - Fedora/OpenSUSE do not have the "lang-all" texlive collection, so install all available languages. - AlmaLinux does not seem to provide texlive-collection-fontsextra, texlive-collection-lang*, and texlive-collection-latexextra, so add a warning about that. (From yocto-docs rev: 02c090718ac602f7d4760dd28dadbf0631668d49) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* system-requirements: update list of supported distrosAntonin Godard2024-12-161-0/+8
| | | | | | | | | To match the list in meta-poky/conf/distro/poky.conf. (From yocto-docs rev: c9c3f6896e4bc967a9b394574532735babb70397) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* system-requirements: add fedora 39 to supported distrosAntonin Godard2024-12-161-0/+2
| | | | | | | (From yocto-docs rev: dc7fd0e56fbfed77975f6b4ed2106331476ef7f3) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* poky.yaml.in: replace inkscape dependency by librsvg2-binAntonin Godard2024-12-161-4/+4
| | | | | | | | | | | inkscape used to be a requirement to convert SVG images to PNGs/PDFs, but we replaced it recently by rsvg-convert. Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> (From yocto-docs rev: 8c0bb4e41c203a0a7a31c2bdc26834d87a83413a) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* poky.yaml.in: add missing locales dependencyAntonin Godard2024-12-161-0/+4
| | | | | | | | | | | | | | | This is a requirement for building the documentation, otherwise we get (on Ubuntu 24.04): File "/usr/lib/python3.12/locale.py", line 615, in setlocale return _setlocale(category, locale) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ locale.Error: unsupported locale setting (From yocto-docs rev: 0943a7b67ef0012b5d9badc15e0c579dbb9014ae) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* Gather dependencies in poky.yaml.inAntonin Godard2024-12-163-35/+202
| | | | | | | | | | | | | | | | | We used to have packages here and there in system-requirements.rst for each distro. Instead, gather all the dependencies in poky.yaml.in so we have an overview of what we provide for each distro. Use yaml ">" to list the dependencies in alphabetical order, one entry per line, which makes them easier to read and compare among distros. Rename UBUNTU_… variables to UBUNTU_DEBIAN_…, since these are used for both distros. (From yocto-docs rev: 1ed6118b7cf1b5dcbfca753c83fa30fb97bf44ad) 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.1.1Lee Chee Yang2024-12-162-0/+290
| | | | | | | | | (From yocto-docs rev: db2ff7bbe64e1dca6b0868046f478d7622f79865) 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> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: use standardized method accross both ubuntu and debian for ↵Guénaël Muller2024-12-162-2/+18
| | | | | | | | | | | | | | | | locale install Modify locale installation method to be standard accross all debian-based distributions. Pre-existing method is available only on Ubuntu, locale-gen tool has no parameter in Debian. (From yocto-docs rev: 30002019198a168e48537407bb928facb26af82a) Signed-off-by: Guénaël Muller <guenael.muller@smile.fr> Reviewed-by: Yoann Congal <yoann.congal@smile.fr> Reviewed-by: Antonin Godard <antonin.godard@bootlin.com> Tested-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* migration-guides: add release notes for 4.0.23Lee Chee Yang2024-11-292-0/+210
| | | | | | | | (From yocto-docs rev: 5835cb574881d57785f099c768467177d077e867) 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: fix bin_package descriptionAntonin Godard2024-11-291-17/+28
| | | | | | | | | | | | | | | | The previous bin_package description was confusing: it would instruct to use the git fetcher to extract the content of an RPM package using the `subpath` option - but that's not possible as the git fetcher can be used to clone a repository but not to do the extraction. Update the description by telling what it really does and what it doesn't do, and by giving an HTTPS+RPM example. Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> (From yocto-docs rev: 305f024bf99ba02b153eed0cebe3d36594868497) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* classes.rst variables.rst: add documentation for uki.bbclassMikko Rapeli2024-11-292-0/+92
| | | | | | | | | | | | | | Documentation for the new class. [YOCTO #15650] https://bugzilla.yoctoproject.org/show_bug.cgi?id=15650 (From yocto-docs rev: fd46074dc7bba49ab49c706c408c92958e67cfa4) Signed-off-by: Mikko Rapeli <mikko.rapeli@linaro.org> 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>
* migration-guides: add release notes for 5.0.5Lee Chee Yang2024-11-292-0/+228
| | | | | | | | (From yocto-docs rev: 4175839e718db49bf6971e900c1cf176d03458d7) 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: document ZSTD_COMPRESSION_LEVEL changeAlexander Kanavin2024-11-221-0/+3
| | | | | | | | | (From yocto-docs rev: 6dcc70c4fa780d8531c58bd7886d6f8b602c10af) 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> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: document ZSTD_COMPRESSION_LEVELAlexander Kanavin2024-11-221-0/+5
| | | | | | | | | (From yocto-docs rev: ca3cbe1bac3261fd01aeb1afdca98fbe283e9ac7) 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> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: merge two separate descriptions of RECIPE_UPGRADE_EXTRA_TASKSAlexander Kanavin2024-11-221-6/+5
| | | | | | | | | | | The second description was added due to confusion over the variable rename in oe-core. (From yocto-docs rev: b64fb34643343b364705df9c3bd64af91ed9d687) 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> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* migration-guides: add release notes for 5.0.4Lee Chee Yang2024-11-222-0/+213
| | | | | | | | (From yocto-docs rev: bf1077eb1b215ded502a61876eb071c21b21c4ec) 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>
* standards.md: add a section on admonitionsAntonin Godard2024-11-221-0/+15
| | | | | | | | | | | | | We try to limit our usage of these admonitions to `note` and `warning`, as the Sphinx documentation warns that most themes only style these two admonitions. So add a section on that. Suggested-by: Quentin Schulz <quentin.schulz@cherry.de> Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> (From yocto-docs rev: 0c1252b67e602ebf7197e1388dd1fb86b37d25c8) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: bblock: use warning block instead of attentionAntonin Godard2024-11-151-1/+1
| | | | | | | | | | | | Sphinx recommends using warning and note here: https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#directives Suggested-by: Quentin Schulz <quentin.schulz@cherry.de> Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> (From yocto-docs rev: 7d5eb0cee5b2b7096969819d7d7ce569a3c92f27) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: document how to provide confs from layer.confAntonin Godard2024-11-151-0/+90
| | | | | | | | | | | | | | | | | | | | | | Add a section on providing global level configuration from the layer.conf file. Since this file is parsed at an earlier stage in the parsing process, it's not possible to combine bb.utils.contains and {DISTRO,MACHINE}_FEATURES to conditionally set some configurations. This patch documents: - First that this file can be used for providing such configuration. - Then demonstrate how to conditionally provide them, using a technique that is currently used in meta-virtualization (https://git.yoctoproject.org/meta-virtualization/tree/conf/layer.conf#n50). Fixes [YOCTO #12688]. Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> (From yocto-docs rev: cc3fa1b0e51377f4e03eaa1ca60c2f2ee0cd917e) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* conf.py: add a bitbake_git extlinkAntonin Godard2024-11-151-0/+1
| | | | | | | | | | | To make references to the bitbake repo, add an extlink for it and use it in the docs with ":bitbake_git:`lib/bb/utils.py </tree/lib/bb/utils.py>`". Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> (From yocto-docs rev: 989f966e1c2b8eec100fc448be3ba09cf358ba26) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* migration-guides: add placeholder files for next releaseAntonin Godard2024-11-154-0/+134
| | | | | | | | | | | | | | | Placeholder files for release 5.2 (Walnascar): migration guide and release notes. Define two substitutions |yocto-ver| and |yocto-codename| to avoid mistakes in the document. Note that anchors cannot contain these so add a note on that in a comment. Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> (From yocto-docs rev: f13492dc9474b7e22d01ab1bec2da074e972965d) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* migration-guides: 5.1: fix titlesAntonin Godard2024-11-151-3/+5
| | | | | | | | | | | | | - fix title underline - add anchor for workdir changes - supported-kernel-versions was misplaced, move it - "Miscellaneous changes" anchor was wrong Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> (From yocto-docs rev: c5ea8551b8b74c6902c4107b88ea7ddcf505ec74) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sphinx-static/switchers.js.in: do not refer to URL_ROOT anymoreAntonin Godard2024-11-121-0/+6
| | | | | | | | | | | | | | | This variable was removed from the Sphinx-generated documentation_options.js, thus breaking the current implementation of our switchers.js. Like searchtools.js, which is also generated by Sphinx, use document.documentElement.dataset.content_root as a replacement. To be backwards-compatible to get one or the other. (From yocto-docs rev: 13caec1386708d8609dff5f42956d2329a074f37) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* doc: add a download page for epub and pdfAntonin Godard2024-11-122-0/+18
| | | | | | | | | | | | These files are placed in the _static directory during publish. Note that Sphinx does not complain if files do not exist during compilation (since they are copied at the end). This is why this was used instead of the ":download:" role. (From yocto-docs rev: 3b9287eb5cde22cf5be48734d63efbd30c66ef06) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* doc: Makefile: publish pdf and epub versions tooMichael Opdenacker2024-11-121-1/+3
| | | | | | | | | | | | Copy the generated files in the special _static directory. Fixes [YOCTO #14357] (From yocto-docs rev: b60c5b86eaef5ddab026837e0952a28c7948bc2d) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* doc: Makefile: add support for xelatexAntonin Godard2024-11-122-2/+10
| | | | | | | | | | | | | | | | | This patch makes the "latexpdf" target compile the documentation with xelatex instead of the default pdflatex engine. The reason behind this is stated in [YOCTO #14357]: pdflatex does not support compiling foreign characters, so we need to resort to another engine, here xelatex. It also increases the texmf config buf_size to 10000000 to avoid a compilation error. (From yocto-docs rev: bd6265ca323fac547a197bb516dc4a9ef3897508) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* doc: Makefile: remove inkscape, replace by rsvg-convertAntonin Godard2024-11-121-4/+4
| | | | | | | | | | Remove inkscape as it is not part of meta/, and use librsvg so we can ship it in a buildtools tarball for the autobuilder workers. (From yocto-docs rev: 2d92de35e0029bf151c9a0c0e696a127cef14082) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* contributor-guide: Remove duplicated wordsTalel BELHAJSALEM2024-11-121-1/+1
| | | | | | | | | | | Remove "and then" as it is duplicated. (From yocto-docs rev: 90666b8c85fe6afaf102034ebcd5d25d8391e697) Signed-off-by: Talel BELHAJSALEM <bhstalel@gmail.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>
* dev-manual: add bblock documentationJulien Stephan2024-11-074-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: a082aa39840587d3af6c3f4a2c2747564ca37414) 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> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: variables: add SIGGEN_LOCKEDSIGS* variablesJulien Stephan2024-11-071-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: 32e3995bed2836f549866ec3b8ad254bdda37dbf) 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> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
generated by cgit v1.2.3-54-g00ecf (git 2.39.0) at 2025-01-07 16:44:42 +0000