Commit Graph

6879 Commits

Author SHA1 Message Date
Richard Purdie
4c9eef335a brief-yoctoprojectqs/ref-manual: Switch to new CDN
The project is switching the way handle our CDN provision of sstate objects,
update the URL accordingly.

(From yocto-docs rev: 406e8a8e30404c0538f5aa46f211540bae2b206b)

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-05-29 17:34:48 +01:00
Jamin Lin
fe11965d14 ref-manual: uboot-sign: Support firmware property in FIT config
Add documentation for the UBOOT_FIT_CONF_FIRMWARE variable, which allows
users to specify an image to be assigned to the "firmware" property of
the FIT configuration node. This explicitly defines the primary image
to boot, instead of relying on the first entry in the "loadables" list.

(From yocto-docs rev: f72fc69e2d2a074d5eaf1cc36b30726de58e3ab5)

Signed-off-by: Jamin Lin <jamin_lin@aspeedtech.com>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-05-26 13:02:49 +01:00
Antonin Godard
e2192ecec1 brief-yoctoprojectqs/index.rst: replace removed macro
The UBUNTU_DEBIAN_HOST_PACKAGES_ESSENTIAL macro was removed after
8d993022c2ae ("docs: use literalinclude for system requirements").
Replace by the literalinclude like in the reference manual.

Reported-by: "Robert P. J. Day" <rpjday@crashcourse.ca>
(From yocto-docs rev: 1316bd95f4c4107549de34b78bca0499233497e8)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-05-26 13:02:49 +01:00
Trevor Woerner
be2eaa114b sphinx-lint: unbalanced inline literal markup
Fix as many instances of unbalanced-inline-literals-delimiters as reported
by 'make sphinx-lint' as possible. Sphinx and/or its linter seem to get
tripped up randomly when references contain links to a heading which
contain literals enclosed in double-back-tics; especially in the cases
where a heading either contains multiple literals or when the literal is
not at the end of the heading. Not all of them can be "fixed" to pass both
building and linting.

(From yocto-docs rev: 3460177c46d360b0f2f852cdab23f21bd4ec6d5a)

Signed-off-by: Trevor Woerner <twoerner@gmail.com>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-05-26 13:02:49 +01:00
Trevor Woerner
fe721fe574 sphinx-lint: superfluous backtick in front of role
Fix all instances of backtick-before-role as reported by 'make sphinx-lint'.

(From yocto-docs rev: d38f9b25c0bd095fe1158f14226fb74f8645496a)

Signed-off-by: Trevor Woerner <twoerner@gmail.com>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-05-26 13:02:49 +01:00
Alper Ak
65ffae4706 ref-manual/variables.rst: document INHIBIT_UPDATERCD_BBCLASS
Fix [YOCTO #15753]

(From yocto-docs rev: 5f5a406d4acdfcbf655ac014d0d2807056f95291)

Signed-off-by: Alper Ak <alperyasinak1@gmail.com>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-05-26 13:02:49 +01:00
Etienne Cordonnier
1f49629be5 ref-manual/variables.rst: document SSTATE_SKIP_CREATION
(From yocto-docs rev: 3982720668aafa18c9ed27304d09f896740b1653)

Signed-off-by: Etienne Cordonnier <ecordonnier@snap.com>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-05-26 13:02:49 +01:00
Alper Ak
3d49affb49 ref-manual/variables.rst: document INHIBIT_DEFAULT_RUST_DEPS
Fix [YOCTO #15755]

(From yocto-docs rev: fd143a04bab38f6aeec23ec229657b16fcaecdf1)

Signed-off-by: Alper Ak <alperyasinak1@gmail.com>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-05-26 13:02:49 +01:00
Enrico Jörns
2358a2bae4 conf.py: tweak SearchEnglish to be hyphen-friendly
This modifies the default indexer split() and js splitQuery()
methods to support searching for words with hyphens.

While this might not be an ideal, rock solid, and fully future-proof
solution, it allows at least to search for strings inlcuding hyphens,
such as 'bitbake-layers', 'send-error-report', or 'oe-core'.

Below is a bit more detailed explanation of the two modifications done:

1) The default split regex in the sphinx-doc SearchLanguage base class
   is:

   | _word_re = re.compile(r'\w+')

   which we simply extend to include hyphens '-'.

   This will result in a searchindex.js that contains words with hyphens,
   too.

2) The 'searchtool.js' code notes for its splitQuery() implementation:

   | /**
   |  * Default splitQuery function. Can be overridden in ``sphinx.search`` with a
   |  * custom function per language.
   |  *
   |  * The regular expression works by splitting the string on consecutive characters
   |  * that are not Unicode letters, numbers, underscores, or emoji characters.
   |  * This is the same as ``\W+`` in Python, preserving the surrogate pair area.
   |  */
   | if (typeof splitQuery === "undefined") {
   |   var splitQuery = (query) => query
   |       .split(/[^\p{Letter}\p{Number}_\p{Emoji_Presentation}]+/gu)
   |       .filter(term => term)  // remove remaining empty strings
   | }

   The hook for this is documented in the sphinx-docs 'SearchLanguage'
   base class.

   |    .. attribute:: js_splitter_code
   |
   |       Return splitter function of JavaScript version.  The function should be
   |       named as ``splitQuery``.  And it should take a string and return list of
   |       strings.
   |
   |       .. versionadded:: 3.0

   We use this to define a simplified splitQuery() function with a split
   argument that splits on empty spaces only.

We extend SearchEnglish (which extends SearchLanguage) here to retain
the stemmer code and stopwords for English.

[YOCTO #14534]

(From yocto-docs rev: d4a98ee19e0cbd6be96923dc72faee143a6b294b)

Signed-off-by: Enrico Jörns <ejo@pengutronix.de>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-05-26 13:02:49 +01:00
Christos Gavros
d4d152d4c6 ref-manual/variables.rst: document the INITRAMFS_MAXSIZE variable
This variable specifies the maximum allowed size
of the initramfs image in Kbytes.
Fixes [YOCTO #15797]

CC: Yoann Congal <yoann.congal@smile.fr>
CC: Randy MacLeod <randy.macleod@windriver.com>
CC: Antonin Godard <antonin.godard@bootlin.com>
(From yocto-docs rev: 07bcdddaf71c76cdec186cf0ddd97a47eec54972)

Signed-off-by: Christos Gavros <gavrosc@yahoo.com>
Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-05-26 13:02:49 +01:00
Christos Gavros
50d1bec52d ref-manual/variables.rst: document the IMAGE_ROOTFS_MAXSIZE variable
This variable specifies the maximum allowed size
of the generated image in kilobytes.

CC: Yoann Congal <yoann.congal@smile.fr>
CC: Randy MacLeod <randy.macleod@windriver.com>
CC: Antonin Godard <antonin.godard@bootlin.com>
CC: Quentin Schulz <quentin.schulz@cherry.de>
(From yocto-docs rev: f3ddc92081363aa7ef7d4fc2c3b918f32f7bda05)

Signed-off-by: Christos Gavros <gavrosc@yahoo.com>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-05-26 13:02:49 +01:00
Alper Ak
fcb84b0baf ref-manual/variables.rst: document INHIBIT_AUTOTOOLS_DEPS
Fix [YOCTO #15756]

(From yocto-docs rev: 18a2686b530ae428103653450d8963d38dcdef46)

Signed-off-by: Alper Ak <alperyasinak1@gmail.com>
Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-05-26 13:02:49 +01:00
Quentin Schulz
f92147be29 set_versions.py: mark Styhead as EoL
Styhead is now EoL, let's remove it from the active releases.

(From yocto-docs rev: f2e3cf2637ce3ed3475faa472b134a29f019681b)

Signed-off-by: Quentin Schulz <quentin.schulz@cherry.de>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-05-19 15:54:10 +01:00
Trevor Woerner
ac4a58aa7d ref-manual/variables.rst: document WIC_CREATE_EXTRA_ARGS
Fixes [YOCTO #15509]

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

Signed-off-by: Trevor Woerner <twoerner@gmail.com>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-05-19 15:54:10 +01:00
Trevor Woerner
ec53c91af0 sphinx-lint: various fixes
A 'make sphinx-lint' pass found the following issues:
	trailing-whitespace
	missing-space-after-literal
	role-with-double-backticks
	missing-space-before-role (role missing opening tag colon)

(From yocto-docs rev: 6d4c67457e00a80dda4cd05bc5f05d8ebd8da5fc)

Signed-off-by: Trevor Woerner <twoerner@gmail.com>
Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-05-19 15:54:10 +01:00
Mikko Rapeli
dd3507f6d3 sbom.rst: how to disable SPDX generation
Generating SPDX is enabled by default in poky but
it can take a lot of build time resources so document
how to disable it.

(From yocto-docs rev: bcd58b7a9455fbb0ea5944089d663e327f0eb38f)

Signed-off-by: Mikko Rapeli <mikko.rapeli@linaro.org>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-05-19 15:54:10 +01:00
Trevor Woerner
e216e39c7e contributor-guide/submit-changes: encourage patch version changelogs
Add a section after the 'git format-patch' information encouraging developers
to add patch version changelogs to their patch updates.

(From yocto-docs rev: 2e3a37c4607b296956993e557d1786c4876e5722)

Signed-off-by: Trevor Woerner <twoerner@gmail.com>
Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-05-19 15:54:10 +01:00
Lee Chee Yang
e681870441 migration-guides: add release notes for 5.0.9
(From yocto-docs rev: 0d070439259d72f66a71c148f6c7926f6f233b6d)

Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-05-19 15:54:10 +01:00
Enrico Jörns
512d81b697 ref-manual/variables.rst: update ROOT_HOME documentation
* Since scarthgap [1], the default will be overridden when using
  'systemd' as INIT_MANAGER. Reflect this in the documentation.
* The distro configuration is probably the better place for
  customization, thus at least mention this together with the
  local.conf.
* While at it, drop the probably redundant description on how to
  override weak default variables.
  The example on how to set "/root" is still given indirectly, anyway.

[1] ebafe463 ("systemd: upgrade to 255.1")

(From yocto-docs rev: 50e92009d309fc4ae406174feb8f6578142748cc)

Signed-off-by: Enrico Jörns <ejo@pengutronix.de>
Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-05-19 15:54:10 +01:00
Adrian Freihofer
15f6f8d67e ref-manual: kernel-fitimage.bbclass does not use SPL_SIGN_KEYNAME
The kernel-fitimage.bbclass uses the UBOOT_* variables. The SPL_*
variables are handled by uboot-sign.bbclass.

(From yocto-docs rev: 8ceffee908a039deb1021361faa7637e83ef26f3)

Signed-off-by: Adrian Freihofer <adrian.freihofer@siemens.com>
Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-05-19 15:54:10 +01:00
Antonin Godard
04c9bc8653 migration-guides: add placeholders for 5.3
Add placeholder files to be populated for the next 5.3 release.
Relevant section names from the previous 5.2 release migration
guide/release note have been left with their content empty.

(From yocto-docs rev: 2822bf71ee7cd2fa48f2f802eaab236538112d85)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-05-19 15:54:10 +01:00
Lee Chee Yang
8d9ca8c874 migration-guides: add release notes for 4.0.26
(From yocto-docs rev: c883b519ea7163b2c69d749ff4912e89528964b4)

Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-05-19 15:54:10 +01:00
Antonin Godard
19ca5f8d88 ref-manual/release-process: update releases.svg
- Add the future "Whinlatter" (5.3) and "Wrynose" (6.0) releases.
- Make the "Walnascar" release a current release.
- Update the month in Current.

(From yocto-docs rev: 6d471e8483cc8d797eff7916120f91fab44487d1)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-05-19 15:54:10 +01:00
Leonard Anderweit
02b30d6952 ref-manual: classes: uki: Fix git links
Fix links to files in git by adding a leading / to the path.

(From yocto-docs rev: 270cd833f7d680c6def21376c7ece488479023ed)

Signed-off-by: Leonard Anderweit <l.anderweit@phytec.de>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-05-19 15:54:10 +01:00
Antonin Godard
9d3a157d37 test-manual/intro: remove Buildbot version used
The version has changed now (3.10.12 as of writing). Avoid having to
maintain this information by removing the version info from the intro.
Also fix a typo ("uses now uses") and give a link to yocto-autobuilder2.

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

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-05-19 15:54:10 +01:00
Lee Chee Yang
2859d5fb9d release-notes-5.2: update download section
also fix some typo.

(From yocto-docs rev: 81bb2b31c485717c0f3935844266f6610d860a6a)

Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-05-09 07:10:42 +01:00
Lee Chee Yang
d9c8689d69 docs: update walnascar-5.2 release
(From yocto-docs rev: 08dba6f1e0e978b1be8faa5c09ae266ac383f57d)

Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-05-09 07:10:42 +01:00
Michael Halstead
03e07bf5b3 docs: update current releases for Walnascar
(From yocto-docs rev: 3a9a2aebf64f3cf62096ca80be670862b13bead3)

Signed-off-by: Michael Halstead <mhalstead@linuxfoundation.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-05-09 07:10:42 +01:00
Antonin Godard
24a0e1794e migration-guides/release-notes-5.2.rst: add missing cves
Add missing fixed CVEs to the release note as reported here:
https://lore.kernel.org/r/5fc0d33e-4ba5-4f8d-80c2-c5c87be79680@gmail.com

Additions can be verified at the following links:
- https://gstreamer.freedesktop.org/security/
- https://www.openssh.com/txt/release-9.9p2
- http://www.dest-unreach.org/socat/

libssh2 CVE-2023-48795 was already fixed in previous releases so remove
it. See the previous migration guides.

Otherwise the CVE entries have been sorted.

Reported-by: Takayasu Ito <ypa.takayasu.ito@gmail.com>
(From yocto-docs rev: b8d9cf79d299b2e553e6bc962527d835206022ec)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-04-23 19:50:30 +01:00
Antonin Godard
3134b004db migration-guides/release-notes-5.2.rst: fix badly formatted gstreamer entries
Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>
(From yocto-docs rev: 22babeaa9ef4c0e6706c6de8f16fbd0e8d505818)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-04-23 19:50:30 +01:00
Antonin Godard
8adf8fb2a3 migration-guides/{migration,release-notes}-5.2.rst: notes for systemd pni-names
Add a note to the migration guide regarding the pni-names behavior
change.

Suggested-by: Enrico Jörns <ejo@pengutronix.de>
(From yocto-docs rev: 9a1b9778c296351a575501a4abc5317e9be954bc)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-04-23 19:50:30 +01:00
Antonin Godard
841965f127 Fix dead links that use the DISTRO macro
After introducing the DISTRO_LATEST_TAG and DISTRO_REL_LATEST_TAG
macros, use them in links that currently use DISTRO/DISTRO_REL_TAG. When
building for the tip of a branch, this will replace the current A.B.999
in links to the latest existing tag.

The links were found across the documentation by running 'grep -r
"http.*5\.2\.999"' inside the _build/html output after building the
docs.

[YOCTO #14802]

(From yocto-docs rev: 29be069ebbf2c55d72fc51d99ed5a558af37c05e)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-04-21 21:15:29 +01:00
Antonin Godard
76f887eb12 poky.yaml: introduce DISTRO_LATEST_TAG
Introduce the DISTRO_LATEST_TAG macro, which should always point to the
latest existing tag in the documentation, unlike DISTRO which may point
to A.B.999 to represent the tip of a branch.

This variable is needed to fix dead links in the documentation that
currently use the DISTRO macro.

Also, make DISTRO_REL_TAG use the DISTRO macro directly, to avoid
repetition, and add a DISTRO_REL_LATEST_TAG macro that has the same role
as DISTRO_LATEST_TAG but with "yocto-" prepended to it.

In set_versions.py, run the "git describe --abbrev=0 --tags
--match='yocto-*'" command to get the latest existing tag on the
currently checked out commit. Fallback to ourversion in case we didn't
find any.

(From yocto-docs rev: a85b0e500c94921f77fa7b7dbb877e4945f96d1e)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-04-21 21:15:29 +01:00
Andrew Kreimer
5224bce89d manuals: remove repeated word
The word "modern" appears twice, remove the extra one.

(From yocto-docs rev: 8a2169431551ea29bf45b2eb120a13f0e444e1ea)

Signed-off-by: Andrew Kreimer <algonell@gmail.com>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-04-21 21:15:29 +01:00
Antonin Godard
b5d978a00f migration-guides/{migration,release-note}-5.2: update for 5.2 release
Document changes between 1c3020f173 ("expat: Upgrade 2.7.0 -> 2.7.1")
up to e894acce6e ("build-appliance-image: Update to master head
revision") in Poky:

- Add a note on the devtool upgrade-status change.
- Be more precise about the usage of multiple repositories in SRC_URI,
  mention that it makes sense for bare clones only.

As the walnascar branch has now frozen and is up for QA, these should be
the one of the last changes to these documents.

(From yocto-docs rev: 322355ead2be9e267368ca47d805f41ae10ad6cc)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-04-21 21:15:29 +01:00
Antonin Godard
5ab6686526 ref-manual/variables.rst: improve the PKGV documentation
It may be confusing for users that source control information is not
present in the BitBake environment. Document it as a warning block.

(From yocto-docs rev: 39967b9cc87cf216c4658598806fd7a68db5053a)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-04-21 21:15:29 +01:00
Lee Chee Yang
9e418c4265 migration-guides: add release notes for 5.0.8
(From yocto-docs rev: 3b50193fa0c9acf4a601aeae6e1c78d0e4a05aef)

Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit 7494df521ed9c70e877dbdef1adfe38ad717682f)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-04-03 16:28:34 +01:00
Lee Chee Yang
f9e9aec4f1 migration-guides: add release notes for 5.1.4
(From yocto-docs rev: 4602e6b42118e7fbd3b6aa07782779047d209bb0)

Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit f7c8fdfdfef0cac529594af5bdb72e53b29262fe)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-04-03 16:28:34 +01:00
Antonin Godard
e16f429d25 ref-manual/variables.rst: HOST_CC_ARCH: fix wrong SDK reference
When building for nativesdk recipes, HOST_CC_ARCH equals SDK_CC_ARCH,
not BUILDSDK_CC_ARCH which doesn't exist.

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

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit 08fc3446cb13b5bd8781874d2d996899ce12b082)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-04-03 16:28:34 +01:00
Antonin Godard
c9dc701342 ref-manual/variables.rst: document HOST_*_ARCH variables
These variables control the flags for the assembler, compiler and
linker, but depend on the context.

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

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit f8eb33569a5e8cadc036855e2d95eee77e627cb4)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-04-03 16:28:34 +01:00
Antonin Godard
a9f85a1894 ref-manual/variables.rst: document missing SDK_*_ARCH variables
These variables control the flags for the assembler, compiler and linker
when building for nativesdk recipes.

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

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit c08f6d3c8aee86264c069b7c30850cb02de76076)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-04-03 16:28:34 +01:00
Antonin Godard
91a76d2109 ref-manual/variables.rst: add missing documentation for BUILD_* variables
These toolchain variables are used in a native context. Some of the
BUILD_* variables missed documentation. Also, some of the base commands
were also not there so document them.

Some of existing BUILD_* variable documentation were missing the note
about their usage in a native context, so add it too so that all BUILD_*
variables are documented the same way.

[YOCTO #15719]

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

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit 87103afa1cb6690e9aaa87ca1f23e45eaaa359ac)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-04-03 16:28:34 +01:00
Antonin Godard
5ccea18374 ref-manual/variables.rst: add manpage links for toolchain variables
Use the :manpage: role to provide links to common toolchain utilities.

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

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit 7023e5f176efde05a6798476712c8a4e006a6b0d)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-04-03 16:28:34 +01:00
Antonin Godard
5f74fee3b8 documentation/conf.py: define a manpage url
By defining the manpages_url we can use the :manpage: role in the
documentation for providing links to manpages. See:
https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-manpages_url

Replace existing manpages links to use this role.

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

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit 4e63cd74cd1a330ea5e96bb04243a90f607b2857)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-04-03 16:28:34 +01:00
Antonin Godard
f5e4278fad migration-guides/{migration,release-note}-5.2: improvements and fixes
Address some of the reviews received on the release notes and migration
guide for 5.2:

- Remove the wget fetcher addition, I misread commit 0a9f90ff658e
  ("tests/fetch: support setting PV in the wget fetcher") from BitBake,
  and it actually affects the tests for the wget fetcher, not the
  fetcher itself.
- Add a way to transition from the branch=nameX,nameY syntax. From what
  I have tested, I achieve the same behavior when using one or the other
  syntax.
- Remove the default value for SPDX_PACKAGE_VERSION in the release note.
- Fix a couple of typos.

Suggested-by: Quentin Schulz <quentin.schulz@cherry.de>
(From yocto-docs rev: 39bf43a6009a46d4979337d7401eb46ece618f67)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-04-03 16:28:34 +01:00
Antonin Godard
80807dd044 ref-manual/classes: ptest-python-pytest: improve the current documentation
Improve the current ptest-python-pytest documentation and
PTEST_PYTEST_DIR variable definition. Namely remove the default value
that may evolve over time.

Suggested-by: Quentin Schulz <quentin.schulz@cherry.de>
(From yocto-docs rev: a83406103ca73d84fc8f5c50a8968faf91276a62)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-04-03 16:28:33 +01:00
Yoann Congal
9a9029e0af poky.yaml.in: Raise minimum GCC version to 10.1
Since OE-Core commit 19004950ad56 ("sanity: Check if the C++ toolchain supports --std=gnu++20"),
host GCC must support "--std=gnu++20" for a Yocto build.
This option is available from 10.1.

This is related to [YOCTO #15804].

(From yocto-docs rev: 0e538c102bfcb7184c76c2401e8cb878168c4434)

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>
2025-03-28 15:00:10 +00:00
Antonin Godard
0fffea46ec migration-guides/{migration,release-note}-5.2: update for 5.2 release
Document changes between 0e91a1dabf ("adwaita-icon-theme: upgrade 47.0
-> 48.0") up to b3c21a23ad ("migration-guides/release-notes-5.2:
update for upcoming 5.2 release") in Poky.

(From yocto-docs rev: e61630ba2e4e865b57e920171a62824a4eba6533)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-03-28 13:17:13 +00:00
Antonin Godard
4562a9b2f3 ref-manual/variables.rst: document the SPDX_PACKAGE_VERSION variable
This variable controls the package version as seen in the SPDX 3.0 JSON
output (software_packageVersion). The default value for this variable is
PV.

(From yocto-docs rev: 3b483c5295b26748c6f2cd63074b20ac3da97b32)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-03-28 13:17:13 +00:00
Antonin Godard
b8c7882472 ref-manual/variables.rst: document the GRUB_MKIMAGE_OPTS variable
This new Grub variable controls the options passed to the grub-mkimage
command in the Grub recipe.

(From yocto-docs rev: 2e5a3c3d5199cad6fb90e0218cdd4a1779743644)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-03-28 13:17:13 +00:00
Antonin Godard
a9002c2d03 poky.yaml.in: bump minimum required Python version to 3.9
After commit 67566c7410 ("bitbake: lib/bb: Bump minimum python version
requirement to 3.9") on Poky.

(From yocto-docs rev: 25b5184fe231591b6eb4d6a38563c1370dabebac)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-03-28 13:17:13 +00:00
Antonin Godard
2c2d3bd92c ref-manual/system-requirements.rst: update list of supported distributions
Before the 5.2 release, update the list of supported distributions to
match the SANITY_TESTED_DISTROS variable in poky.conf.

(From yocto-docs rev: 9dac392c0d834c0089c514d7ad85beeb04d1b698)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-03-28 13:17:13 +00:00
Paul Gortmaker
0570d98f1b requirements: move Ubuntu-20.04 into unsupported category due to python
Bitbake commit 0d2e682d00df ("bitbake: lib/bb: Bump minimum python
version requirement to 3.9" -- poky commit 67566c7410) means that
Ubuntu 20.04 is no longer supported out-of-the-box as detailed further
in the respective commit log.

While it is true that it can still be used with buildtools, that can
also be said for nearly every other unsupported distro out there,
including Ubuntu 18.04 that we listed as unsupported some years ago.
Hence continuing to list it as supported with the new python requirement
in place does not make sense.

So we move it alongside of the 18.04 entry, into the "possibly tested,
but you get what you get" category.  And add an explicit mention of the
buildtools, so people have a thread to pull on.

(From yocto-docs rev: b1c09003dc304b1e65044f343fb341aaed58e6f3)

Signed-off-by: Paul Gortmaker <paulg@kernel.org>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-03-28 13:17:13 +00:00
Antonin Godard
9b8f4cf9a9 migration-guides/migration-5.2.rst: final update for 5.2
- Add new/removed supported distributions.
- Set the oldest supported kernel.
- Remove empty sections.

(From yocto-docs rev: c1f2b4e352f636594769f55f15fa69d99d69505a)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-03-28 13:17:13 +00:00
Antonin Godard
be14e8aa49 migration-guides/release-notes-5.2.rst: add an entry for addfragments
This should be clearly mentioned in the BitBake section as it is an
valuable addition to 5.2.

(From yocto-docs rev: 62e0fd7ec9581918935b44427326ae74991bd72a)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-03-28 13:17:13 +00:00
Antonin Godard
e02cf372bf migration-guides/release-notes-5.2.rst: add security fixes
Add security fixes by going through the log between yocto-5.1 and
walnascar branch tip on Poky.

(From yocto-docs rev: 3c895f4188b8c7aaa87198a8bf85776f545ee6a9)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-03-28 13:17:13 +00:00
Antonin Godard
cfaca2fb59 migration-guides/release-notes-5.2.rst: add LICENSE recipe changes
Document LICENSE changes between the 5.1 and 5.2 release.
Extracted for commits message containing the "License-Update:" field in
Poky, between tag yocto-5.1 and walnascar.

(From yocto-docs rev: 725135799c4d3ba117376df230be4a1603779121)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-03-28 13:17:13 +00:00
Antonin Godard
b015ce6a59 migration-guides/release-notes-5.2.rst: add recipe upgrades
Extracted from layers.openembedded.org branch comparison tool.

(From yocto-docs rev: 69f084adc7ef4224346ec466e9ccd1255fb738bf)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-03-28 13:17:13 +00:00
Antonin Godard
c3862047cf migration-guides/release-notes-5.2.rst: add the list of contributors
Obtained by running:

  git log --format=%an yocto-5.1..walnascar | sort | uniq

On the Poky repository.

(From yocto-docs rev: 8c32f84e75ba4fce9428df7ce68cc2193f26cff7)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-03-28 13:17:13 +00:00
Antonin Godard
b3c21a23ad migration-guides/release-notes-5.2: update for upcoming 5.2 release
Changes since 87d7341465 ("python3-iniparse: remove recipe") up to
9cd6b3ad8b ("cronie: Resolve build failure with GCC15") in Poky.

(From yocto-docs rev: ea1636013722c12e72ca115240c8ce533e05ece2)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-03-27 15:25:05 +00:00
Antonin Godard
4130f9a595 migration-guides/migration-5.2: update for upcoming 5.2 release
Changes since 87d7341465 ("python3-iniparse: remove recipe") up to
9cd6b3ad8b ("cronie: Resolve build failure with GCC15") in Poky.

(From yocto-docs rev: c20001db2544c7d1c3cd9a34f629f452a2f3029d)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-03-27 15:25:05 +00:00
Antonin Godard
bec55f3182 ref-manual/variables.rst: add a link for BB_USE_HOME_NPMRC
Documented in the BitBake manual.

(From yocto-docs rev: f58b8c80b7665ab5e67398a4ce4bfaa035114278)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-03-27 15:25:05 +00:00
Antonin Godard
e7999d5413 migration-guides/migration-5.2.rst: add information about autotools changes
Original patch by Ross Burton:
https://lists.yoctoproject.org/g/docs/message/6466

Moved to the migration manual as it is potentially a breaking change.

Co-developed-by: Ross Burton <ross.burton@arm.com>
(From yocto-docs rev: 9b795ad8fdeadf17f08e03eedc93bc922a2d5736)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-03-27 15:25:05 +00:00
Antonin Godard
1bc6298738 ref-manual/variables.rst: document autotools class related variables
Document the AUTOTOOLS_SCRIPT_PATH and the CONFIGURE_SCRIPT variables.

(From yocto-docs rev: b3964a89fd6a5f19a8f45f9b46e8eaa8b8bff38e)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-03-27 15:25:05 +00:00
Antonin Godard
801c23ba69 ref-manual/variables.rst: document the NVD_DB_VERSION variable
This variable allows choosing the CVE feed when using the cve-check
class.

(From yocto-docs rev: 639ea86c5034d7706faf14a2ff52b603c3ccd905)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-03-27 15:25:05 +00:00
Antonin Godard
879371ca7c ref-manual/variables.rst: document the MESON_INSTALL_TAGS
This variable can be used to add install tags to the 'meson install'
command.

(From yocto-docs rev: 72b502cfb67345cda17bc2ae7af222b7cecb9a0c)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-03-27 15:25:05 +00:00
Antonin Godard
bfa657b639 ref-manual/features.rst: drop ld-is-gold
Dropped in OE-Core after commit a4addb9ab630 ("recipes: Drop ld-is-gold
support").

(From yocto-docs rev: 95645cb765b20c3215defe165e7d886da98c1787)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-03-27 15:25:05 +00:00
Antonin Godard
235756f049 ref-manual/variables.rst: document the MOUNT_GROUP variable
(From yocto-docs rev: 959735468264bac1bdd7b274fc1477635817c208)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-03-27 15:25:05 +00:00
Antonin Godard
1379494769 ref-manual/variables.rst: document the WATCHDOG_RUNTIME_SEC variable
This variable controls the RuntimeWatchdogSec option in
/etc/systemd/system.conf.

(From yocto-docs rev: 6d6b638ee94c3ba36a02ef2289bf246392d8c854)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-03-27 15:25:05 +00:00
Antonin Godard
bd156d28fe ref-manual/variables.rst: WATCHDOG_TIMEOUT: fix recipe name
This variable affects the watchdog-config recipe, not the watchdog
recipe.

(From yocto-docs rev: d3350c38910c47c76ed17f24579120013589ca1f)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-03-27 15:25:05 +00:00
Antonin Godard
7e822e13de ref-manual/classes.rst: document the ptest-python-pytest class and variables
Add documentation for the ptest-python-pytest class, and the
PTEST_PYTEST_DIR variable which can be overriden.

(From yocto-docs rev: 1abee62c2b9f32dfa42782893940f211db930b4c)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-03-27 15:25:05 +00:00
Jamin Lin
3bc048c01a ref-manual: uboot-sign: Add how to enable ATF, TEE and User defined snippet ITS for U-Boot FIT image
Add how to enable ATF, TEE and User defined ITS for U-Boot FIT image generation.

(From yocto-docs rev: ee6b3698da044e290dbc4fbb852f3cc37638e689)

Signed-off-by: Jamin Lin <jamin_lin@aspeedtech.com>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-03-24 17:32:34 +00:00
Antonin Godard
869c4f3adb migration-guides/release-notes-5.2: add known issue on stalled NVD
Add an entry to the known issue as the NVD is not up-to-date, the
impact on current CVE reports and future plans for the Yocto Project.

Follows the discussion on:
https://lists.openembedded.org/g/openembedded-core/message/212446

(From yocto-docs rev: c83aa6649fb7bca7e6b393356c8268aa4f18dc4b)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-03-24 17:32:34 +00:00
Adrian Freihofer
7f3dbf4f84 ref-manual: variable FIT_SIGN_INDIVIDUAL mix-and-match attacks
Incorporate the lessons learned from a regression introduced with commit
  OE-Core rev: 259bfa86f384206f0d0a96a5b84887186c5f689e
               u-boot: kernel-fitimage: Fix dependency loop if
               UBOOT_SIGN_ENABLE and UBOOT_ENV enabled
and fixed with commit
  OE-Core rev: 0106e5efab99c8016836a2ab71e2327ce58a9a9d
               u-boot: kernel-fitimage: Restore FIT_SIGN_INDIVIDUAL="1"
               behavior
into the documentation.

The use of the variable FIT_SIGN_INDIVIDUAL is explicitly discouraged.

(From yocto-docs rev: d34e1d4e3f229bcd6560fe7df544869b0cd9875f)

Signed-off-by: Adrian Freihofer <adrian.freihofer@siemens.com>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-03-24 17:32:34 +00:00
Antonin Godard
61a7192719 overview-manual/concepts: add UNPACKDIR in the directory description
Mention that UNPACKDIR is used as a location to unpack the source code,
and that S is the final location of the source code. This is
deliberately vague, because as there are multiple instances of how these
directories can be defined and used.

The proper explanation of how the UNPACKDIR and S directories interact
is left to the reference manual, under the UNPACKDIR variable
description.

(From yocto-docs rev: 76361ae37bd45c9ce5190fb6c7c400bf2fc14003)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-03-24 17:32:34 +00:00
Antonin Godard
2d843491f3 overview-manual/concepts: remove PR from the build dir list
PR was removed by cc83e4548465 ("bitbake.conf: Drop PE and PR from
WORKDIR and STAMP") on OE-Core.

(From yocto-docs rev: 569c707c69a7a858553e40b26cb36db18f2a42fc)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-03-24 17:32:34 +00:00
Antonin Godard
bfcd4d10a6 overview-manual: convert analysis-for-package-splitting.png to svg
- Convert the png file to an SVG file
- Add the UNPACKDIR reference.
- Remove ${PR} from WORKDIR value, after cc83e4548465 ("bitbake.conf:
  Drop PE and PR from WORKDIR and STAMP") on OE-Core.
- Change S value to BP (equal to ${BPN}-${PV}, but more accurate).

(From yocto-docs rev: 6fd6af3ea9e556e481cc3c0358c0357b6060798f)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-03-24 17:32:34 +00:00
Antonin Godard
2cd05764b7 overview-manual: convert configuration-compile-autoreconf.png to svg
- Convert the png file to an SVG file
- Add the UNPACKDIR reference.
- Remove ${PR} from WORKDIR value, after cc83e4548465 ("bitbake.conf:
  Drop PE and PR from WORKDIR and STAMP") on OE-Core.
- Change S value to BP (equal to ${BPN}-${PV}, but more accurate).

(From yocto-docs rev: f24b00200ac49cda07e4c77e3e1b161a5b78b006)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-03-24 17:32:34 +00:00
Antonin Godard
4fefecd271 overview-manual: convert patching.png to svg
- Convert the png file to an SVG file.
- Add the new UNPACKDIR directory to the image.
- Remove ${PR} from WORKDIR value, after cc83e4548465 ("bitbake.conf:
  Drop PE and PR from WORKDIR and STAMP") on OE-Core.
- Change S value to BP (equal to ${BPN}-${PV}, but more accurate).-

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

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-03-24 17:32:34 +00:00
Antonin Godard
2483391bef overview-manual: convert source-fetching.png to svg and fix UNPACKDIR
- Convert the png file to an SVG file.
- Add the new UNPACKDIR directory to the image.
- Remove ${PR} from WORKDIR value, after cc83e4548465 ("bitbake.conf:
  Drop PE and PR from WORKDIR and STAMP") on OE-Core.
- Change S value to BP (equal to ${BPN}-${PV}, but more accurate).-

This fixes [YOCTO #15730].

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

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-03-24 17:32:34 +00:00
Ross Burton
f1021dafb7 dev-manual: remove qemu machine name list in runqemu invocation
This list of "valid" qemu machine names is obsolete and incorrect, so
just remove it as it serves no real purpose.

(From yocto-docs rev: ee8839480fe574598b4d52a8fd6c11bb301ad3d9)

Signed-off-by: Ross Burton <ross.burton@arm.com>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-03-24 17:32:34 +00:00
Adrian Freihofer
87cccf1bb8 migration-guides: cover FIT_UBOOT_ENV
Add a hint for users using the UBOOT_ENV variable and the
kernel-fitimage.bbclass.

(From yocto-docs rev: 4d04531d4015bb61e68dfbed87d743772b6178b7)

Signed-off-by: Adrian Freihofer <adrian.freihofer@siemens.com>
Reviewed-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-03-24 17:32:34 +00:00
Lee Chee Yang
e9514130c7 migration-guides: add release notes for 5.1.3
(From yocto-docs rev: e608902ffae3af5ab0c5308b0550e49a790482f0)

Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-03-07 17:04:26 +00:00
Antonin Godard
c154a5ac7d ref-manual/variables: document KMETA* and KCONF_AUDIT* variables
Document the variables used to control the outcome of the kernel
configuration auditing done by the kernel-yocto bbclass.

[YOCTO #13835]

Acked-by: Bruce Ashfield <bruce.ashfield@gmail.com>
(From yocto-docs rev: f75a1c1a1447ed52dc6561c67e6afb5fd1413f28)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-03-07 17:04:26 +00:00
Ross Burton
7f91376d2e ref-manual: remove OE_IMPORTS
oe-core no longer supports OE_IMPORTS[1], so remove the documentation.

[1] oe-core 1f56155e ("base: Switch to use addpylib directive and
    BB_GLOBAL_PYMODULES")

(From yocto-docs rev: d03dad11974ada7a99b4406e2350b9f5f0acc746)

Signed-off-by: Ross Burton <ross.burton@arm.com>
Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-03-07 17:04:26 +00:00
Ross Burton
dcaaf3ed57 ref-manual: don't refer to poky-lsb
This was removed in 2019, so swap it for poky-altcfg.

(From yocto-docs rev: 7f7f6570befdda280c174a5f9776b20f53f3ea0d)

Signed-off-by: Ross Burton <ross.burton@arm.com>
Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-03-07 17:04:26 +00:00
Ross Burton
63c8e8e530 Remove all mention of core-image-lsb
core-image-lsb was removed in 2019[1], so remove all of the  incredibly
obsolete references in the documentation.

[1] oe-core fb064356af615d67d85b65942103bf943d84d290

(From yocto-docs rev: 062445a49919eff117b5478c1fb18d125c1f895c)

Signed-off-by: Ross Burton <ross.burton@arm.com>
Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-03-07 17:04:26 +00:00
Adrian Freihofer
657b458332 ref-manual: cover UBOOT_ENV variables
(From yocto-docs rev: dc2ff96a3401eba8dac86fc8305b261be52c8a13)

Signed-off-by: Adrian Freihofer <adrian.freihofer@siemens.com>
Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-03-07 17:04:26 +00:00
Lee Chee Yang
1145d16d08 migration-guides: add release notes for 4.0.25
(From yocto-docs rev: 4649514cdfae496f43711d6b830a0a835c3a1534)

Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-03-07 17:04:26 +00:00
Antonin Godard
dcfbb14ad3 dev-manual/multiconfig: add suggested best practices and baremetal sections
After the suggestions from Mark Hatle on the list
(https://lists.yoctoproject.org/g/docs/topic/110487932), add two
sections to the multiconfig doc:

- Suggested best practices: suggestion for better design of multiconfig
  builds.

- Common use case: baremetal build.

  This section applies the guidelines from the first sections and apply
  it to a real-life example of how to use multiconfig. This one to build
  some baremetal firmware alongside a regular Linux build.

Suggested-by: Mark Hatle <mark.hatle@kernel.crashing.org>
Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>
(From yocto-docs rev: 36fb1e9e5099aa0d858d5478530143e9bac39588)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-02-26 14:49:28 +00:00
Antonin Godard
705966c546 dev-manual/multiconfig: improve the current doc
After the suggestions from Mark Hatle on the list
(https://lists.yoctoproject.org/g/docs/topic/110487932), rewrite the
introduction to multiconfig with the following changes:

- Move the part of overriding TMPDIR or not to a note.
- Use BB_CURRENT_MC in the example.
- Various additions of references & improved formatting.

Suggested-by: Mark Hatle <mark.hatle@kernel.crashing.org>
Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>
(From yocto-docs rev: 8cedef6d5b701235325e6e0bdd793f8c06dfef57)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-02-26 14:49:28 +00:00
Antonin Godard
8368cac811 dev-manual/multiconfig: rename to use Multiconfig term
Rename this section to explicitely name the multiple configuration feature
"multiconfig".

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

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-02-26 14:49:27 +00:00
Antonin Godard
e87504429a migration-5.2: fix references to BB_CURRENT_MC
Now part of the documentation.

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

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-02-26 14:49:27 +00:00
Antonin Godard
a3669b55f1 variables.rst: add a reference to BB_CURRENT_MC from bbdocs
BB_CURRENT_MC is documented in the Bitbake user manual. Add a reference
to it here.

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

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-02-26 14:49:27 +00:00
Antonin Godard
6a31bdb4dd dev-manual: move multiconfig documentation to its own document
In preparation of more section and examples to multiconfig, move the
section about it in building.rst into its own document.

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

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-02-26 14:49:27 +00:00
Marta Rybczynska
8bb220aa11 vulnerabilities/classes: remove references to cve-check text format
The text format has been removed, so also remove references and examples
using this format. Replace with examples with the JSON format.

(From yocto-docs rev: a52cd7bcadccc53e982f90d6e170d00798322597)

Signed-off-by: Marta Rybczynska <marta.rybczynska@ygreky.com>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-02-26 14:49:27 +00:00
Weisser, Pascal
b3347ef726 ref-manual: Add missing variable IMAGE_ROOTFS_MAXSIZE
This patch adds the missing documentation of variable IMAGE_ROOTFS_MAXSIZE
to the reference manual.

(From yocto-docs rev: 1dcc8cf7c49da449b324a7bd6bb22effe1d53d70)

Signed-off-by:
Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-02-26 14:49:27 +00:00
Yoann Congal
a7a55e856b release-notes-5.2: Add new variable OEQA_REPRODUCIBLE_TEST_LEAF_TARGETS
Add mention of OEQA_REPRODUCIBLE_TEST_LEAF_TARGETS to release-notes-5.2
to users can use it after upgrading.

(From yocto-docs rev: eec44e4daf414be414e9fd0471b0381b980d6fab)

Signed-off-by: Yoann Congal <yoann.congal@smile.fr>
Reviewed-by: Guillaume Swaenepoel <guillaume.swaenepoel@smile.fr>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-02-26 14:49:27 +00:00
Yoann Congal
9c90dadbd0 reproducible-builds: add a "How to" section with OEQA* variables
Shows an example of the new variable OEQA_REPRODUCIBLE_TEST_LEAF_TARGETS
and still mention OEQA_REPRODUCIBLE_TEST_TARGET/SSTATE_TARGETS that were
shown earlier.

(From yocto-docs rev: 78cf8b1ff1cdfbc863033f267da8fb60419b50fc)

Signed-off-by: Yoann Congal <yoann.congal@smile.fr>
Reviewed-by: Guillaume Swaenepoel <guillaume.swaenepoel@smile.fr>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-02-26 14:49:27 +00:00
Yoann Congal
18556f78bd reproducible-builds: change/add titles in the "How" section
This is preparation work for the following commit.

(From yocto-docs rev: 0ff459c273704a281419a44ae5670068ac47f1b9)

Signed-off-by: Yoann Congal <yoann.congal@smile.fr>
Reviewed-by: Guillaume Swaenepoel <guillaume.swaenepoel@smile.fr>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-02-26 14:49:27 +00:00