Commit Graph

6841 Commits

Author SHA1 Message Date
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
Adam Blank
07ef838410 ref-manual/variables.rst: update STAGING_DIR* descriptions
Slightly reword to emphasize the sysroots' roles during the build.
Drop double back-quote from the uses of '-native' to make it a bit
easier on the eyes.

(From yocto-docs rev: e98b2231e76243734820efc28895ab11d20b0330)

Signed-off-by: Adam Blank <adam.blank.g@gmail.com>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit 15bbfeee88eee706e06b63116c9bf0cbfb2fd91c)
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
Adam Blank
69bc220db8 ref-manual/variables.rst: update RECIPE_SYSROOT* descriptions
Slightly reword to emphasise the order of steps during staging.
Further clarify those variables' relation to STAGING_DIR* variables.

(From yocto-docs rev: 4b219d437a5674aa71b6b2544d1548987202203f)

Signed-off-by: Adam Blank <adam.blank.g@gmail.com>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit eeb22235d5310ed440692914851df0b7aac056a4)
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
Adam Blank
c81390249b ref-manual/variables.rst: update PKGDATA_DIR's description
Don't refer to it as temporary. Update the default value.

(From yocto-docs rev: 3786a02e4478c4e73531479d50d1be6e8dd8b4c7)

Signed-off-by: Adam Blank <adam.blank.g@gmail.com>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit a1432f24c94a26b372164704cf18b3c6a73b34f5)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Paul Barker <paul@pbarker.dev>
2026-04-16 14:28:11 +01:00
Adam Blank
c200de2c6c ref-manual/variables.rst: update COMPONENTS_DIR's description
Make it more evident, that it is first populated by files from
some recipes, and later used as source of those files for the
others (staging and sharing files).

(From yocto-docs rev: 156c7c685b97943bcfa5309f9656a4b9e05e44a3)

Signed-off-by: Adam Blank <adam.blank.g@gmail.com>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit cad256411e2bc380e27e2fc4ea3140476596c823)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Paul Barker <paul@pbarker.dev>
2026-04-16 14:28:11 +01:00
Adam Blank
83ceb01797 ref-manual/variables.rst: update STAGING_DIR's description
STAGING_DIR is not in direct relation to recipe-sysroot*
directries. Also it does not participate in packaging, but rather
in staging and sharing files among recipes.

(From yocto-docs rev: 0838936ad05a8d5ed410767f389d4fd1a4e379b3)

Signed-off-by: Adam Blank <adam.blank.g@gmail.com>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit 0ff189fcb82f5e845951c939197835d0a1daf87b)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Paul Barker <paul@pbarker.dev>
2026-04-16 14:28:11 +01:00
Lee Chee Yang
8643f91160 migration-guide: add release notes for 4.0.33 4.0.34
(From yocto-docs rev: 345b2f248c5353d47248bba8dd7aaa1084945324)

Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit c6bf2dafaa441273481c524b14b3867f86fc2714)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Paul Barker <paul@pbarker.dev>
2026-04-08 15:53:29 +01:00
Yanis BINARD
95212b3f84 contributor-guide/submit-changes.rst: Added missing word
(From yocto-docs rev: 640b2a85f4ca822ccd3eb7fc539457606cba9404)

Signed-off-by: Yanis BINARD <yanis.binard@smile.fr>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit 4656516415d8ff6b1bc25ef64acabee01dd5a78e)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Paul Barker <paul@pbarker.dev>
2026-04-08 15:53:29 +01:00
Antonin Godard
da5493bf86 ref-manual/system-requirements.rst: add CentOS Stream 9 to supported distros
Add CentOS Stream 9 to the list of supported distros, after it was added
to poky.conf with [1].

[1]: https://lore.kernel.org/r/f87e76ef6bd6745038616876af07c6a74b49f8c9.1773966064.git.yoann.congal@smile.fr

(From yocto-docs rev: aa7226705451e6c1ef964d49963bbed29b267c27)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Paul Barker <paul@pbarker.dev>
2026-03-31 09:08:51 +01:00
Lee Chee Yang
9ace572241 migration-guides: add release notes for 5.0.16
(From yocto-docs rev: 60b1c5e635065acc7a7cd2a22f252fc983da223f)

Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com>
[AG: apply suggestions/fix formatting, see
 https://lore.kernel.org/r/DH5U04M8BZDA.18K1BLZXWXIZS@bootlin.com]
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit 368c511dd166dc5c951be3c6f8c6c92086b9a60e)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Paul Barker <paul@pbarker.dev>
2026-03-25 17:34:13 +00:00
Quentin Schulz
b301218f4d overview-manual/concepts: list other possible class directories
Classes can be located in three different directories since Langdale
(4.1), so let's update which directories you can find in a distribution
layer.

(From yocto-docs rev: 2141bc2b04ef4210e008752a97ed82979d817dae)

Signed-off-by: Quentin Schulz <quentin.schulz@cherry.de>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit fd11d75980315d87ef375091efedad69a123f680)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2026-03-16 10:25:52 +00:00
Kristiyan Chakarov
0288ddd51d overview-manual: escape wildcard in inline markup
This change escapes the wildcard in 'recipes-*' to properly italicize
the string

(From yocto-docs rev: 53bc47aedfd924f75ee77b24d13ae69a10eef221)

Signed-off-by: Kristiyan Chakarov <kichakarov0@gmail.com>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit b5a4dca823bcc04c0254a0f53a28f61969fb6c31)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2026-03-16 10:25:52 +00:00
Antonin Godard
dffcc1fe8a ref-manual/system-requirements.rst: update end-of-life distros
Fedora 41 was made obsolete on 2025-12-15 [1].

[1]: https://docs.fedoraproject.org/en-US/releases/eol/

(From yocto-docs rev: ef9af4a9d2a0b7f08c97961958c7535b49bf0739)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2026-03-16 10:25:52 +00:00
Robert P. J. Day
b43070b570 dev-manual: delete references to "tar" package format
There is no "tar" packaging format anymore, so delete these
references.

(From yocto-docs rev: e7cbf979deb9739ee4b968672d4b03ae65b24424)

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit e2b4d75fc8d738a39c5941591523620b45bc57e3)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2026-02-27 17:45:07 +00:00
Antonin Godard
9796c90d54 Makefile: pass -silent to latexmk
This should drastically decrease the number of lines in the
docs build logs, which currently can go up to 1700000 lines on the
Autobuilder[1].

[1]: https://autobuilder.yoctoproject.org/valkyrie/#/builders/34/builds/400/steps/6/logs/stdio

(From yocto-docs rev: ac3766beaff14ea62552f811b2ffcc43f77d8dd5)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit 6e9362923d4ab5599730da2074ab9f5a36e8ba14)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2026-02-27 17:45:07 +00:00
Antonin Godard
ee156de13e what-i-wish-id-known.rst: replace figure by the new SVG
We have a new SVG figure for the Yocto Project workflow figure, which
was updated with d2aaf54bee49 ("overview-manual: convert
YP-flow-diagram.png to SVG"). The one in the "What I wish I’d known
about Yocto Project" is the same. Remove the PNG and make a reference to
the new one.

(From yocto-docs rev: ef4b9077c04ed825890abf79848f45d8e692bbf7)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit 4023c47cb6628971b0a142067c4a910420408bb9)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2026-02-27 17:45:07 +00:00
Michael Opdenacker
795acd093a ref-manual/classes.rst: fix broken links to U-Boot documentation
In the chapter describing the "uboot-sign" class

(From yocto-docs rev: 7ad53da253f6b03b75322ecc53ad6ff8fb1a4809)

Signed-off-by: Michael Opdenacker <michael.opdenacker@rootcommit.com>
Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit 7d1caa1d3229fb49d6d08ca4952b046c3164e628)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2026-02-27 17:45:07 +00:00
Yoann Congal
bf30db97f7 ref-manual/system-requirements.rst: update untested distros
Some distros were removed from the autobuilder 5 months ago:
* 070e6bf (config.py: Drop ubuntu2004 workers, 2025-10-01)
* 8238327 (config.py: ubuntu24010 was replaced with ubuntu2504, 2025-10-01)

Update their status in the supported distros list.

(From yocto-docs rev: 2c9de0d74659fef6d7b0054dfd76905fba6ef81d)

Signed-off-by: Yoann Congal <yoann.congal@smile.fr>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2026-02-27 17:45:07 +00:00
Lee Chee Yang
727b18ba30 migration-guides: add release notes for 4.0.32
(From yocto-docs rev: 369f3307368eaea605983e80047377fd19ebd6bf)

Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit 095981c08b9d63905472df5d1d60c07af96f0250)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2026-02-12 17:00:10 +00:00
Antonin Godard
8c8141abd8 dev-manual/packages.rst: fix example recipe version
The example recipe taken above is hello-world on version 1.0 (because
PV equals "1.0+git". Fix this issue.

(From yocto-docs rev: 2d765587de2a2f3383a400d9bdecf64d9b182af9)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit 411122812ced4ec32127a823896a73aacf6eb97c)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2026-02-12 17:00:10 +00:00
Antonin Godard
5cd6c94c3f dev-manual/packages.rst: rename r0.0 to r0 when PR server is not enabled
When we don't have a PR server enabled, we don't have leading ".0" to
the PKGR variable, as this is added by the PR server.

(From yocto-docs rev: e5aaccf54494978bc8c24b4920dad7135837edb7)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit 7a0324b6a10e64ee250945747db10ca88040b1ce)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2026-02-12 17:00:10 +00:00
Antonin Godard
476bdedb21 dev-manual/packages.rst: pr server: fix and explain why r0.X increments on SRCREV change
The current example of the SRCREV change triggering a gitX bump is
wrong, as both gitX and r0.X get incremented.

Why this is happening is explained in bug 15729, which I copy here:

> +gitX+ is indeed related to changes in the source code.
>
> r0.X is bumped each time the checksum of the do_package task of the
> simple-hello-world-git recipe changes. This happens here:
> https://git.openembedded.org/openembedded-core/tree/meta/classes-global/package.bbclass?id=235e6d49e5888ad04416219e10b6df91a738661a#n306
>
> This line sets the value of PRAUTO and represents the number X found in
> r0.X. It will in the end make it into EXTENDPRAUTO, which itself makes
> to PKGR == r0.X.
>
> This line calls getPR(version, pkgarch, checksum). Between test case 5
> and 6, only the checksum changes. This checksum is the checksum of the
> do_package task (gotten from get_do_package_hash() above).
>
> Now, let's dump what changed with regards to this task between two
> consecutive runs, using the sigdata file in build/tmp/stamps/:
>
> ```
> [...]
> Variable fetcher_hashes_dummyfunc value changed from '2650ad6714c3f3248abfe9d3daf1196f307ed494' to '4af682a50174f5deb0397847da97d7cdba4ad067'
> ```
>
> The last line shows that the value of fetcher_hashes_dummyfunc changed
> from '2650ad6714c3f3248abfe9d3daf1196f307ed494' to
> '4af682a50174f5deb0397847da97d7cdba4ad067'. Those are the commit hashes
> in the git history of the simple-hello-world-git repository.
>
> Now you can see why this 0.X gets bumped, is because of the SRCREV change.

Fix the example, and detail what gets changed and why.

[YOCTO #15729]

Cc: Robert Berger <pokylinux@reliableembeddedsystems.com>
(From yocto-docs rev: 11fe7dbc49a8062cda8062d320dcb2be70a3b6f3)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit 09f0430bc69024b9854c31ba6783ddd807aa4f19)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2026-02-12 17:00:10 +00:00