poky/documentation/poky.yaml.in
Antonin Godard dc41858fe3 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: 9fabb08405601646fd9b00326442e03d43f68804)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit a85b0e500c94921f77fa7b7dbb877e4945f96d1e)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
2025-05-02 08:12:41 -07:00

224 lines
3.7 KiB
YAML

#
# Macros used in the documentation
#
# The DISTRO variable represents the current docs version. It should be used
# when referring to the current docs version. See also DISTRO_LATEST_TAG.
DISTRO : "4.0"
# The DISTRO_LATEST_TAG represents the latest tag on the current branch. It
# should be used in HTTP link referring to the current docs version. In these
# cases, the DISTRO may point to A.B.999 which does not exist (just used to
# represent the latest HEAD revision on the branch). DISTRO_LATEST_TAG should
# always point to an existing tag.
DISTRO_LATEST_TAG : "4.0"
DISTRO_NAME_NO_CAP : "kirkstone"
DISTRO_NAME : "Kirkstone"
DISTRO_NAME_NO_CAP_MINUS_ONE : "honister"
DISTRO_NAME_NO_CAP_LTS : "dunfell"
YOCTO_DOC_VERSION : "4.0"
DISTRO_REL_TAG : "yocto-$DISTRO;"
DISTRO_REL_LATEST_TAG : "yocto-&DISTRO_LATEST_TAG;"
DOCCONF_VERSION : "dev"
BITBAKE_SERIES : ""
YOCTO_DL_URL : "https://downloads.yoctoproject.org"
YOCTO_RELEASE_DL_URL : "&YOCTO_DL_URL;/releases/yocto/yocto-&DISTRO;"
MIN_PYTHON_VERSION : "3.6.0"
MIN_TAR_VERSION : "1.28"
MIN_GIT_VERSION : "1.8.3.1"
MIN_GCC_VERSION : "7.5"
MIN_MAKE_VERSION : "4.0"
# Disk space (Gbytes) needed to generate qemux86-64 core-image-sato on Ubuntu 22.04 (x86-64), rounded up from 87
MIN_DISK_SPACE : "90"
# Disk space (Gbytes) needed to generate qemux86-64 core-image-sato on Ubuntu 22.04 (x86-64) with "rm_work", rounded up from 38
MIN_DISK_SPACE_RM_WORK : "40"
# RAM (Gbytes) needed to generate qemux86-64 core-image-sato on Ubuntu 22.04 (x86-64) on a 4 core system
MIN_RAM : "8"
#
# Dependencies
#
# Shared between distros
PIP3_HOST_PACKAGES_DOC: sphinx sphinx_rtd_theme pyyaml
UBUNTU_DEBIAN_HOST_PACKAGES_ESSENTIAL: >-
build-essential
chrpath
cpio
debianutils
diffstat
file
gawk
gcc
git
iputils-ping
libacl1
liblz4-tool
locales
python3
python3-git
python3-jinja2
python3-pexpect
python3-pip
python3-subunit
socat
texinfo
unzip
wget
xz-utils
zstd
UBUNTU_DEBIAN_HOST_PACKAGES_DOC: >-
git
inkscape
locales
make
python3-saneyaml
python3-sphinx-rtd-theme
sphinx
texlive-latex-extra
FEDORA_HOST_PACKAGES_ESSENTIAL: >-
bzip2
ccache
chrpath
cpio
cpp
diffstat
diffutils
file
findutils
gawk
gcc
gcc-c++
git
glibc-devel
glibc-langpack-en
gzip
hostname
libacl
lz4
make
patch
perl
perl-Data-Dumper
perl-File-Compare
perl-File-Copy
perl-FindBin
perl-Text-ParseWords
perl-Thread-Queue
perl-bignum
perl-locale
python
python3
python3-GitPython
python3-jinja2
python3-pexpect
python3-pip
rpcgen
socat
tar
texinfo
unzip
wget
which
xz
zstd
FEDORA_HOST_PACKAGES_DOC: >-
git
glibc-locale-source
inkscape
make
python3-pip
texlive-fncychap
which
OPENSUSE_HOST_PACKAGES_ESSENTIAL: >-
bzip2
chrpath
diffstat
gcc
gcc-c++
git
gzip
hostname
libacl1
lz4
make
makeinfo
patch
python
python-curses
python-xml
python3
python3-Jinja2
python3-curses
python3-pexpect
python3-pip
rpcgen
socat
tar
wget
which
xz
zstd
OPENSUSE_PIP3_HOST_PACKAGES_ESSENTIAL: GitPython
OPENSUSE_HOST_PACKAGES_DOC: >-
git
glibc-i18ndata
inkscape
make
python3-pip
texlive-fncychap
which
ALMALINUX_HOST_PACKAGES_ESSENTIAL: >-
bzip2
ccache
chrpath
cpio
cpp
diffstat
diffutils
gawk
gcc
gcc-c++
git
glibc-devel
glibc-langpack-en
gzip
libacl
lz4
make
patch
perl
perl-Data-Dumper
perl-Text-ParseWords
perl-Thread-Queue
python3
python3-GitPython
python3-jinja2
python3-pexpect
python3-pip
rpcgen
socat
tar
texinfo
unzip
wget
which
xz
zstd
ALMALINUX_HOST_PACKAGES_DOC: >-
git
glibc-locale-source
inkscape
make
python3-pip
texlive-fncychap
which