Commit Graph

6879 Commits

Author SHA1 Message Date
Robert P. J. Day
9a6cf0d455 dev-manual: update list of recipe files showing version numbers
Update the short list of recipe files showing examples of proper
naming, and replace obsolete "irssi" example with example using "_git"
as a version.

(From yocto-docs rev: 95691fa4e7d30ee27cb1280df20751bf449538a4)

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>
2025-06-30 17:44:22 +01:00
Robert P. J. Day
3be97486e3 dev-manual: simplify recipe names to use "oe_git" links
Shorten a small number of cumbersome recipe names by replacing them
with :oe_git: markup to link to their repositories.

(From yocto-docs rev: bdcc97d4d605c3de9682b9cb055c253547397f13)

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>
2025-06-30 17:44:22 +01:00
Adrian Freihofer
c9f2036a56 ref-manual/yocto-project-supported-features: add ppc maintainers
PowerPC (32-bit) remains relevant for our use cases, and we aim to
maintain support as long as it is feasible with reasonable effort.

For transparency, our primary focus is on maintaining
core-image-minimal. Support for more complex images may be limited
unless additional contributors join, as ongoing testing and maintenance
of these images may not be feasible otherwise.

(From yocto-docs rev: 63f0053f0f0201529bfad3e3f1b0211ac40ad1c2)

Signed-off-by: Adrian Freihofer <adrian.freihofer@siemens.com>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-06-30 17:44:22 +01:00
Alexander Kanavin
c6d279acfa migration-guides/migration-5.3.rst: add guidance for breaking WORKDIR changes
(From yocto-docs rev: f59504d8706a817e0b5a6235ebb69cb3b3ebb277)

Signed-off-by: Alexander Kanavin <alex@linutronix.de>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-06-30 17:44:22 +01:00
Antonin Godard
7367292190 ref-manual/variables.rst: document BB_GIT_DEFAULT_DESTSUFFIX
Recently added in BitBake with 378db0fdd95f ("fetch2/git: allow
overriding default unpack directory with a variable").

(From yocto-docs rev: c696f78107a4e0a26329faad11212eb7949e0c70)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-06-30 17:44:22 +01:00
Robert P. J. Day
f9277f9694 dev-manual: fix rendering of ${PN}
Current markup generates italic, not monospaced.

(From yocto-docs rev: 859ba2ea1014c351a43a59c481c4498d79f30139)

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>
2025-06-30 17:44:22 +01:00
Robert P. J. Day
5b261b188f dev-manual: correct statements that source is always tarballs
Correct two occurrences that imply source is always fetched as
tarballs.

(From yocto-docs rev: 57490852e6446672fd2cd0f3ee0befd9714c909f)

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>
2025-06-30 17:44:22 +01:00
Robert P. J. Day
c11621b39b dev-manual: show bin_package example wireless-regdb recipe
Add a snippet from the wireless-regdb recipe to demonstrate a simple
example of a bin_package recipe.

(From yocto-docs rev: cbe3e272965cb706a73de36af01e1e0c65ea4efa)

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>
2025-06-30 17:44:22 +01:00
Robert P. J. Day
2e386aea79 dev-manual: fix broken rendering of bullet point
Tweak the formatting of the bullet point title so that it renders both
the term and the bolding properly.

(From yocto-docs rev: 68068c5ab4f4c46c57bc055bd663f8e66096dd20)

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>
2025-06-30 17:44:22 +01:00
Robert P. J. Day
a9f3aa89b3 dev-manual: replace "on the contrary" with "by contrast"
The qualifier "By contrast" is more appropriate here, since that
phrase is used to introduce a point that is strikingly different from
what was just discussed, that being the substantial systemd.

(From yocto-docs rev: 3e73c7985dceb865e648f86ccd82aa0e7fc6668e)

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
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>
2025-06-30 17:44:22 +01:00
Robert P. J. Day
976f8fceb4 dev-manual: shorten bitbake.conf snippet related to static libs
Much of the reproduced bitbake.conf has nothing to do with showing how
the ${PN}-staticdev is defined, so delete most of it.

(From yocto-docs rev: e235ae40db8f4e7088b2e99e678cdf31b5e216c8)

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>
2025-06-30 17:44:22 +01:00
Robert P. J. Day
034a6278ce dev manual, CH 3: update code snippets to be more current
Nothing major, just copy-and-paste from master branch to replace aging
code examples, and a little grammmar cleanup.

(From yocto-docs rev: 74057a1ffd682754e81f5f7fbde9f233e14a0d00)

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>
2025-06-30 17:44:22 +01:00
Robert P. J. Day
06595cf590 dev-manual: CH 2, small number of clarifications
- drop reference to "opkg", just refer in general to packagers
  - correct what "QEMU" stands for (missing space)
  - correct version conditional
  - add a couple extra steps to typical workflow
  - drop implication that one can modify local poky checkout

(From yocto-docs rev: 4fea81e42c41fc42548dd9e2b42f836daba5ac6b)

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>
2025-06-30 17:44:22 +01:00
Robert P. J. Day
d06769ae03 dev-manual: correct misspelled reference to sstate-cache-management.py
(From yocto-docs rev: 3728eea352f8b326ff411aa0f20bfd433ccc7cfa)

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
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>
2025-06-30 17:44:22 +01:00
Robert P. J. Day
f36b7525bb dev-manual: minor grammar correction
(From yocto-docs rev: 4e06c7f08a36c54a7f14760e609058468fab112f)

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
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>
2025-06-30 17:44:22 +01:00
Alexander Kanavin
3b41841b27 migration-guides/migration-5.1.rst: correct S/UNPACKDIR patterns for file-only recipes
It is not necessary to set both; just setting S to UNPACKDIR is enough.

This has already been done across oe-core master, and correct advice
should be given for those who need to adjust recipes during migration.

(From yocto-docs rev: e69144a2420cf412ff62a394583acc3f82413c69)

Signed-off-by: Alexander Kanavin <alex@linutronix.de>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-06-30 17:44:22 +01:00
Alexander Kanavin
73ecebe8a6 ref-manual: correct references to WORKDIR to account for recent do_unpack changes
(From yocto-docs rev: 2e83260484c102fe7b788585cbdd7ca91ba91d85)

Signed-off-by: Alexander Kanavin <alex@linutronix.de>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-06-30 17:44:21 +01:00
Alexander Kanavin
5ebf08ad8d overview-manual: correct the bitbake tasks map section and diagram to account for sources in UNPACKDIR
(From yocto-docs rev: 52a6a642b56beb3dcf22de5ff9568f50ac138500)

Signed-off-by: Alexander Kanavin <alex@linutronix.de>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-06-30 17:44:21 +01:00
Alexander Kanavin
1180a5b591 dev-manual: replace WORKDIR with UNPACKDIR where appropriate
(From yocto-docs rev: 25ea8e2a0428b6cb66402283e64144d5ce61daf6)

Signed-off-by: Alexander Kanavin <alex@linutronix.de>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-06-30 17:44:21 +01:00
Alexander Kanavin
f4447244f5 ref-manual: drop a sentence about a 'legacy way' to specify UNPACKDIR
This wasn't specific, and is obsolete: UNPACKDIR should not be
set by recipes at all, except in very special circumstances
(e.g. gcc/clang unpacking into work-shared).

(From yocto-docs rev: a880d94d70c7ed1da8e40a02dae43ff1699941a6)

Signed-off-by: Alexander Kanavin <alex@linutronix.de>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-06-30 17:44:21 +01:00
Alexander Kanavin
75d8886ac2 overview-manual: correct value of UNPACKDIR and put S under it
(From yocto-docs rev: ec38f3c5a51887175a2cf3397c07c13c17ca2e9d)

Signed-off-by: Alexander Kanavin <alex@linutronix.de>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-06-30 17:44:21 +01:00
Dixit Parmar
d3d8d21fef ref-manual: document KERNEL_SPLIT_MODULES variable
This variable controls the kernel module spliting.

[YOCTO #15771]

(From yocto-docs rev: 198179d9c6231b5934d4fb6ede716d1dcb1442bb)

Signed-off-by: Dixit Parmar <dixitparmar19@gmail.com>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-06-30 17:44:21 +01:00
Anibal Limon
a904fe5a03 test-manual/ptest: Add info about fail state of ptest-runner/ptests
On the ML was pointed about no specific information about
ptest-runner/ptests so improve docs around.

https://lists.yoctoproject.org/g/yocto-patches/message/1622

[YOCTO #15832]

(From yocto-docs rev: 0d1fd79019883f366d796b58a01679297d7a5508)

Signed-off-by: Anibal Limon <anibal@limonsoftware.com>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-06-30 17:44:21 +01:00
Richard Purdie
60e8db8588 ref-manual/yocto-project-supported-features: Set riscv32 maintainers as TBD
This isn't committed to by anyone at this point to mark as TBD.

(From yocto-docs rev: 6b45207c8db40ef416f12348e066601975a0ca36)

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-06-24 11:29:26 +01:00
Richard Purdie
5e22c4e351 ref-manual/yocto-project-supported-features: Update to match current status
A few items were in the wrong sections or needed clarification, tweak accordinly.

(From yocto-docs rev: 85e58c4fc5d1be9a2ea9ed6b813d0168e3162dab)

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-06-20 14:28:27 +01:00
Daniel Turull
63fb85ec37 Add SPDX_INCLUDE_COMPILED_SOURCES documentation
Adding documentation for the new feature to store in SPDX
only the compiled sources.

Merged in oe-core: c6a2f1fca76fae4c3ea471a0c63d0b453beea968
 - spdx: add option to include only compiled sources

CC: Antonin Godard <antonin.godard@bootlin.com>
(From yocto-docs rev: 4dbc63ed1381fe47723d6ba5b7baf2a3b7fd19aa)

Signed-off-by: Daniel Turull <daniel.turull@ericsson.com>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-06-20 09:48:15 +01:00
Robert P. J. Day
7d68886200 bsp-guide: update all of section 1.8.2 to reflect current beaglebone conf file
(From yocto-docs rev: 5fc7794e9ae326eead16552726d74ea801fe535b)

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>
2025-06-20 09:48:15 +01:00
Robert P. J. Day
c6be4ac032 bsp-guide: update lonely "4.12" kernel reference to "6.12"
To accompany earlier updating of kernel version, update this lonely
reference to be consistent.

(From yocto-docs rev: e26c2018cd663de91ee08e0cba55eda1a4c30210)

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>
2025-06-20 09:48:15 +01:00
Quentin Schulz
e60c9d753c document how to use :doc: directive
Let's specify that we are only expecting "absolute" paths in the docs
directive for local document referencing.

(From yocto-docs rev: 2729250bf1068814e5106d1e71796e8a505963d7)

Signed-off-by: Quentin Schulz <quentin.schulz@cherry.de>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-06-20 09:48:15 +01:00
Quentin Schulz
bebe66feae tree-wide: make the :doc: directive use absolute paths
This makes all :doc: directives use an absolute paths (with the root
directory being documentation/ in the repo).

This is then consistent across the whole source and is easier to review
and move files around, you just need to know where a file is located
relative to documentation/ directory and use that.

This gets rid of paths looking in parent directory with '..' as well as
expecting a file to be in the same directory as the other file it points
to via the :doc: directive.

(From yocto-docs rev: b9457f2005b0bea49c54e9727eb30e9458084886)

Signed-off-by: Quentin Schulz <quentin.schulz@cherry.de>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-06-20 09:48:15 +01:00
Robert P. J. Day
931db3845c bsp guide: update kernel version example to 6.12
Change the sample kernel version being used from 4.4 to a more modern
6.12.

(From yocto-docs rev: 1bad12b6ccfe1c0d26918926176a0c743568de26)

Signed-off-by: "Robert P. J. Day" <rpjday@crashcourse.ca>
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>
2025-06-20 09:48:15 +01:00
Robert P. J. Day
a55b16b5c1 yp-intro: new doc reference is missing leading slash
The new ":doc:" reference for yocto-project-supported-features appears
to be missing a leading slash, causing HTML generation to fail.

(From yocto-docs rev: 4114399711ff82893a10c9eba0ff66c9af7b1c9e)

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>
2025-06-20 09:48:15 +01:00
Lee Chee Yang
7e530df240 migration-guide: add release notes for 5.0.10
(From yocto-docs rev: 5bc4c98987ff809294541657b20d2e44f70e1d2c)

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>
2025-06-20 09:48:15 +01:00
Robert P. J. Day
f4d83e7685 overview-manual: small number of pedantic cleanups
In Sections 4.3.1 and 4.3.2 of the Overview Manual, a bit of tidying
including:

  - provide full list of packaging options
  - add monospaced rendering where appropriate
  - fix broken "ref"
  - make capitalization consistent

(From yocto-docs rev: 1cf769e3c8a8442cd05449dc97e91ad482d635f3)

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>
2025-06-20 09:48:15 +01:00
Adrian Freihofer
d01f9c44ed migration-5.3: replace kernel-fitimage by kernel-fit-image
Add migration documentation for users moving from the removed
kernel-fitimage.bbclass to the new kernel-fit-image.bbclass.

(From yocto-docs rev: 4c3552940a6ff89824845473317b7f5d741d4635)

Signed-off-by: Adrian Freihofer <adrian.freihofer@siemens.com>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-06-20 09:48:15 +01:00
Adrian Freihofer
a8683de719 release-notes: drop references to kernel-fitimage
This commit drops references to the kernel-fitimage.bbclass to prevent
from build errors when the label is no longer available.

(From yocto-docs rev: 3610cfd76d1491d9ecff9816ab36df8d1b2a83c6)

Signed-off-by: Adrian Freihofer <adrian.freihofer@siemens.com>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-06-20 09:48:15 +01:00
Adrian Freihofer
7a01d262a1 ref-manual: replace kernel-fitimage by kernel-fit-image
(From yocto-docs rev: 93c92dd2837708ba00a4ca47667e60d7bb09430b)

Signed-off-by: Adrian Freihofer <adrian.freihofer@siemens.com>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-06-20 09:48:14 +01:00
Quentin Schulz
474742f808 ref-manual: classes: nativesdk: move note to appropriate section
The nativesdk- prefix to the recipe filename should only be used when
using the inherit method as the BBCLASSEXTEND method will do some magic
when generating the "implicit" name of the recipe.

This matches the instructions for the native class.

(From yocto-docs rev: 15fe239e1e62b9add737aa732dd7f5e9948ee03d)

Signed-off-by: Quentin Schulz <quentin.schulz@cherry.de>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-06-20 09:48:14 +01:00
Quentin Schulz
d349e792c1 ref-manual: classes: reword to clarify that native/nativesdk options are exclusive
We explain how to create a native (nativesdk) recipe in two different
ways via a bullet list but reading quickly the instructions may mislead
one into doing both options whereas they are incompatible.

This rewords both the nativesdk and native sections so that the second
bullet point starts with an Or and explicit that this applies to target
recipes.

(From yocto-docs rev: 6d0d338a5f2686ddeee5eed7b6e05f3db800d33a)

Signed-off-by: Quentin Schulz <quentin.schulz@cherry.de>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-06-20 09:48:14 +01:00
Antonin Godard
5132c991e6 ref-manual/yocto-project-supported-features: move meta-exein to primary
Exein is a platinum member and has primary support
(https://www.yoctoproject.org/members).

(From yocto-docs rev: b13bccbf3fb1890ac428a396f8c5081057edf555)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-06-17 10:25:50 +01:00
Antonin Godard
b42dc83ef7 overview-manual/yp-intro.rst: add RISC-V to supported archs
And mention the new supported features document.

Suggested-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: d852a2d20e876440a48a240ca68d5f440ef2cfbe)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-06-17 10:25:50 +01:00
Ross Burton
a49e9d5d9d ref-manual/yocto-project-supported-features: add a contact for meta-arm
Set the contact address for meta-arm.

(From yocto-docs rev: 8ad91366ed89204affef6a72bd403b0d0a4525fa)

Signed-off-by: Ross Burton <ross.burton@arm.com>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-06-17 10:25:50 +01:00
Antonin Godard
d3b7eb9fa5 Add a document to list supported Yocto features
Add a "Yocto Project Supported Architectures And Features" document that
aims at:

- Defining the different levels of support for features
- Listing the maintainers for a feature
- Listing the existing builders on the Autobuilder for the feature

Co-developed-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Cc: Yocto TSC <tsc@lists.yoctoproject.org>
(From yocto-docs rev: 197f28439c44e3fb7507f97be57a0c94be4a8eed)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-06-16 16:00:51 +01:00
Quentin Schulz
f98ab9c342 docs: remove lz4 from required packages
Since commit b13654a4fc2f ("bitbake.conf: Drop lz4 from HOSTTOOLS") in
OE-Core, lz4 isn't an expected host dependency anymore so let's drop it
from the list of required packages.

(From yocto-docs rev: 040556cc9bc998970eb6152f8748d359b15b4bf9)

Signed-off-by: Quentin Schulz <quentin.schulz@cherry.de>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-06-06 22:22:43 +01:00
Quentin Schulz
4549ff19aa docs: conf.py: silence SyntaxWarning on js_splitter_code
The js_splitter_code string contains backslashes that Python tries to
use as escape sequence but doesn't manage to, hence the following
SyntaxWarning message:

documentation/conf.py:188: SyntaxWarning: invalid escape sequence '\p'
  .split(/[^\p{Letter}\p{Number}_\p{Emoji_Presentation}-]+/gu)

Considering that we want this to be sent verbatim to the JS, let's make
this a raw string instead.

Fixes: d4a98ee19e0c ("conf.py: tweak SearchEnglish to be hyphen-friendly")
(From yocto-docs rev: c1056672ef45b197136eb8815728d426337a5901)

Signed-off-by: Quentin Schulz <quentin.schulz@cherry.de>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-06-06 22:22:43 +01:00
Quentin Schulz
ac52e9a94f docs: README: specify how to contribute instead of pointing at another file
This repository is partially included in another repository: poky.

However its README isn't making it, so documentation/README pointing at
the README at the root of the git repository would lead the contributor
nowhere.

Instead, let's include the appropriate information directly in
documentation/README which does make it to the poky git repo.

(From yocto-docs rev: 0298318cea2947e65754eab97255164e64a862de)

Signed-off-by: Quentin Schulz <quentin.schulz@cherry.de>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-06-06 22:22:43 +01:00
Lee Chee Yang
968fd3ad54 migration-guides: add release notes for 4.0.27
(From yocto-docs rev: 612f8c6f99297c1c3a7347be93fe713dccabeffb)

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>
2025-06-06 22:22:43 +01:00
Lee Chee Yang
93968d1eba migration-guides: add release notes for 5.2.1
(From yocto-docs rev: 0624495c4584fafffaedcdef21d65686043f45b0)

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>
2025-06-06 22:22:43 +01:00
Carlos Sánchez de La Lama
7b5409b811 ref-manual: clarify KCONFIG_MODE default behaviour
KCONFIG_MODE defaults to 'allnoconfig' when not set, regardless of whether
KBUILD_DEFCONFIG points to an in-tree or a meta-layer defconfig.

(From yocto-docs rev: f374b9c426f6c10710e011a4ad660231ee26efb8)

Signed-off-by: Carlos Sánchez de La Lama <csanchezdll@gmail.com>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-06-06 22:22:43 +01:00
Robert P. J. Day
be420892fe Clean up explanation of minimum required version numbers
Some simple rendering and grammar fixes.

(From yocto-docs rev: 9a9624bfc4c523a6edf6f3f0c336e663cc939e75)

Signed-off-by: "Robert P. J. Day" <rpjday@crashcourse.ca>
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>
2025-06-06 22:22:43 +01:00