Commit Graph

6827 Commits

Author SHA1 Message Date
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
Lee Chee Yang
ceb46cce4b migration-guides: add release notes for 5.0.15
(From yocto-docs rev: 7e89c8b93f07a3a2fa50448121a6f64b1aae65f0)

Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit 6256a73d71346275f06970c6b1be9df0dd59bc21)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2026-02-10 13:11:48 +00:00
Quentin Schulz
5e1f0f620d sdk-manual: appendix-obtain: fix default path for eSDK installer script
The eSDK installer script installs in poky_sdk directory but under the
user's home directory so let's make that explicit.

(From yocto-docs rev: 9811bee2e33002b449d073a3f3be1889e249ee2a)

Signed-off-by: Quentin Schulz <quentin.schulz@cherry.de>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit 52ec12522bad3bbdff937f1c66224aa9b2d299cd)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2026-02-10 13:11:48 +00:00
Quentin Schulz
0ad5299bcd sdk-manual: using: fix SDK filename example
I'm pretty sure we meant to use the DISTRO poky.yaml.in placeholder
which can only be replaced when surrounding by & and ; characters.
Therefore let's fix this oversight.

Also, the example isn't actually pointing at the snapshot, but the
actual release, so let's reword that as well so it matches the example.
I decided to do that instead of adding +snapshot to the filename because
the example in the next section is actually using that same filename so
for consistency it seemed more appropriate.

(From yocto-docs rev: 27f259434f5bc3914d2c2b74961d744f7bffbcdc)

Signed-off-by: Quentin Schulz <quentin.schulz@cherry.de>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit ede411d70ffc837e5bea4666da9706e67960b0f2)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2026-02-10 13:11:48 +00:00
Quentin Schulz
10ce846e13 sdk-manual: appendix-obtain: use parsed-literal block for naming convention of the installer scripts
It's easier on the eye to use a parsed-literal block for highlighting
things that must be changed than simply stating the word, so this makes
use of a parsed-literal block instead of a simple inline code-block and
also highlight in italic which words are placeholders.

Also make the explanation below the literal-block use the same
highlighting (italic).

(From yocto-docs rev: 648b3c3e80a3916917763e3892a5e8c8d8a72162)

Signed-off-by: Quentin Schulz <quentin.schulz@cherry.de>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit 41ee642c33cc2e7435e6037bf49fe7495ffa6133)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2026-02-10 13:11:48 +00:00
Quentin Schulz
917f8442ab sdk-manual: delete sdk-title PNG
It hasn't been used since the migration to Sphinx so let's remove it.

(From yocto-docs rev: 5ad326e61cf9f1d5fb8718dcf4e5f693bd3c4c28)

Signed-off-by: Quentin Schulz <quentin.schulz@cherry.de>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit ffaea8391b3d78c2ccf964474e03c50a1c043c6c)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2026-02-10 13:11:48 +00:00
Quentin Schulz
23abcf73f7 sdk-manual: replace sdk-environment PNG with SVG
This replaces the PNG figure with an SVG.

(From yocto-docs rev: 2b14e4d9646b6be25876865def28c07334194874)

Signed-off-by: Quentin Schulz <quentin.schulz@cherry.de>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit 39fb148792cd6b8e567a496bdbe63a50759eef36)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2026-02-10 13:11:48 +00:00
Quentin Schulz
2d42466d9d sdk-manual: appendix-obtain: replace eSDK directory structure PNG with a parsed-literal block
This PNG is totally unnecessary and makes accessibility much worse, so
let's simply replace the PNG with a parsed-literal block showing the
same directory layout with the same highlighted placeholders.

While at it, update the layout to match the more recent one (5.0.15) and
have it alphabetically sorted (mixed files and directories).

The placeholders are highlighted the same way inside and outside the
parsed-literal block for consistency.

(From yocto-docs rev: 923a35a87f72af7a678bb942186cef1cc81e1ab9)

Signed-off-by: Quentin Schulz <quentin.schulz@cherry.de>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit 77b24b4a8d437797ab25dfeb37ae5cd911c52d31)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2026-02-10 13:11:48 +00:00
Quentin Schulz
6ab741ee86 sdk-manual: appendix-obtain: replace directory structure PNG with a parsed-literal block
This PNG is totally unnecessary and makes accessibility much worse, so
let's simply replace the PNG with a parsed-literal block showing the
same directory layout with the same highlighted placeholders.

While at it, update the layout to match the more recent one (5.0.15) and
have it alphabetically sorted (mixed files and directories).

The placeholders are highlighted the same way inside and outside the
parsed-literal block for consistency.

(From yocto-docs rev: 56355f9dacc9b5cdfa6ad86d6c07dcb0511bc394)

Signed-off-by: Quentin Schulz <quentin.schulz@cherry.de>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit 0c68497ec5f6525483e5a98e15db24f651bf28ba)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2026-02-10 13:11:48 +00:00
Quentin Schulz
bd4027365a sdk-manual: appending-customizing: use none lexer for BitBake code blocks
No lexer exists for BitBake right now, so let's simply disable the lexer
entirely by using the "none" lexer.

I'm using "none" instead of "text" to be able to "easily" replace none
code blocks the day a BitBake lexer exists. I "reserve" "text" for
actual text content (e.g. a filename, or the output of a command line
without the command line).

(From yocto-docs rev: 27d3921725b71a3346a6b76c7de4c11ebbced01c)

Signed-off-by: Quentin Schulz <quentin.schulz@cherry.de>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit d682bce63cdc5aad9c2d3b932a6ba2d27ecfe107)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2026-02-10 13:11:48 +00:00
Quentin Schulz
a9615a2335 sdk-manual: working-projects: properly highlight code code-blocks
There are some blocks containing C code so highlight them as C with the
"c" lexer.

For autotool'ed files, there's no lexer available so "none" will do just
fine.

Finally, there's one Makefile code block so highlight it with the
"makefile" lexer.

(From yocto-docs rev: 6c3802113231393ff02d8ac96418f59cfc4c0124)

Signed-off-by: Quentin Schulz <quentin.schulz@cherry.de>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit 10d40604cb4affb17dda2253f82a2422d5a9bcf6)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2026-02-10 13:11:48 +00:00
Quentin Schulz
aadcf56af2 sdk-manual: fix improper indent of general form of tarball installer scripts
poky-glibc-host_system-image_type-arch-toolchain-ext-release_version.sh
is in a code-block and thus requires to be indented (it is). Sphinx
knows a block has ended when the indentation of the next line is smaller
than in the block, otherwise it's all in the same block.

The explanation of the replaceable parts in the tarball installer script
filename should be text and not part of the block, so let's do that.

While at it, reformat by putting each replaceable part in a bullet list,
highlight the replaceable part or what it can replaced with as well as
putting the replacement on the same line instead of making it a quote by
having them indented in the bullet list.

Finally, replace the literal block (::) with a parsed-literal block so
we can highlight the placeholders appropriately.

(From yocto-docs rev: 0f0ce9012349f4bb18a0c209b77b45a125f2d387)

Signed-off-by: Quentin Schulz <quentin.schulz@cherry.de>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit 04c883216158edafe6a4c4ddfb38f63ffb5d5c24)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2026-02-10 13:11:48 +00:00
Quentin Schulz
3056341eb5 sdk-manual: fix incorrect highlight language for console code-blocks
When unspecified in conf.py via the highlight_language variable (and
highlight variable for code-blocks), the lexer used for literal blocks
is "default" which tries to highlight the block as Python code.

These blocks aren't Python but simple command lines prefixed by a
prompt so let's use the "console" lexer to properly highlight.

(From yocto-docs rev: cb27e3264bcfdeec20d590dfff5cba99051d825e)

Signed-off-by: Quentin Schulz <quentin.schulz@cherry.de>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit c6039ce11d638a0b64844480e51d126fcda304b4)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2026-02-10 13:11:48 +00:00
Quentin Schulz
d38081ece2 sdk-manual: fix incorrect highlight language for text code-blocks
When unspecified in conf.py via the highlight_language variable (and
highlight variable for code-blocks), the lexer used for literal blocks
is "default" which tries to highlight the block as Python code.

These blocks aren't Python but either simply the console output or a
file name (which we should probably just double tick-quote instead), so
let's render those blocks with the "text" lexer.

(From yocto-docs rev: ff5a0859620327e4eada0082b20ad62b032d8d5f)

Signed-off-by: Quentin Schulz <quentin.schulz@cherry.de>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit 72354c27000aba3ae583894ff6112a1a017e33d5)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2026-02-10 13:11:48 +00:00
Antonin Godard
8c2c3b114e contributor-guide/recipe-style-guide.rst: explain difference between layer and recipe license(s)
Explain that the LICENSE set in a recipe does not apply to the recipe
file itself, but to the underlying software. The license of the recipe
file is the license provided in the layer itself. Give OpenEmbedded-Core
as an example for this.

Fixes [YOCTO #14410]

(From yocto-docs rev: 9d586f22b04528a12e71ee4fa794d8130320515b)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit b8a56b8b2e8c0417b2f7204f80c79b05d95e9ce4)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2026-01-26 09:41:31 +00:00