aboutsummaryrefslogtreecommitdiffstats
AgeCommit message (Collapse)Author
2023-10-31test-manual: reproducible-builds: stop mentioning LTO bugyocto-4.2.4mickledore-4.2.4contrib/mickledore-nextMichael Opdenacker
Now that https://bugzilla.yoctoproject.org/show_bug.cgi?id=14481 is closed. Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2023-10-31dev-manual: add security team processesMarta Rybczynska
Add the initial version of the section on vulnerability reports, operations of the Security Team with a transcription of https://wiki.yoctoproject.org/wiki/Security_private_reporting Signed-off-by: Marta Rybczynska <marta.rybczynska@syslinbit.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2023-10-31manuals: correct "yocto-linux" by "linux-yocto"Michael Opdenacker
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2023-10-24ref-manual: variables: add example for SYSROOT_DIRS variableBELHADJ SALEM Talel
Signed-off-by: Talel BELHAJSALEM <bhstalel@gmail.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2023-10-24ref-manual: variables: add TOOLCHAIN_OPTIONS variableBELHADJ SALEM Talel
Signed-off-by: Talel BELHAJSALEM <bhstalel@gmail.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2023-10-24ref-manual: variables: add RECIPE_SYSROOT and RECIPE_SYSROOT_NATIVEBELHADJ SALEM Talel
Signed-off-by: Talel BELHAJSALEM <bhstalel@gmail.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2023-10-24dev-manual: start.rst: remove obsolete referenceMichael Opdenacker
Remove a reference to a web resource which is clearly marked as obsolete. Replace the unnecessarily verbose note by just links to the mentioned tools. [YOCTO #15233] Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
2023-10-24brief-yoctoprojectqs: use new CDN mirror for sstateMichael Opdenacker
Recommended instead of the Yocto Project mirror, because expected to be faster. Make sure you only set one such mirror. Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> CC: richard.purdie@linuxfoundation.org
2023-10-24dev-manual: layers: Add notes about layer.confBELHADJ SALEM Talel
As discussed before with Richard Purdie, the code supports this but the documentation does not. Developers in general will not notice this or focus on it because they do not mess with the layer.conf template file, but in my opinion I think more details can help. Signed-off-by: Talel BELHAJSALEM <bhstalel@gmail.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2023-10-24ref-manual: variables: provide no-match example for COMPATIBLE_MACHINEQuentin Schulz
COMPATIBLE_MACHINE is used to forbid the use of a recipe or its packages for a specific set of machines. In some cases, it may make more sense to have the logic inverted and have the recipe always forbidden except for hand-picked machines. Such could be the case for pieces of software that only support some architectures. In that scenario, it is sometimes a bit easier on the eye and for maintenance to use the OVERRIDES mechanism but for that, a default should be set. COMPATIBLE_MACHINE:aarch64 = "^(aarch64)$" COMPATIBLE_MACHINE:mips64 = "^(mips64)$" wouldn't do much because if COMPATIBLE_MACHINE isn't set, the recipe is assumed compatible and therefore, if no default is provided we enter that case. Hence, we need to add COMPATIBLE_MACHINE = "^$" as default so that it only matches the empty string, which isn't possible for MACHINEOVERRIDES. Cc: Quentin Schulz <foss+yocto@0leil.net> Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2023-10-24profile-manual: aesthetic cleanupsRobert P. J. Day
Various aesthetic cleanups of section 1 of that manual, including: * replace 'HOWTO' with manual * add more examples of sdk-related images * font fixes Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2023-10-24ref-manual: Fix PACKAGECONFIG term and add an exampleBELHADJ SALEM Talel
PACKAGECONFIG's first and second flag value will be added to PACKAGECONFIG_CONFARGS and then it will be added to the appropriate variable (EXTRA_OECMAKE, or ...) So we need to only mention PACKAGECONFIG_CONFARGS and it will lead to other variables. I added a custom example that can help understanding very well PACKAGECONFIG. Signed-off-by: Talel BELHAJSALEM <bhstalel@gmail.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2023-10-24dev-manual: new-recipe.rst: add missing parenthesis to "Patching Code" sectionRobert P. J. Day
Add missing parenthesis, and another example of a compressed patch filename. Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2023-10-24sdk-manual: appendix-obtain: improve and update descriptionsMichael Opdenacker
- Improve text formatting - Stop mentioning all possible values - Update examples - Correct descriptions Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2023-10-24bsp-guide: bsp: skip Intel machines no longer supported in PokyMichael Opdenacker
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
2023-10-23ref-manual: Warn about COMPATIBLE_MACHINE skipping native recipesArne Schwerdt
Signed-off-by: Arne Schwerdt <arne.schwerdt@elbbits.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2023-10-11migration-guides: add release notes for 4.0.13Lee Chee Yang
Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2023-10-11overview: Add note about non-reproducibility side effectsJoshua Watt
Adds an additional note about some of the side effects that can occur if recipes are not reproducible and hash equivalence is enabled. Signed-off-by: Joshua Watt <JPEWhacker@gmail.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2023-10-11dev-manual: fix testimage usage instructionsTrevor Gamblin
The proper way to inherit the testimage class is now IMAGE_CLASSES += "testimage" so change lines with 'INHERIT += "testimage"' to match. This makes the dev-manual consistent with the migration guide, which already specifies that the old way causes an error. Signed-off-by: Trevor Gamblin <tgamblin@baylibre.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2023-10-11ref-manual: releases.svg: Scarthgap is now version 5.0Michael Opdenacker
According to https://wiki.yoctoproject.org/wiki/Releases Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2023-10-05contributor-guide: style-guide: discourage using Pending patch statusRoland Hieber
Suggested-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Suggested-by: Alexander Kanavin <alex.kanavin@gmail.com> Signed-off-by: Roland Hieber <rhi@pengutronix.de> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2023-10-05contributor-guide: deprecate "Accepted" patch statusRoland Hieber
This is in accordance with the gatesgarth Release Notes: > In the ``Upstream-Status`` header convention for patches, > ``Accepted`` has | been replaced with ``Backport`` as these almost > always mean the same thing i.e. the patch is already upstream and > may need to be removed in a future recipe upgrade. If you are adding > these headers to your own patches then use Backport to indicate that > the patch has been sent upstream. <https://docs.yoctoproject.org/migration-guides/migration-3.2.html#miscellaneous-changes> Suggested-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Roland Hieber <rhi@pengutronix.de> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2023-10-05contributor-guide: discourage marking patches as InappropriateRoland Hieber
It was never really clear what all those reasons really meant, and every patch submitted upstream liftens the maintenance on the Yocto side. So remove the current list, and replace it with two reasons in which an upstream submission likely won't benefit the upstream project. Suggested-by: Alexander Kanavin <alex.kanavin@gmail.com> Signed-off-by: Roland Hieber <rhi@pengutronix.de> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2023-10-05contributor-guide: recipe-style-guide: add section about CVE patchesRoland Hieber
This was previously included in the OpenEmbedded wiki page [1], but was not ported along with the rest in commit 95c9a1e1e78bbfb82ade (2023-09-12, Michael Opdenacker: "contributor-guide: recipe-style-guide: add Upstream-Status"). [1]: https://www.openembedded.org/index.php?title=Commit_Patch_Message_Guidelines&oldid=10935 Group the examples in their own sections (but name it differently from any other section in this document so that sphinx doesn't generate a warning about duplicate labels). Signed-off-by: Roland Hieber <rhi@pengutronix.de> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2023-10-05contributor-guide: recipe-style-guide: add more patch tagging examplesRoland Hieber
Signed-off-by: Roland Hieber <rhi@pengutronix.de> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2023-10-05dev-manual: new-recipe.rst: replace reference to wikiMichael Opdenacker
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2023-10-05bsp-guide: bsp.rst: replace reference to wikiMichael Opdenacker
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2023-10-05contributor-guide/style-guide: Add a note about task idempotenceRichard Purdie
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org> CC: Yoann Congal <yoann.congal@smile.fr> --- Changes in V2: - Use a bulleted list to clarify the order of steps (Suggested by Yoann Congal) - Recall that we are talking about idempotence in tasks. Useful for people overlooking the previous paragraph.
2023-10-05contributor-guide/style-guide: Refer to recipes, not packagesRichard Purdie
Whilst often referred to as packages by people we should use the more accurate term in documentation, 'recipe' instead of 'packages'. Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2023-09-20ref-manual: point outdated link to the new locationRoland Hieber
Signed-off-by: Roland Hieber <rhi@pengutronix.de> Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2023-09-20template: fix typo in section headerRoland Hieber
Signed-off-by: Roland Hieber <rhi@pengutronix.de> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2023-09-20dev-manual: licenses: mention SPDX for license complianceMichael Opdenacker
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> CC: Joshua Watt <JPEWhacker@gmail.com>
2023-09-20contributor-guide: recipe-style-guide: add Upstream-StatusMichael Opdenacker
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2023-09-20dev-manual: new-recipe.rst fix inconsistency with contributor guideMichael Opdenacker
This document was suggesting a way to version pre-releases which doesn't match the latest recommendations from the contributor guide. Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2023-09-20dev-manual: disk-space: improve wording for obsolete sstate cache filesMichael Opdenacker
Replace "duplicate" by "obsolete", more appropriate. "duplicate" probably comes from the "--remove-duplicated" option of the sstate-cache-management.sh script. Improve other sentences too. Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Reported-by: Richard Purdie <richard.purdie@linuxfoundation.org> CC: Quentin Schulz <quentin.schulz@theobroma-systems.com>
2023-09-20sdk-manual: extensible.rst: fix multiple formatting issuesMichael Opdenacker
Take advantage of this edit to also fix alignment issues in the sources. Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2023-09-08dev-manual: disk-space: mention faster "find" command to trim sstate cacheMichael Opdenacker
[YOCTO #15182] Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Reported-by: Yoann CONGAL <yoann.congal@smile.fr> Reported-by: Randy MacLeod <randy.macleod@windriver.com> Reported-by: Josef Holzmayr <jester@theyoctojester.info>
2023-09-07README: Update to point to new contributor guideRichard Purdie
Now we have a contributor guide combining various wiki pages, point at that and tweak to match our other READMEs. Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2023-09-06manuals: add new contributor guideMichael Opdenacker
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2023-09-06dev-manual: remove unsupported :term: markup inside markupYoann Congal
":term:`Initramfs`" in bold text appears verbatim (no link is created). The term link is present elsewhere in the text so remove the extra markup. Signed-off-by: Yoann Congal <yoann.congal@smile.fr> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2023-09-06ref-manual: system-requirements: update supported distrosMichael Opdenacker
- Update according to changes in SANITY_TESTED_DISTROS (meta-poky/conf/distro/poky.conf) - No longer declare as "Supported" the distributions versions which are End of Life for their vendors, as some of them (Ubuntu for example) ship updates to subscribers only, which the Yocto Project has no access to. - List distribution versions which were previously tested for the branch of the Yocto Project being considered. Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2023-09-05migration-guides: add release notes for 4.0.12Lee Chee Yang
Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2023-09-04migration-guides: add release notes for 4.2.3Lee Chee Yang
Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2023-08-10[mickledore] dev-manual: wic.rst: Update native tools build commandyocto-4.2.3mickledore-4.2.3Daniel Semkowicz
Requirements list seems to be outdated. It is not possible to follow instructions for Raw Mode as not all of the native tools are available. All wic dependencies are gathered under wic-tools package. Some commands in the instruction already use wic-tools native sysroot, but this dependency is not specified in the requirements. Update the command for building native tools to use wic-tools instead of the seperate packages. Signed-off-by: Daniel Semkowicz <dse@thaumatec.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2023-08-08[mickledore] migration-guides: add release notes for 4.2.2Lee Chee Yang
Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2023-07-31[mickledore] ref-manual: document image-specific variant of INCOMPATIBLE_LICENSEAlexander Kanavin
This has been around without being properly documented since 2019 (!!!), and is nowadays the preferred method for enforcing license restrictions, especially since meta-gplv2 is officially obsolete. Signed-off-by: Alexander Kanavin <alex@linutronix.de> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2023-07-21[mickledore] ref-manual: LTS releases now supported for 4 yearsMichael Opdenacker
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2023-07-20[mickledore] migration-guides: add release notes for 4.0.11Lee Chee Yang
Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2023-07-20[mickledore] migration-guides: add release notes for 4.0.10Lee Chee Yang
Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com> Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
2023-07-20[mickledore] conf.py: add macro for Mitre CVE linksMichael Opdenacker
Useful for CVEs that are not found (yet) on https://nvd.nist.gov/ Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>