Commit Graph

31 Commits

Author SHA1 Message Date
Antonin Godard
5c4cf4b573 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:17:02 +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
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
Quentin Schulz
9d7930a4e0 docs: use literalinclude for system requirements
The YAML variables for the host dependencies are updated by hand and
actually only used inside code blocks.

Let's migrate all instructions into separate shell scripts that are then
literalinclude'd into the Sphinx documentation.

This allows a few things:
- ability to run shellcheck on the scripts if we ever want to
- manually calling the appropriate script from a supported distro to
  build stuff (distro or bitbake/yocto stuff)
- use this script to create containers to do CI of documentation on
  different distros, to make sure our instructions are all up to date,

(From yocto-docs rev: 8d993022c2aefc0fde9baa949d39d7a3613f9f46)

Signed-off-by: Quentin Schulz <quentin.schulz@cherry.de>
Reviewed-by: Antonin Godard <antonin.godard@bootlin.com>
Tested-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-02-18 15:47:37 +00:00
Antonin Godard
43647390ad Update autobuilder URLs to valkyrie
We have moved to Valkyrie which is hosted on
https://autobuilder.yoctoproject.org/valkyrie. Update the URL in the
documentation.

Also, the YOCTO_AB_URL macro was used in a single location in the
documentation so replace it by the :yocto_ab: custom extlink and remove
the macro.

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

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2025-01-20 13:45:06 +00:00
Antonin Godard
783347d27b system-requirements.rst: add dependencies for pdf builds
With the recent changes from commit
bd6265ca323fac547a197bb516dc4a9ef3897508 ("doc: Makefile: add support
for xelatex"), the list of dependencies needs to be updated.

The initial list of dependencies was made for Ubuntu/Debian, and the
packages were translated for the other distros using pkgs.org.

Add them separately from the rest of the dependencies as they pull a
_lot_ of additional dependencies (for LaTeX).

Move the texlive-fncychap documentation dependency to the PDF specific
dependency.

Notes:
- Fedora/OpenSUSE do not have the "lang-all" texlive collection, so
  install all available languages.
- AlmaLinux does not seem to provide texlive-collection-fontsextra,
  texlive-collection-lang*, and texlive-collection-latexextra, so add a
  warning about that.

(From yocto-docs rev: 02c090718ac602f7d4760dd28dadbf0631668d49)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2024-12-16 11:04:53 +00:00
Antonin Godard
36cc210fb9 poky.yaml.in: replace inkscape dependency by librsvg2-bin
inkscape used to be a requirement to convert SVG images to PNGs/PDFs,
but we replaced it recently by rsvg-convert.

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

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2024-12-16 11:04:53 +00:00
Antonin Godard
3aadcdf74c poky.yaml.in: add missing locales dependency
This is a requirement for building the documentation, otherwise we get
(on Ubuntu 24.04):

     File "/usr/lib/python3.12/locale.py", line 615, in setlocale
       return _setlocale(category, locale)
              ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
   locale.Error: unsupported locale setting

(From yocto-docs rev: 0943a7b67ef0012b5d9badc15e0c579dbb9014ae)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2024-12-16 11:04:53 +00:00
Antonin Godard
9c8a31142b Gather dependencies in poky.yaml.in
We used to have packages here and there in system-requirements.rst for
each distro. Instead, gather all the dependencies in poky.yaml.in so we
have an overview of what we provide for each distro.

Use yaml ">" to list the dependencies in alphabetical order, one entry
per line, which makes them easier to read and compare among distros.

Rename UBUNTU_… variables to UBUNTU_DEBIAN_…, since these are used for
both distros.

(From yocto-docs rev: 1ed6118b7cf1b5dcbfca753c83fa30fb97bf44ad)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2024-12-16 11:04:53 +00:00
Guénaël Muller
1c9140b0d4 ref-manual: use standardized method accross both ubuntu and debian for locale install
Modify locale installation method to be standard accross all debian-based distributions.
Pre-existing method is available only on Ubuntu, locale-gen tool has no parameter in Debian.

(From yocto-docs rev: 30002019198a168e48537407bb928facb26af82a)

Signed-off-by: Guénaël Muller <guenael.muller@smile.fr>
Reviewed-by: Yoann Congal <yoann.congal@smile.fr>
Reviewed-by: Antonin Godard <antonin.godard@bootlin.com>
Tested-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>
2024-12-16 11:04:53 +00:00
Antonin Godard
11b1577a15 docs: update current releases
Remove dunfell and nanbield which are not supported anymore.
Add styhead as an active release.
Set walnascar as the dev branch.

The switcher menu now contains:
- Unstable (dev)
- Styhead (5.1)
- Scarthgap (5.0.4)
- Kirkstone (4.0.22)

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

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2024-10-31 14:24:24 +00:00
Alexander Kanavin
fd1ea6a600 documentation/poky.yaml.in: drop mesa/sdl from essential host packages
They used to be required for qemu graphics support, but neither is being
for anything anymore.

(From yocto-docs rev: 96e96382cecb4928f49d37bf870335fa6aeb4dd1)

Signed-off-by: Alexander Kanavin <alex@linutronix.de>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2024-05-09 11:57:14 +01:00
Michael Halstead
e172625639 docs: add support for scarthgap 5.0 release
Prepared for Scarthgap release. Add references to Styhead.

(From yocto-docs rev: 906d228f1cedc25dd7530db3ce509239152da89f)

Signed-off-by: Michael Halstead <mhalstead@linuxfoundation.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2024-05-01 23:00:34 +01:00
Michael Halstead
abf3e54d11 docs: add support for nanbield (4.3) release
This adds support for the Nanbield (4.3) release and update the
current dev branch to Scarthgap.

(From yocto-docs rev: cfbb2cda2c3d221f944ae610c05039c9d12093bc)

Signed-off-by: Michael Halstead <mhalstead@linuxfoundation.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-11-13 17:29:26 +00:00
Joshua Watt
05d0677c5a Add libacl to required packages
libacl is required for correctly calculating output hashes, so add it to
the require host packages

(From yocto-docs rev: 5a054fdb6fb074c5172245f704705a4a987d141c)

Signed-off-by: Joshua Watt <JPEWhacker@gmail.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-09-09 12:01:09 +01:00
Michael Halstead
d9a7f94724 docs: add support for mickledore (4.2) release
This adds support for the Mickledore (4.2) release and update the
current dev branch to Nanbield.

(From yocto-docs rev: 5321befbfdc014d469b298bdd5b31d684231b2cb)

Signed-off-by: Michael Halstead <mhalstead@linuxfoundation.org>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-05-04 13:53:06 +01:00
Ross Burton
bcf8ac1ff5 Increase minimum GCC version to 8.0
We've increased the minimum GCC version to 8.0[1] so update the
documentation to match.

[1] sanity.bbclass: Update minimum gcc version to 8.0

(From yocto-docs rev: c74254fa7406c76b26e47b968685115699f95c55)

Signed-off-by: Ross Burton <ross.burton@arm.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-04-04 17:46:27 +01:00
Michael Opdenacker
88b440af71 manuals: add minimum RAM requirements
Measured by generating a "core-image-sato" image for a "qemux86-64"
machine from an Ubuntu 22.04 VM with 4 cores.

Less memory was not enough and caused Out of Memory failures.

(From yocto-docs rev: a05f87929eed43cef673a8c2581899a8c9ccf462)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-04-03 14:48:47 +01:00
Michael Opdenacker
71b964b0dc manuals: add rm_work disk space data
(From yocto-docs rev: 8121a02cde6b0149aef441926c5b8e89cb9854df)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-04-03 14:48:47 +01:00
Michael Opdenacker
c8b7c5ab1e manuals: update disk space requirements
Tests made on Poky master on March 16, 2023.

Add a "Free Disk Space" section to the "System Requirements" document.

(From yocto-docs rev: 285ba689ce3ab7b7fdb4bb0d0284e2a52ad62c7f)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-04-03 14:48:47 +01:00
Michael Opdenacker
ee1a0825b7 ref-manual: system-requirements.rst: simplify supported distro requirements
- This allows to continue sharing the updated Ubuntu/Debian requirements
  with the brief-yoctoprojectqs/index.rst without indentation mismatches
  (caused by using the same macro in two different contexts: in direct
  text and in a bullet list).

- Update poky.yaml.in to adapt the number of spaces at the beginning
  of lines.

- brief-yoctoprojectqs/index.rst: fix bad number of spaces
  before quote block.

(From yocto-docs rev: 38a3228f8981674bc75de135246c4f9eff7b43a1)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-03-20 13:16:52 +00:00
Michael Opdenacker
443a9f2658 poky.yaml.in, system-requirements.rst: update system requirements
- Update system requirements after making tests on basic Docker
  containers of:
  - Ubuntu 22.04
  - Fedora 37
  - OpenSuse Leap 15.4
  - AlmaLinux 9

- Including the need to have the en_US.UTF-8 locale on the system.

- Rename the CENTOS8_HOST_PACKAGES_ESSENTIAL macro to ALMALINUX_HOST_PACKAGES_ESSENTIAL
  As for the other distros, stop refering to a specific version of AlmaLinux. We mention
  the supported versions in the system-requirements.rst file anyway.

- Remove the unused CENTOS7_HOST_PACKAGES_ESSENTIAL macro

(From yocto-docs rev: f8b8680ff1f54b02572f240966169b9e129b05b1)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reported-by: Randy MacLeod <randy.macleod@windriver.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2023-03-20 13:16:52 +00:00
Michael Opdenacker
4849da20ff documentation/poky.yaml.in: update minimum python version to 3.8
Now required by Bitbake:
https://git.openembedded.org/bitbake/commit/?id=744310f360d2288ac2ef07745abc86852126b5b9

(From yocto-docs rev: 9f675b996f145349210adf4fea8e2e55f57c6c77)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-12-18 10:41:21 +00:00
Quentin Schulz
f84f30253b docs: poky.yaml.in: remove pylint3 from Ubuntu/Debian host dependencies
It is not actually needed outside of the autobuilder and since the
package got renamed in Ubuntu 20.04 and later to pylint, it was giving
the users an incorrect command line to run and would fail all the time,
better remove it instead of trying to handle Debian/recent Ubuntu
differences in the documentation.

Moreover, the other supported host distributions didn't have pylint
listed as a dependency, proving that it's indeed not needed.

Cc: Quentin Schulz <foss+yocto@0leil.net>
(From yocto-docs rev: 9f255dc3c32a4c9b2185e6448bde3357fd5135b2)

Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-11-10 22:12:56 +00:00
Paulo Neves
ceb169bd59 manuals: remove xterm requirements
According to [1] xterm is no longer required. Update the manual
accordingly. Related to Bug [YOCTO #14873].

[1] https://git.openembedded.org/openembedded-core/commit/?id=ddb825c87dd3e59d50841a993080a00d1459b1e7

(From yocto-docs rev: 2b5d3be5677efc19f6610309a938bca9563a54d1)

Signed-off-by: Paulo Neves <ptsneves@gmail.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-11-07 21:31:32 +00:00
Quentin Schulz
641c4d3a1c docs: add support for langdale (4.1) release
This adds support for the Langdale (4.1) release and update the current
dev branch to Mickledore.

Cc: Quentin Schulz <foss+yocto@0leil.net>
(From yocto-docs rev: 271ae164ba901acacaf2fc910db78246637994aa)

Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-10-25 13:41:36 +01:00
Michael Opdenacker
f7f4444e36 manuals: update host tool requirements
As enforced by meta/classes/sanity.bbclass:
- at least GNU make 4.0
- at least GNU tar 7.5 (instead of 5.0)

(From yocto-docs rev: 6480aa0f8338ef192c666b9445bc0baff47d9248)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-06-21 20:57:17 +01:00
Michael Halstead
a3e459ca58 releases: update for yocto 4.0
Bump various versions and names.

(From yocto-docs rev: 7c617e7e956696842c03a7b18baff931b72d70db)

Signed-off-by: Michael Halstead <mhalstead@linuxfoundation.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-04-26 10:56:47 +01:00
Michael Halstead
1c4b8ba2eb releases: update to include 3.4.3
Build scripts now only require updates in master.

(From yocto-docs rev: af6a15e376733727eb26c9c2a6b6a85f6faea437)

Signed-off-by: Michael Halstead <mhalstead@linuxfoundation.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-03-31 11:46:03 +01:00
Richard Purdie
b04eda7447 conf.py/set_versions/poky.yaml: Set version in conf.py from poky.yaml
Allow conf.py to read the versions it needs from poky.yaml and have
set_versions.py write this out. This means we don't have to change as
many files when making new releases.

(From yocto-docs rev: bfe74c67f327f0c6445cb4129ee0c32db022b95a)

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-03-23 12:08:56 +00:00
Richard Purdie
8d3e9aaede Makefile/set_versions: Allow poky.yaml to be autogenerated
Use a script to generate the branch/tag information inside poky.yaml.

If the branch isn't a known release branch, include git magic to find
the closest matching release branch we know about.

(From yocto-docs rev: 841e2df0e2e544b82fff9ddd0339a4e775148e3a)

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2022-03-23 12:08:56 +00:00