Commit Graph

6862 Commits

Author SHA1 Message Date
Robert P. J. Day
802e4c1135 ref-manual: add more explanation to glossary variable LICENSE
Add the following to the variable glossary LICENSE entry:

  - it is a required variable in an OE recipe
  - it must be accompanied by LIC_FILES_CHKSUM, except in the
    case where LICENSE = "CLOSED"

(From yocto-docs rev: 1b819d324780a699d9307a2d4e68c69b576ab748)

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit a75f75fe86c339246b94b78c593c54647a75ba6a)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Paul Barker <paul@pbarker.dev>
2026-06-22 21:23:17 +01:00
Robert P. J. Day
0e35838b91 ref-manual: document RM_WORK_EXCLUDE_ITEMS variable
Add an explanation of the RM_WORK_EXCLUDE_ITEMS variable to both the
Reference Manual variables and classes sections.

(From yocto-docs rev: fa007992c5df04e51de4fbd8edbcf29583cb49f0)

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit 62c96090be7aeffe7010b70e8dfd5166e506140f)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Paul Barker <paul@pbarker.dev>
2026-06-22 21:23:17 +01:00
Robert P. J. Day
267e62dae3 ref-manual: clarify use of "PACKAGE_ARCH" in a packagegroup
Warn the developer that if they need to set "PACKAGE_ARCH" in a
custom packagegroup file, that setting must precede the "inherit
packagegroup" line in the packagegroup recipe file.

(From yocto-docs rev: 9d84e1ccddb2cf17641447721cd2b0b524ef872f)

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit 98a14fe885370d52a6f46e940834c725bad6933d)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Paul Barker <paul@pbarker.dev>
2026-06-22 21:23:17 +01:00
Robert P. J. Day
cee4047ae6 dev-manual: SysVinit is the default init manager for Poky
Correct the opening sentence of the Init Manager section to clarify
that SysVinit is the default init manager if one is using the Poky
distro.

(From yocto-docs rev: 16e6447ab91b53fed78128dc4d000bc8c086a221)

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit d467da2ccb5a78ac6a5ca9d976a435b4d4e0e270)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Paul Barker <paul@pbarker.dev>
2026-06-22 21:23:17 +01:00
Robert P. J. Day
2bb53d9e91 dev-manual: update AUTOREV explanation to match current file
The code snippet for listing AUTOREV-enabled recipes needs updating
since it now inherits the "poky-bleeding" class file.

(From yocto-docs rev: f4db42b820d489cb20d5b306f66a4f244fdc9338)

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit fcf87058a1e6ef77904d74128574028660d5a4ab)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Paul Barker <paul@pbarker.dev>
2026-06-22 21:23:17 +01:00
Robert P. J. Day
9ac1b69234 kernel-dev: remove references to defunct LTSI project
As the last kernel release under LTSI (Long-Term Support Initiative)
was back in 2018, remove references to it.

(From yocto-docs rev: dcd16f58847b9d6bb593e0ae934c4055a6468b02)

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit b2063f6bb4c80e533a11de87d0daddf54e16cd2b)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Paul Barker <paul@pbarker.dev>
2026-06-22 21:23:17 +01:00
Robert P. J. Day
8545287b86 dev-manual: fully define SOLIBS-related variables in bitbake.conf
The current (abridged) SOLIBS-related variables were not included in
their entirety so add the missing content.

(From yocto-docs rev: 9ff28bf8ef2c1d184b1e7b00287749b54f006734)

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit 6098e0887161ffda87e62dd460702197269d5982)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Paul Barker <paul@pbarker.dev>
2026-06-22 21:23:17 +01:00
Robert P. J. Day
df15896a9d dev-manual: fix broken grammar in "Libraries" section
(From yocto-docs rev: 2891c40e0f0b491fe45c215465ba74628d870a3f)

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit ff83e149175dc7470770cc53fd75a243d0fc8191)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Paul Barker <paul@pbarker.dev>
2026-06-22 21:23:17 +01:00
Robert P. J. Day
de584eb9a8 dev-manual: fix grammatical error, missing word "with"
Add the missing word "with."

(From yocto-docs rev: f67b98070a069eebfe9826467fc681c6ddc3f68c)

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit b2820e987abc15b474152e51cd76e9bf30660a69)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Paul Barker <paul@pbarker.dev>
2026-06-22 21:23:17 +01:00
Robert P. J. Day
baa014ae15 dev-manual: drop "PREFERRED_VERSION" from x86-base.inc snippet
The machine include file "x86-base.inc" no longer includes the line
setting the PREFERRED VERSION -- that setting was removed in commit
298fa078fab58b64246376ffd70ad6a0c7589876 on Oct 1, 2023:

    qemux86/qemuarm: Drop kernel version overrides

    Drop the version overrides for the kernel for the x86 and arm machines
    so we can go back to following the distro versions. The reasons for
    these versions is mostly historical at this point as the issues were
    resolved.

(From yocto-docs rev: 5185c770c30f1041ae1f14290e75f5cc8cfe690d)

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit a70ce32d8e314afa833079e17757dc9b19590c56)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Paul Barker <paul@pbarker.dev>
2026-06-22 21:23:17 +01:00
Peter Marko
4ac62a70a3 build-manual: update ROOTFS_POSTPROCESS_COMMAND example
Some commands were moved from ROOTFS_POSTPROCESS_COMMAND to
ROOTFS_POSTUNINSTALL_COMMAND.
Since ROOTFS_POSTUNINSTALL_COMMAND is not in printed subset, just remove
the tasks instead of moving them.

Corresponding oe-core change:
https://git.openembedded.org/openembedded-core/commit/?id=c3097962ac925538e99b17b771c541950a8b8c26

(From yocto-docs rev: 692ef46378ab15dceba3248d825246f9187de02e)

Signed-off-by: Peter Marko <peter.marko@siemens.com>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit cee160c2387b9bb8befad6e2e7f59575a014418c)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Paul Barker <paul@pbarker.dev>
2026-06-22 21:23:17 +01:00
Robert P. J. Day
bb00844600 ref-manual: clarify that PACKAGE_EXCLUDE supports DEB packaging
As an accompaniment to earlier commit
0d05dedd62a6d4c726f120a23654ede1f0b23d8e, correct that the
PACKAGE_EXCLUDE variable supports the DEB packaging backend.

(From yocto-docs rev: 7cb1b61247852c0693950f034aa88dcd6dc3accd)

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit 195fc0981996998ba2939bb9ce8770f396e5f438)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Paul Barker <paul@pbarker.dev>
2026-06-22 21:23:17 +01:00
Lee Chee Yang
d03f09df0a migration-guide: add release notes for 5.0.18
(From yocto-docs rev: 76f4b5ded4aa04ca1404510f0232593a968e0f66)

Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com>
[AG: add note on large CVE updates for linux-yocto]
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit be424bf52cd3ac9c83a4617d0b06afe8cde055be)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Paul Barker <paul@pbarker.dev>
2026-06-08 21:44:06 +01:00
Robert P. J. Day
9c1cc745bc contributor-guide: couple minor typo/grammar fixes
- font fix
  - missing word fix

(From yocto-docs rev: c7e020d278ded715fc24034b000fb93f554b606c)

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit a9bf37a1166120f8870422aceaf2f3d8cb53788a)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Paul Barker <paul@pbarker.dev>
2026-06-08 21:44:06 +01:00
Peter Marko
de21795014 dev-manual: remove semicolons for rootfs commands
Usage of semicolon as separator in ROOTFS/IMAGE_*COMMAND was deprecated
long time ago.
Code was changed to not include it anymore.
Update the example.

(From yocto-docs rev: 0ec798cecaae31e5bba13261d72dc8c5492b6b1f)

Signed-off-by: Peter Marko <peter.marko@siemens.com>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit fa0b3fc4218e75b88b7811a3f2bfefdb0ca6496e)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Paul Barker <paul@pbarker.dev>
2026-06-08 21:44:06 +01:00
Robert P. J. Day
b490165ba1 overview-manual: update deploy.bbclass snippet
The current contents of deploy.bbclass is slightly different so update
the code snippet and the subsequent explanation of that snippet.

(From yocto-docs rev: b5cfd275cdd620b5260c5e66e254363be795e798)

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit aec2a39ea648694bb5a30da216b721018e8bb670)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Paul Barker <paul@pbarker.dev>
2026-06-08 21:44:06 +01:00
Robert P. J. Day
a5d09faf04 overview-manual: use correct spelling "counterpart"
"counterpart" is one word, not two -- this is the only example in all
the docs that needed fixing.

(From yocto-docs rev: 3511578f29e93702931883cd6537c57a5994d5cd)

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit 555061075725440d3aa6373624082bef6ee6e31f)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Paul Barker <paul@pbarker.dev>
2026-06-08 21:44:06 +01:00
Robert P. J. Day
62c57ccac1 overview-manual: mention that patch files can be compressed
Ensure the reader understands that patch files can be compressed.

(From yocto-docs rev: 39c5dff022620818bbbfeb4ad10f0f9e5b1e8d35)

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit a1070100ecdf600ca9468a4115f9f9a1bf94f448)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Paul Barker <paul@pbarker.dev>
2026-06-08 21:44:06 +01:00
Paul Barker
f9b6465aa0 security-team: Add section on multi-project embargoes
This text is migrated from the Security private reporting wiki page [1],
originally written by Marta.

[1]: https://wiki.yoctoproject.org/wiki/index.php?title=Security_private_reporting&type=revision&diff=86034&oldid=86033

Cc: Marta Rybczynska <marta.rybczynska@ygreky.com>
(From yocto-docs rev: 365b24e25f47ab91ccdabd309aeb34e5ef5a9eb7)

Signed-off-by: Paul Barker <paul@pbarker.dev>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit c5438ff6f02856afaff9575ac21e9959158efc4b)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Paul Barker <paul@pbarker.dev>
2026-06-08 21:44:06 +01:00
Paul Barker
89274ac93d security-team: Tidy and update section on security team operations
The section "What Yocto Security Team does when it receives a security
vulnerability" duplicated information already found in the previous
section "Security Team Operations", so merge the sections and tidy up
the flow of the text.

While we're editing this, Mitre is now just one of the places you can go
to get a CVE assigned, many other CVE Numbering Authorities (CNAs) are
available. They also now have a web form for contact and requesting CVE
assignment so let's link directly to that.

Also drop "If an upstream project does not respond quickly" down a
heading level.

(From yocto-docs rev: ca6a21c7cf652fabd0d48fda735a9074f9fe8af7)

Signed-off-by: Paul Barker <paul@pbarker.dev>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit 8efdc7df5c75e92449e74e4d40b763ee1df07adc)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Paul Barker <paul@pbarker.dev>
2026-06-08 21:44:06 +01:00
Paul Barker
921c3654d8 security-team: Update membership list
Steve Sakoman has retired from the project. The TSC announced the need
for a new security team member and nominated me to join the team [1],
which was then confirmed after the nomination/comments period closed
[2].

[1]: https://lists.openembedded.org/g/openembedded-architecture/message/2352
[2]: https://lists.openembedded.org/g/openembedded-architecture/message/2375

(From yocto-docs rev: 22d0993a7e4c4438e80b29bd01407a5df5386768)

Signed-off-by: Paul Barker <paul@pbarker.dev>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit 9aca7328ae7bfd80fa9ed4a3c7efc9422b83b534)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Paul Barker <paul@pbarker.dev>
2026-06-08 21:44:05 +01:00
Marta Rybczynska
2fd091dc4d security-team.rst: update my email address and key
Update my email address and expired key

(From yocto-docs rev: 527852c0398e85e437effebad9c46e78f90d306f)

Signed-off-by: Marta Rybczynska <marta.rybczynska@ygreky.com>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit 7d4ebbf510f47edfef87ab3727f372c24fa5fc13)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Paul Barker <paul@pbarker.dev>
2026-06-08 21:44:05 +01:00
Robert P. J. Day
da03ea708b overview-manual: provide a more expansive definition of "layer"
A layer is not simply a collection of recipes; it can include any
combination of recipe files, machine and distro configuration files,
class file and more, so make that clear. In fact, a layer is not
required to contain any recipe files at all.

(From yocto-docs rev: 4050b1002e1d1273fb3e0908bd42308e4f95e355)

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit 9d2fe509ff2ab43ea73d6cb7feaa44669ad83f0d)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Paul Barker <paul@pbarker.dev>
2026-06-08 21:44:05 +01:00
Robert P. J. Day
bee8b23299 overview-manual: add ":term:" for OE Build System
Add a ":term:" reference for the phrase "Openembedded Build System",
to be consistent with the earlier reference for "Poky".

(From yocto-docs rev: 938bcb41cdc5337c9f662b113381ac1ba59fb87c)

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit 2a8bc4f1b25c818ddc517a6eee6a0c3ba653db6d)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Paul Barker <paul@pbarker.dev>
2026-06-08 21:44:05 +01:00
Antonin Godard
b8e34bb802 ref-manual/variables.rst: link *MIRRORS definitions to the BitBake manual
Those are defined in BitBake documented, and would be better documented
there. Add a link to the BitBake manual for these variables.

Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>
(From yocto-docs rev: 3210b5375356ad7097ecbf27ffdb50189a0ea6fe)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit cec08390bad4f26b841ff6fc8752f6200acf31d3)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Paul Barker <paul@pbarker.dev>
2026-06-08 21:44:05 +01:00
Robert P. J. Day
d440c88af7 overview-manual: inform the reader early of "bitbake-getvar"
Given how Chapter 4 of the Overview Manual introduces so many of the
variables that define a build, briefly introduce the reader to the
"bitbake-getvar" command so they can examine those variables.

(From yocto-docs rev: ccd3b07fb7a24877aeea80d24456e41c93266015)

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit 33f57d154ad1ec950c59c5aab20e0a0323ef19cc)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Paul Barker <paul@pbarker.dev>
2026-06-08 21:44:05 +01:00
Robert P. J. Day
b9e00fdea3 bsp-guide: update guide to reflect newer beaglebone
Update the section on describing the Beaglebone contents to reflect
the current content in the meta-yocto-bsp layer.

(From yocto-docs rev: 8ebcf1ea8e4add4045f643bde3bb48d5ff560497)

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit bd5be9cc9d5aa7cca63877f3a22089c9dc02f135)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Paul Barker <paul@pbarker.dev>
2026-06-08 21:44:05 +01:00
Robert P. J. Day
9ff4f7dd3a bsp-guide: mention bootloader and device tree in BSP intro
In the intro to the BSP guide, mention that a BSP layer might also
contain content related to the bootloader and device tree files.

(From yocto-docs rev: ba48bdeee06522d7334ccb624053f4f363556a15)

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit a6eca1e7c67225de8b32638b4ba10aa73efe5030)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Paul Barker <paul@pbarker.dev>
2026-06-08 21:44:05 +01:00
Robert P. J. Day
e480ed7e2c recipe-style-guide.rst: two minor grammatical tweaks
Minor rewording in two places.

(From yocto-docs rev: d08a1381231b068461f39de47154e971c71acd52)

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit 382f2cbea16efc13a1bcf14a3276add8aabeec4e)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Paul Barker <paul@pbarker.dev>
2026-06-08 21:44:05 +01:00
Robert P. J. Day
7ddcb1e8c7 overview-manual: hyphens not allowed in file version
The Recipe Style Guide makes it clear that you can't have hyphens in
the version part of a recipe file name.

(From yocto-docs rev: 935bdb0d03bdb3f186ffd36faf37d5255a5b9522)

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit b9c7aa835576f154dff1c565e835bffd298af7c3)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Paul Barker <paul@pbarker.dev>
2026-06-08 21:44:05 +01:00
Robert P. J. Day
cc4645864e overview-manual: fix typo, "semi-colon" -> "colon"
Obviously, this sentence should say "colon", not "semi-colon".

(From yocto-docs rev: f87c6ee9a2965b2978b93ccfd76dce0cb853bd9f)

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit 837e4de00f67b87c60faf21aab2dee913ba813b0)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Paul Barker <paul@pbarker.dev>
2026-06-08 21:44:05 +01:00
Robert P. J. Day
aa4087cb46 overview-manual: remind reader that meta-poky is a distro layer
Even though it's mentioned a little earlier on that same page, when
defining the properties of a "Distro Layer," remind the reader that
"meta-poky" is an example of such a layer.

(From yocto-docs rev: 27a3d7d4c30f2957661d00455c15f830e1281bb9)

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit 4c57f21b681ca92e89903a79b2404132d5b00f10)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Paul Barker <paul@pbarker.dev>
2026-06-08 21:44:05 +01:00
Antonin Godard
5e5b675713 conf.py: add a :yocto_bug: role
Similar to :yocto_bugs: but directly create a hyperlink to the bug
displayed with its identifier. Use as :yocto_bug:`12345`.

(From yocto-docs rev: a84f0e63550c2c72497c5b563f72fcfa16c3ee8f)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit 24e227262df909353ef8874335cdeb114b9d4203)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Paul Barker <paul@pbarker.dev>
2026-06-08 21:44:05 +01:00
Antonin Godard
9cc678e08e conf.py: define new *_path roles
Defines three new bitbake_path, meta_yocto_path, and oecore_path roles
that can be used to quickly reference a file or directory in one of
those repositories and link to our web interface for the path, e.g.
:oecore_path:`meta/conf/bitbake.conf`.

(From yocto-docs rev: cc2bb929002ed29fdb2601cf02f47de315656d27)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit 89cf4b98686f6f353811d444f36848410ffd2929)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Paul Barker <paul@pbarker.dev>
2026-06-08 21:44:05 +01:00
Antonin Godard
6218924ef8 conf.py: define new {oecore,bitbake,meta_yocto}_rev roles
Use the extlinks extension to create new roles to quickly reference a
commit from openembedded-core, bitbake, or meta-yocto.

For example, use as: :oecore_rev:`437e0419608e`.

Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>
(From yocto-docs rev: 54cd2278e9f72837013831b6ce6d4aff61982899)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit 79552b4a764d16282a86c8e017270a258a26240e)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Paul Barker <paul@pbarker.dev>
2026-06-08 21:44:05 +01:00
Robert P. J. Day
d4576e3c08 contributor-guide: fix type "maintainance" to "maintenance"
Correct "maintainance" typo in recipe-style-guide.rst.

(From yocto-docs rev: f39ba5141cd518f08d491b2255a4acd74442e87b)

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit d7376cca64a0784e59d4fd60b9baefb4da2ce289)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Paul Barker <paul@pbarker.dev>
2026-05-20 09:17:14 +01:00
Robert P. J. Day
10837d3a3b overview-manual: fix "checkout" versus "check out"
As with "setup" versus "set up", the pedants at grammarist.com explain
that "checkout" is used as a noun or adjective, while the
corresponding verb is two words, "check out."

  https://grammarist.com/spelling/checkout-check-out/

(From yocto-docs rev: 85852e0a1e5ddf034cff979329591af786967beb)

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit 1d5f0fea4e150be0ef9b10d5733eeaba06c78e6f)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Paul Barker <paul@pbarker.dev>
2026-05-20 09:17:14 +01:00
Robert P. J. Day
1c4a535dd8 What I Wish I'd KNown: Various pedantic cleanups
Tweaks:

  - Update "Software Overview" link to go to "Technical Overview"
  - use proper capitalization for "Git" when referring to the product
  - numerous grammar adjustments to basic skills list

(From yocto-docs rev: 9b440c5116828f131a304b77f5da8c98c0d27c62)

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit ffd69f11172c2b0d8f52bd967c7983220d133e0d)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Paul Barker <paul@pbarker.dev>
2026-05-20 09:17:14 +01:00
Robert P. J. Day
3de4303196 "Transitioning ..." doc: Various pedantic cleanups
Tweaks:

  - grammer adjustments
  - hyphenation
  - monospace font for layer and file names

(From yocto-docs rev: 8e98a7264bf9d0d975b5c8fb2062ed907273ff5c)

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>
(cherry picked from commit 801f719458d0d9670debad4ddc379e3ade4d85f9)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Paul Barker <paul@pbarker.dev>
2026-05-20 09:17:14 +01:00
Robert P. J. Day
cee4c1df5a YP Quick Build: delete extraneous periods in list
Delete inconsistent periods in software versions list so it doesn't
look weird.

(From yocto-docs rev: a106dea889259a872fdbe69215fe4de740bc49f4)

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>
(cherry picked from commit 94ebe744d0e95672456b8157daf0ffba333397bd)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Paul Barker <paul@pbarker.dev>
2026-05-20 09:17:14 +01:00
Robert P. J. Day
ec370051a9 yp-intro.rst: add link to "buildbot"
When referring to buildbot, add a link to its home page.

(From yocto-docs rev: 40b6f86daea61e545d94e92b8eed11c8038573ad)

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit 7a9247175e1afc74371708d4bad629941477eb57)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Paul Barker <paul@pbarker.dev>
2026-05-20 09:17:14 +01:00
Robert P. J. Day
6ffe5c1335 yp-intro.rst: delete really old references
There seems to be be little value in continuing to point readers to
two references, one almost a decade old, the other almost 15 years
old, especially in the middle of a guide that ostensibly is part of
the introductory material.

(From yocto-docs rev: eb92a7cc3fe7772f202e9955974d79b359a257d7)

Signed-off-by: Robert P. J. Day <robday@acresecurity.com>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit 5b4ffc020a9b0c7a877c119058cd43a51f91687f)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Paul Barker <paul@pbarker.dev>
2026-05-20 09:17:14 +01:00
Robert P. J. Day
3861cee8fd index.rst: update "Software Overview" to "Technical Overview"
Fix the title and link so it goes directly to the
Technical Overview.

(From yocto-docs rev: 1ba3a389b47188b6c664ae3a0bee7ca70e462650)

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit 0143b586572e15cac438f0fa6f3c1e7446597020)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Paul Barker <paul@pbarker.dev>
2026-05-20 09:17:14 +01:00
Lee Chee Yang
6d30861b9b migration-guide: add release notes for 4.0.35
(From yocto-docs rev: 07f7f75129d7462c4d9d8256f140658cce8caa33)

Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit 39ef57628b4fb262857d8bf55abe3e6fe7ff01f1)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Paul Barker <paul@pbarker.dev>
2026-05-20 09:17:14 +01:00
Dawid Bijak
0b73ea395b overview-manual/concepts.rst: fix do_prepare_recipe_sysroot task description
The description incorrectly stated that the sysroots are set up for
use during the packaging phase. In fact, do_prepare_recipe_sysroot
runs before do_configure, and the sysroots are consumed by
do_configure and do_compile.

Refer to do_configure and do_compile as the tasks that consume
prepared sysroots. Briefly describe the role of each sysroot.
Link do_configure, do_compile, and do_populate_sysroot via
:ref: to ease navigation.

Suggested-by: Alexander Kanavin <alex.kanavin@gmail.com>
Suggested-by: Antonin Godard <antonin.godard@bootlin.com>
(From yocto-docs rev: 1c5e7f136d7460fa5ad4c8a49ab1de31bd670e59)

Signed-off-by: Dawid Bijak <bijak.dawid@gmail.com>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit b50e8d36bdab53b004711ebc284d8ce8be593859)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Paul Barker <paul@pbarker.dev>
2026-04-28 14:01:16 +01:00
Robert P. J. Day
2891fa16c9 dev-manual: "--runonly" should be "--runall"
To properly fetch all the sources as suggested by the docs, one should
use "--runall=fetch".

(From yocto-docs rev: eb6a87177cec679eae9b2dfae86f49d9789c0ab1)

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit 0be8663d1f9e910c304e0960dd9e024e38646480)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Paul Barker <paul@pbarker.dev>
2026-04-28 14:01:16 +01:00
Robert P. J. Day
6a3d16d7b8 variables.rst: expand explanation of RSUGGESTS
Add that the RSUGGESTS variable would be processed only by a
supporting package manager when installing packages from a
package feed, and add a link to the appropriate section in
the Developers Manual.

(From yocto-docs rev: 2c80b891d85e0a7d9b70fc7b4a9c032325b56eca)

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit 48c832376cc3d33785d790a3e76b52ed2f8895bf)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Paul Barker <paul@pbarker.dev>
2026-04-22 09:48:06 +01:00
Antonin Godard
5a3aeb80ff sphinx-static/theme_overrides.css: switch to a fixed width documentation
Change the css rules of our theme to have a fixed-width documentation
instead of it taking the full width of the page. I believe this makes it
much more readable compared to having long lines with few line returns,
especially on high-resolution displays. Set the width to 1000px instead
of the previous 800px, which felt slightly too thin.

I think the removed comment here does not make that much sense for us.
It was added by commit 0c1e108bc6c4 ("sphinx: add CSS theme override"),
and I believe is a simply copy and paste of what was is set in the Linux
kernel, added by commit 9abaf979abb2 ("doc-rst: customize RTD theme,
table & full width") [1].

[1]: https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=9abaf979abb2

(From yocto-docs rev: 680edf7ffdf2286c64c32de74be5b6353294122f)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit 98234c9d3a0846d719630914bea8599da9f51374)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Paul Barker <paul@pbarker.dev>
2026-04-22 09:48:06 +01:00
Lee Chee Yang
e352389ad9 migration-guide: add release notes for 5.0.17
(From yocto-docs rev: 7e915dfcb25be6e038f01b96dee8ec388f15ec55)

Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit 7b671218b3034f3774b6ca1759dd971c3ff5c4df)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Paul Barker <paul@pbarker.dev>
2026-04-22 09:48:06 +01:00
Adam Blank
cb2dcb4963 ref-manual/variables.rst: correct a reference to STAGING_DIR*
The reference to STAGING_DIR* variables in the description of
DEPENDS was misleading, as it pointed at STAGING_DIR which is
unrelated in this context.

(From yocto-docs rev: 48d15a62ed7c004fd6e1dced03923bac529c435e)

Signed-off-by: Adam Blank <adam.blank.g@gmail.com>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit 2da8e6334e3d3362c9177f78a1216156417903fc)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Paul Barker <paul@pbarker.dev>
2026-04-16 14:28:12 +01:00