[yocto-docs PATCH 0/5] Update the dependencies in poky.yaml.in

[yocto-docs PATCH 0/5] Update the dependencies in poky.yaml.in

[Antonin Godard]

This patch series aims at gathering the dependencies required to build
(both the image and the documentation) in poky.yaml.in, and updating
them with regards to recent changes (PDF, Epub addition / switch to
rsvg-convert).

Having all the dependencies listed in poky.yaml.in makes it easier to
track and compare them across the different distros. Also, these can be
reused by scripts (note: I am working on an RFC patch that uses these
variables to build a container image ready for building the doc).

Also, add the dependencies required to build PDFs/Epub files. These were
initially listed for an Ubuntu 22.04 docker image I was working with,
and "translated" for other distros using https://pkgs.org.

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
---
Antonin Godard (5):
      Gather dependencies in poky.yaml.in
      poky.yaml.in: replace inkscape dependency by librsvg2-bin
      system-requirements: update list of supported distros
      system-requirements.rst: add dependencies for pdf builds
      poky.yaml.in: add missing locales dependency

 documentation/brief-yoctoprojectqs/index.rst     |   2 +-
 documentation/poky.yaml.in                       | 309 +++++++++++++++++++++--
 documentation/ref-manual/system-requirements.rst |  57 ++++-
 3 files changed, 332 insertions(+), 36 deletions(-)
---
base-commit: 4d833d0a5f3ee741bc7e603c6316786903df335e
change-id: 20241120-update-doc-deps-1d59abdb2119

Best regards,
-- 
Antonin Godard <antonin.godard@bootlin.com>

[yocto-docs PATCH 1/5] Gather dependencies in poky.yaml.in

[Antonin Godard]

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.

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
---
 documentation/brief-yoctoprojectqs/index.rst     |   2 +-
 documentation/poky.yaml.in                       | 228 ++++++++++++++++++++---
 documentation/ref-manual/system-requirements.rst |  20 +-
 3 files changed, 214 insertions(+), 36 deletions(-)

diff --git a/documentation/brief-yoctoprojectqs/index.rst b/documentation/brief-yoctoprojectqs/index.rst
index c5400e4ac8dafb9e3d1e4c14a065d02ac3e2f7a7..3d249eefaae35239b92c8a2f8dedf27ec2dbdca0 100644
--- a/documentation/brief-yoctoprojectqs/index.rst
+++ b/documentation/brief-yoctoprojectqs/index.rst
@@ -78,7 +78,7 @@ You must install essential host packages on your build host. The
 following command installs the host packages based on an Ubuntu
 distribution::
 
-   $ sudo apt install &UBUNTU_HOST_PACKAGES_ESSENTIAL;
+   $ sudo apt install &UBUNTU_DEBIAN_HOST_PACKAGES_ESSENTIAL;
 
 .. note::
 
diff --git a/documentation/poky.yaml.in b/documentation/poky.yaml.in
index 66f758fe85fcd10291f00902639b43a1da639b0f..b840320a89bfadb259d5d9d0e11f951c55e13389 100644
--- a/documentation/poky.yaml.in
+++ b/documentation/poky.yaml.in
@@ -1,3 +1,7 @@
+#
+# Macros used in the documentation
+#
+
 DISTRO : "5.1"
 DISTRO_NAME_NO_CAP : "styhead"
 DISTRO_NAME : "Styhead"
@@ -10,31 +14,6 @@ BITBAKE_SERIES : ""
 YOCTO_DL_URL : "https://downloads.yoctoproject.org"
 YOCTO_AB_URL : "https://autobuilder.yoctoproject.org"
 YOCTO_RELEASE_DL_URL : "&YOCTO_DL_URL;/releases/yocto/yocto-&DISTRO;"
-UBUNTU_HOST_PACKAGES_ESSENTIAL : "gawk wget git diffstat unzip texinfo gcc \
-     build-essential chrpath socat cpio python3 python3-pip python3-pexpect \
-     xz-utils debianutils iputils-ping python3-git python3-jinja2 \
-     python3-subunit zstd liblz4-tool file locales libacl1"
-FEDORA_HOST_PACKAGES_ESSENTIAL : "gawk make wget tar bzip2 gzip python3 unzip perl patch \
-     diffutils diffstat git cpp gcc gcc-c++ glibc-devel texinfo chrpath \
-     ccache perl-Data-Dumper perl-Text-ParseWords perl-Thread-Queue perl-bignum socat \
-     python3-pexpect findutils which file cpio python python3-pip xz python3-GitPython \
-     python3-jinja2 rpcgen perl-FindBin perl-File-Compare \
-     perl-File-Copy perl-locale zstd lz4 hostname glibc-langpack-en libacl"
-OPENSUSE_HOST_PACKAGES_ESSENTIAL : "python gcc gcc-c++ git chrpath make wget python-xml \
-     diffstat makeinfo python-curses patch socat python3 python3-curses tar python3-pip \
-     python3-pexpect xz which python3-Jinja2 rpcgen \
-     zstd lz4 bzip2 gzip hostname libacl1
-     \n\   $ sudo pip3 install GitPython"
-ALMALINUX_HOST_PACKAGES_ESSENTIAL : "-y epel-release
-     \n\   $ sudo yum install dnf-plugins-core
-     \n\   $ sudo dnf config-manager --set-enabled crb
-     \n\   $ sudo dnf makecache
-     \n\   $ sudo dnf install gawk make wget tar bzip2 gzip python3 unzip perl patch \
-     diffutils diffstat git cpp gcc gcc-c++ glibc-devel texinfo chrpath ccache \
-     socat perl-Data-Dumper perl-Text-ParseWords perl-Thread-Queue python3-pip \
-     python3-GitPython python3-jinja2 python3-pexpect xz which \
-     rpcgen zstd lz4 cpio glibc-langpack-en libacl"
-PIP3_HOST_PACKAGES_DOC : "$ sudo pip3 install sphinx sphinx_rtd_theme pyyaml"
 MIN_PYTHON_VERSION : "3.8.0"
 MIN_TAR_VERSION : "1.28"
 MIN_GIT_VERSION : "1.8.3.1"
@@ -46,3 +25,202 @@ MIN_DISK_SPACE : "90"
 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
+  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
+  make
+  inkscape
+  texlive-latex-extra
+  sphinx
+  python3-saneyaml
+  python3-sphinx-rtd-theme
+  git
+  make
+  python3-pip
+  which
+  texlive-fncychap
+
+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
+  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
+
+# note: indent below is for sphinx's code block (three spaces)
+ALMALINUX_HOST_PACKAGES_ESSENTIAL_CMDS: |-
+     $ sudo dnf install -y epel-release
+     $ sudo yum install dnf-plugins-core
+     $ sudo dnf config-manager --set-enabled crb
+     $ sudo dnf makecache
+     $ sudo dnf install &ALMALINUX_HOST_PACKAGES_ESSENTIAL;
+
+ALMALINUX_HOST_PACKAGES_DOC: >-
+  git
+  inkscape
+  make
+  python3-pip
+  texlive-fncychap
+  which
diff --git a/documentation/ref-manual/system-requirements.rst b/documentation/ref-manual/system-requirements.rst
index b33518c7f1e0c76caa70a719e023b9c405b744e2..ca75f849d0ad10344900c7525f7163726ffe5400 100644
--- a/documentation/ref-manual/system-requirements.rst
+++ b/documentation/ref-manual/system-requirements.rst
@@ -150,7 +150,7 @@ Ubuntu and Debian
 Here are the packages needed to build an image on a headless system
 with a supported Ubuntu or Debian Linux distribution::
 
-   $ sudo apt install &UBUNTU_HOST_PACKAGES_ESSENTIAL;
+   $ sudo apt install &UBUNTU_DEBIAN_HOST_PACKAGES_ESSENTIAL;
 
 You also need to ensure you have the locale ``en_US.UTF-8`` enabled::
 
@@ -172,8 +172,7 @@ If this is not the case, you can reconfigure the ``locales`` package to add it::
 
 Here are the packages needed to build Project documentation manuals::
 
-   $ sudo apt install git make inkscape texlive-latex-extra
-   $ sudo apt install sphinx python3-saneyaml python3-sphinx-rtd-theme
+   $ sudo apt install &UBUNTU_DEBIAN_HOST_PACKAGES_DOC;
 
 Fedora Packages
 ---------------
@@ -185,8 +184,8 @@ with a supported Fedora Linux distribution::
 
 Here are the packages needed to build Project documentation manuals::
 
-   $ sudo dnf install git make python3-pip which inkscape texlive-fncychap
-   &PIP3_HOST_PACKAGES_DOC;
+   $ sudo dnf install &FEDORA_HOST_PACKAGES_DOC;
+   $ sudo pip3 install &PIP3_HOST_PACKAGES_DOC;
 
 openSUSE Packages
 -----------------
@@ -195,11 +194,12 @@ Here are the packages needed to build an image on a headless system
 with a supported openSUSE distribution::
 
    $ sudo zypper install &OPENSUSE_HOST_PACKAGES_ESSENTIAL;
+   $ sudo pip3 install &OPENSUSE_PIP3_HOST_PACKAGES_ESSENTIAL;
 
 Here are the packages needed to build Project documentation manuals::
 
-   $ sudo zypper install git make python3-pip which inkscape texlive-fncychap
-   &PIP3_HOST_PACKAGES_DOC;
+   $ sudo zypper install &OPENSUSE_HOST_PACKAGES_DOC;
+   $ sudo pip3 install &PIP3_HOST_PACKAGES_DOC;
 
 
 AlmaLinux Packages
@@ -208,7 +208,7 @@ AlmaLinux Packages
 Here are the packages needed to build an image on a headless system
 with a supported AlmaLinux distribution::
 
-   $ sudo dnf install &ALMALINUX_HOST_PACKAGES_ESSENTIAL;
+&ALMALINUX_HOST_PACKAGES_ESSENTIAL_CMDS;
 
 .. note::
 
@@ -225,8 +225,8 @@ with a supported AlmaLinux distribution::
 
 Here are the packages needed to build Project documentation manuals::
 
-   $ sudo dnf install git make python3-pip which inkscape texlive-fncychap
-   &PIP3_HOST_PACKAGES_DOC;
+   $ sudo dnf install &ALMALINUX_HOST_PACKAGES_DOC;
+   $ sudo pip3 install &PIP3_HOST_PACKAGES_DOC;
 
 .. _system-requirements-buildtools:
 

-- 
2.46.1

Re: [docs] [yocto-docs PATCH 1/5] Gather dependencies in poky.yaml.in

[Quentin Schulz]

Hi Antonin,

On 11/20/24 4:10 PM, Antonin Godard via lists.yoctoproject.org wrote:
> 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.
> 
> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
> ---
>   documentation/brief-yoctoprojectqs/index.rst     |   2 +-
>   documentation/poky.yaml.in                       | 228 ++++++++++++++++++++---
>   documentation/ref-manual/system-requirements.rst |  20 +-
>   3 files changed, 214 insertions(+), 36 deletions(-)
> 
> diff --git a/documentation/brief-yoctoprojectqs/index.rst b/documentation/brief-yoctoprojectqs/index.rst
> index c5400e4ac8dafb9e3d1e4c14a065d02ac3e2f7a7..3d249eefaae35239b92c8a2f8dedf27ec2dbdca0 100644
> --- a/documentation/brief-yoctoprojectqs/index.rst
> +++ b/documentation/brief-yoctoprojectqs/index.rst
> @@ -78,7 +78,7 @@ You must install essential host packages on your build host. The
>   following command installs the host packages based on an Ubuntu
>   distribution::
>   
> -   $ sudo apt install &UBUNTU_HOST_PACKAGES_ESSENTIAL;
> +   $ sudo apt install &UBUNTU_DEBIAN_HOST_PACKAGES_ESSENTIAL;
>   
>   .. note::
>   
> diff --git a/documentation/poky.yaml.in b/documentation/poky.yaml.in
> index 66f758fe85fcd10291f00902639b43a1da639b0f..b840320a89bfadb259d5d9d0e11f951c55e13389 100644
> --- a/documentation/poky.yaml.in
> +++ b/documentation/poky.yaml.in
> @@ -1,3 +1,7 @@
> +#
> +# Macros used in the documentation
> +#
> +
>   DISTRO : "5.1"
>   DISTRO_NAME_NO_CAP : "styhead"
>   DISTRO_NAME : "Styhead"
> @@ -10,31 +14,6 @@ BITBAKE_SERIES : ""
>   YOCTO_DL_URL : "https://downloads.yoctoproject.org/"
>   YOCTO_AB_URL : "https://autobuilder.yoctoproject.org/"
>   YOCTO_RELEASE_DL_URL : "&YOCTO_DL_URL;/releases/yocto/yocto-&DISTRO;"
> -UBUNTU_HOST_PACKAGES_ESSENTIAL : "gawk wget git diffstat unzip texinfo gcc \
> -     build-essential chrpath socat cpio python3 python3-pip python3-pexpect \
> -     xz-utils debianutils iputils-ping python3-git python3-jinja2 \
> -     python3-subunit zstd liblz4-tool file locales libacl1"
> -FEDORA_HOST_PACKAGES_ESSENTIAL : "gawk make wget tar bzip2 gzip python3 unzip perl patch \
> -     diffutils diffstat git cpp gcc gcc-c++ glibc-devel texinfo chrpath \
> -     ccache perl-Data-Dumper perl-Text-ParseWords perl-Thread-Queue perl-bignum socat \
> -     python3-pexpect findutils which file cpio python python3-pip xz python3-GitPython \
> -     python3-jinja2 rpcgen perl-FindBin perl-File-Compare \
> -     perl-File-Copy perl-locale zstd lz4 hostname glibc-langpack-en libacl"
> -OPENSUSE_HOST_PACKAGES_ESSENTIAL : "python gcc gcc-c++ git chrpath make wget python-xml \
> -     diffstat makeinfo python-curses patch socat python3 python3-curses tar python3-pip \
> -     python3-pexpect xz which python3-Jinja2 rpcgen \
> -     zstd lz4 bzip2 gzip hostname libacl1
> -     \n\   $ sudo pip3 install GitPython"
> -ALMALINUX_HOST_PACKAGES_ESSENTIAL : "-y epel-release
> -     \n\   $ sudo yum install dnf-plugins-core
> -     \n\   $ sudo dnf config-manager --set-enabled crb
> -     \n\   $ sudo dnf makecache
> -     \n\   $ sudo dnf install gawk make wget tar bzip2 gzip python3 unzip perl patch \
> -     diffutils diffstat git cpp gcc gcc-c++ glibc-devel texinfo chrpath ccache \
> -     socat perl-Data-Dumper perl-Text-ParseWords perl-Thread-Queue python3-pip \
> -     python3-GitPython python3-jinja2 python3-pexpect xz which \
> -     rpcgen zstd lz4 cpio glibc-langpack-en libacl"
> -PIP3_HOST_PACKAGES_DOC : "$ sudo pip3 install sphinx sphinx_rtd_theme pyyaml"
>   MIN_PYTHON_VERSION : "3.8.0"
>   MIN_TAR_VERSION : "1.28"
>   MIN_GIT_VERSION : "1.8.3.1"
> @@ -46,3 +25,202 @@ MIN_DISK_SPACE : "90"
>   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
> +  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
> +  make
> +  inkscape
> +  texlive-latex-extra
> +  sphinx
> +  python3-saneyaml
> +  python3-sphinx-rtd-theme
> +  git
> +  make
> +  python3-pip
> +  which
> +  texlive-fncychap
> +
> +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
> +  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
> +
> +# note: indent below is for sphinx's code block (three spaces)
> +ALMALINUX_HOST_PACKAGES_ESSENTIAL_CMDS: |-
> +     $ sudo dnf install -y epel-release
> +     $ sudo yum install dnf-plugins-core
> +     $ sudo dnf config-manager --set-enabled crb
> +     $ sudo dnf makecache
> +     $ sudo dnf install &ALMALINUX_HOST_PACKAGES_ESSENTIAL;
> +
> +ALMALINUX_HOST_PACKAGES_DOC: >-
> +  git
> +  inkscape
> +  make
> +  python3-pip
> +  texlive-fncychap
> +  which
> diff --git a/documentation/ref-manual/system-requirements.rst b/documentation/ref-manual/system-requirements.rst
> index b33518c7f1e0c76caa70a719e023b9c405b744e2..ca75f849d0ad10344900c7525f7163726ffe5400 100644
> --- a/documentation/ref-manual/system-requirements.rst
> +++ b/documentation/ref-manual/system-requirements.rst
> @@ -150,7 +150,7 @@ Ubuntu and Debian
>   Here are the packages needed to build an image on a headless system
>   with a supported Ubuntu or Debian Linux distribution::
>   
> -   $ sudo apt install &UBUNTU_HOST_PACKAGES_ESSENTIAL;
> +   $ sudo apt install &UBUNTU_DEBIAN_HOST_PACKAGES_ESSENTIAL;
>   
>   You also need to ensure you have the locale ``en_US.UTF-8`` enabled::
>   
> @@ -172,8 +172,7 @@ If this is not the case, you can reconfigure the ``locales`` package to add it::
>   
>   Here are the packages needed to build Project documentation manuals::
>   
> -   $ sudo apt install git make inkscape texlive-latex-extra
> -   $ sudo apt install sphinx python3-saneyaml python3-sphinx-rtd-theme
> +   $ sudo apt install &UBUNTU_DEBIAN_HOST_PACKAGES_DOC;

Aren't we missing the PIP3_HOST_PACKAGES_DOC here?

Also FYI, using pip on the system level is a very bad practice (as a 
matter of fact, it's not even allowed on Debian Bookworm anymore). We 
should probably rather document how to do this in virtual environments 
for example? One thing after the other though, we can start by just 
migrating the docs variable for now :)

>   
>   Fedora Packages
>   ---------------
> @@ -185,8 +184,8 @@ with a supported Fedora Linux distribution::
>   
>   Here are the packages needed to build Project documentation manuals::
>   
> -   $ sudo dnf install git make python3-pip which inkscape texlive-fncychap
> -   &PIP3_HOST_PACKAGES_DOC;
> +   $ sudo dnf install &FEDORA_HOST_PACKAGES_DOC;
> +   $ sudo pip3 install &PIP3_HOST_PACKAGES_DOC;
>   
>   openSUSE Packages
>   -----------------
> @@ -195,11 +194,12 @@ Here are the packages needed to build an image on a headless system
>   with a supported openSUSE distribution::
>   
>      $ sudo zypper install &OPENSUSE_HOST_PACKAGES_ESSENTIAL;
> +   $ sudo pip3 install &OPENSUSE_PIP3_HOST_PACKAGES_ESSENTIAL;
>   
>   Here are the packages needed to build Project documentation manuals::
>   
> -   $ sudo zypper install git make python3-pip which inkscape texlive-fncychap
> -   &PIP3_HOST_PACKAGES_DOC;
> +   $ sudo zypper install &OPENSUSE_HOST_PACKAGES_DOC;
> +   $ sudo pip3 install &PIP3_HOST_PACKAGES_DOC;
>   
>   
>   AlmaLinux Packages
> @@ -208,7 +208,7 @@ AlmaLinux Packages
>   Here are the packages needed to build an image on a headless system
>   with a supported AlmaLinux distribution::
>   
> -   $ sudo dnf install &ALMALINUX_HOST_PACKAGES_ESSENTIAL;
> +&ALMALINUX_HOST_PACKAGES_ESSENTIAL_CMDS;

It's a bit odd to have a different way to add the packages to install 
depending on the distro, couldn't we have all distros have no 
indentation, or all have some indentation?

Cheers,
Quentin

Re: [docs] [yocto-docs PATCH 1/5] Gather dependencies in poky.yaml.in

[Antonin Godard]

Hi Quentin,

On Mon Nov 25, 2024 at 6:55 PM CET, Quentin Schulz wrote:
[...]
>> diff --git a/documentation/ref-manual/system-requirements.rst b/documentation/ref-manual/system-requirements.rst
>> index b33518c7f1e0c76caa70a719e023b9c405b744e2..ca75f849d0ad10344900c7525f7163726ffe5400 100644
>> --- a/documentation/ref-manual/system-requirements.rst
>> +++ b/documentation/ref-manual/system-requirements.rst
>> @@ -150,7 +150,7 @@ Ubuntu and Debian
>>   Here are the packages needed to build an image on a headless system
>>   with a supported Ubuntu or Debian Linux distribution::
>>   
>> -   $ sudo apt install &UBUNTU_HOST_PACKAGES_ESSENTIAL;
>> +   $ sudo apt install &UBUNTU_DEBIAN_HOST_PACKAGES_ESSENTIAL;
>>   
>>   You also need to ensure you have the locale ``en_US.UTF-8`` enabled::
>>   
>> @@ -172,8 +172,7 @@ If this is not the case, you can reconfigure the ``locales`` package to add it::
>>   
>>   Here are the packages needed to build Project documentation manuals::
>>   
>> -   $ sudo apt install git make inkscape texlive-latex-extra
>> -   $ sudo apt install sphinx python3-saneyaml python3-sphinx-rtd-theme
>> +   $ sudo apt install &UBUNTU_DEBIAN_HOST_PACKAGES_DOC;
>
> Aren't we missing the PIP3_HOST_PACKAGES_DOC here?
>
> Also FYI, using pip on the system level is a very bad practice (as a 
> matter of fact, it's not even allowed on Debian Bookworm anymore). We 
> should probably rather document how to do this in virtual environments 
> for example? One thing after the other though, we can start by just 
> migrating the docs variable for now :)

Yeah, I am aware it's terrible practice and we shouldn't do that. I'd also
recommend using virtualenvs. I'll take a note of this, and try to send a patch
soon! :)

>>   
>>   Fedora Packages
>>   ---------------
>> @@ -185,8 +184,8 @@ with a supported Fedora Linux distribution::
>>   
>>   Here are the packages needed to build Project documentation manuals::
>>   
>> -   $ sudo dnf install git make python3-pip which inkscape texlive-fncychap
>> -   &PIP3_HOST_PACKAGES_DOC;
>> +   $ sudo dnf install &FEDORA_HOST_PACKAGES_DOC;
>> +   $ sudo pip3 install &PIP3_HOST_PACKAGES_DOC;
>>   
>>   openSUSE Packages
>>   -----------------
>> @@ -195,11 +194,12 @@ Here are the packages needed to build an image on a headless system
>>   with a supported openSUSE distribution::
>>   
>>      $ sudo zypper install &OPENSUSE_HOST_PACKAGES_ESSENTIAL;
>> +   $ sudo pip3 install &OPENSUSE_PIP3_HOST_PACKAGES_ESSENTIAL;
>>   
>>   Here are the packages needed to build Project documentation manuals::
>>   
>> -   $ sudo zypper install git make python3-pip which inkscape texlive-fncychap
>> -   &PIP3_HOST_PACKAGES_DOC;
>> +   $ sudo zypper install &OPENSUSE_HOST_PACKAGES_DOC;
>> +   $ sudo pip3 install &PIP3_HOST_PACKAGES_DOC;
>>   
>>   
>>   AlmaLinux Packages
>> @@ -208,7 +208,7 @@ AlmaLinux Packages
>>   Here are the packages needed to build an image on a headless system
>>   with a supported AlmaLinux distribution::
>>   
>> -   $ sudo dnf install &ALMALINUX_HOST_PACKAGES_ESSENTIAL;
>> +&ALMALINUX_HOST_PACKAGES_ESSENTIAL_CMDS;
>
> It's a bit odd to have a different way to add the packages to install 
> depending on the distro, couldn't we have all distros have no 
> indentation, or all have some indentation?

That's the only exception, because Alma Linux has several installation steps.
I'd rather keep only the dependency lists in poky.yaml.in, so I'll add the
commands back here, and use ALMALINUX_HOST_PACKAGES_ESSENTIAL in the rst doc
instead (just like what's done for the other distros).


Antonin

-- 
Antonin Godard, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com

[yocto-docs PATCH 2/5] poky.yaml.in: replace inkscape dependency by librsvg2-bin

[Antonin Godard]

inkscape used to be a requirement to convert SVG images to PNGs/PDFs,
but we replaced it recently by rsvg-convert.

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
---
 documentation/poky.yaml.in | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/documentation/poky.yaml.in b/documentation/poky.yaml.in
index b840320a89bfadb259d5d9d0e11f951c55e13389..d0c8973db27340838f78f560c01d44fb67771b25 100644
--- a/documentation/poky.yaml.in
+++ b/documentation/poky.yaml.in
@@ -62,7 +62,7 @@ UBUNTU_DEBIAN_HOST_PACKAGES_ESSENTIAL: >-
 
 UBUNTU_DEBIAN_HOST_PACKAGES_DOC: >-
   git
-  inkscape
+  librsvg2-bin
   make
   python3-saneyaml
   python3-sphinx-rtd-theme
@@ -120,7 +120,7 @@ FEDORA_HOST_PACKAGES_ESSENTIAL: >-
 FEDORA_HOST_PACKAGES_DOC: >-
   git
   make
-  inkscape
+  librsvg2-tools
   texlive-latex-extra
   sphinx
   python3-saneyaml
@@ -165,7 +165,7 @@ OPENSUSE_PIP3_HOST_PACKAGES_ESSENTIAL: GitPython
 
 OPENSUSE_HOST_PACKAGES_DOC: >-
   git
-  inkscape
+  rsvg-convert
   make
   python3-pip
   texlive-fncychap
@@ -219,7 +219,7 @@ ALMALINUX_HOST_PACKAGES_ESSENTIAL_CMDS: |-
 
 ALMALINUX_HOST_PACKAGES_DOC: >-
   git
-  inkscape
+  librsvg2-tools
   make
   python3-pip
   texlive-fncychap

-- 
2.46.1

Re: [docs] [yocto-docs PATCH 2/5] poky.yaml.in: replace inkscape dependency by librsvg2-bin

[Quentin Schulz]

Hi Antonin,

On 11/20/24 4:10 PM, Antonin Godard via lists.yoctoproject.org wrote:
> inkscape used to be a requirement to convert SVG images to PNGs/PDFs,
> but we replaced it recently by rsvg-convert.
> 
> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
> ---
>   documentation/poky.yaml.in | 8 ++++----
>   1 file changed, 4 insertions(+), 4 deletions(-)
> 
> diff --git a/documentation/poky.yaml.in b/documentation/poky.yaml.in
> index b840320a89bfadb259d5d9d0e11f951c55e13389..d0c8973db27340838f78f560c01d44fb67771b25 100644
> --- a/documentation/poky.yaml.in
> +++ b/documentation/poky.yaml.in
> @@ -62,7 +62,7 @@ UBUNTU_DEBIAN_HOST_PACKAGES_ESSENTIAL: >-
>   
>   UBUNTU_DEBIAN_HOST_PACKAGES_DOC: >-
>     git
> -  inkscape
> +  librsvg2-bin
>     make
>     python3-saneyaml
>     python3-sphinx-rtd-theme
> @@ -120,7 +120,7 @@ FEDORA_HOST_PACKAGES_ESSENTIAL: >-
>   FEDORA_HOST_PACKAGES_DOC: >-
>     git
>     make
> -  inkscape
> +  librsvg2-tools
>     texlive-latex-extra
>     sphinx
>     python3-saneyaml
> @@ -165,7 +165,7 @@ OPENSUSE_PIP3_HOST_PACKAGES_ESSENTIAL: GitPython
>   
>   OPENSUSE_HOST_PACKAGES_DOC: >-
>     git
> -  inkscape
> +  rsvg-convert

thought: maybe keep the packages alphabetically ordered?

Otherwise pkgs.org agrees with this change, so

Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>

Thanks!
Quentin

Re: [docs] [yocto-docs PATCH 2/5] poky.yaml.in: replace inkscape dependency by librsvg2-bin

[Antonin Godard]

Hi Quentin,

On Mon Nov 25, 2024 at 6:58 PM CET, Quentin Schulz wrote:
> Hi Antonin,
>
> On 11/20/24 4:10 PM, Antonin Godard via lists.yoctoproject.org wrote:
>> inkscape used to be a requirement to convert SVG images to PNGs/PDFs,
>> but we replaced it recently by rsvg-convert.
>> 
>> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
>> ---
>>   documentation/poky.yaml.in | 8 ++++----
>>   1 file changed, 4 insertions(+), 4 deletions(-)
>> 
>> diff --git a/documentation/poky.yaml.in b/documentation/poky.yaml.in
>> index b840320a89bfadb259d5d9d0e11f951c55e13389..d0c8973db27340838f78f560c01d44fb67771b25 100644
>> --- a/documentation/poky.yaml.in
>> +++ b/documentation/poky.yaml.in
>> @@ -62,7 +62,7 @@ UBUNTU_DEBIAN_HOST_PACKAGES_ESSENTIAL: >-
>>   
>>   UBUNTU_DEBIAN_HOST_PACKAGES_DOC: >-
>>     git
>> -  inkscape
>> +  librsvg2-bin
>>     make
>>     python3-saneyaml
>>     python3-sphinx-rtd-theme
>> @@ -120,7 +120,7 @@ FEDORA_HOST_PACKAGES_ESSENTIAL: >-
>>   FEDORA_HOST_PACKAGES_DOC: >-
>>     git
>>     make
>> -  inkscape
>> +  librsvg2-tools
>>     texlive-latex-extra
>>     sphinx
>>     python3-saneyaml
>> @@ -165,7 +165,7 @@ OPENSUSE_PIP3_HOST_PACKAGES_ESSENTIAL: GitPython
>>   
>>   OPENSUSE_HOST_PACKAGES_DOC: >-
>>     git
>> -  inkscape
>> +  rsvg-convert
>
> thought: maybe keep the packages alphabetically ordered?

Ha yes, that was my initial plan, missed that :)

> Otherwise pkgs.org agrees with this change, so
>
> Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>

Thank you!
Antonin

-- 
Antonin Godard, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com

[yocto-docs PATCH 3/5] system-requirements: update list of supported distros

[Antonin Godard]

To match the list in meta-poky/conf/distro/poky.conf.

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
---
 documentation/ref-manual/system-requirements.rst | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/documentation/ref-manual/system-requirements.rst b/documentation/ref-manual/system-requirements.rst
index ca75f849d0ad10344900c7525f7163726ffe5400..50c153ad7cc68a3ad175d6aad7f4527d9e4d219b 100644
--- a/documentation/ref-manual/system-requirements.rst
+++ b/documentation/ref-manual/system-requirements.rst
@@ -62,8 +62,14 @@ supported on the following distributions:
 
 -  Ubuntu 22.04 (LTS)
 
+-  Ubuntu 24.04 (LTS)
+
 -  Fedora 38
 
+-  Fedora 39
+
+-  Fedora 40
+
 -  CentOS Stream 8
 
 -  Debian GNU/Linux 11 (Bullseye)
@@ -72,6 +78,10 @@ supported on the following distributions:
 
 -  OpenSUSE Leap 15.4
 
+-  OpenSUSE Leap 15.5
+
+-  OpenSUSE Leap 15.6
+
 -  AlmaLinux 8
 
 -  AlmaLinux 9

-- 
2.46.1

Re: [docs] [yocto-docs PATCH 3/5] system-requirements: update list of supported distros

[Quentin Schulz]

Hi Antonin,

On 11/20/24 4:10 PM, Antonin Godard via lists.yoctoproject.org wrote:
> To match the list in meta-poky/conf/distro/poky.conf.
> 
> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
> ---
>   documentation/ref-manual/system-requirements.rst | 10 ++++++++++
>   1 file changed, 10 insertions(+)
> 
> diff --git a/documentation/ref-manual/system-requirements.rst b/documentation/ref-manual/system-requirements.rst
> index ca75f849d0ad10344900c7525f7163726ffe5400..50c153ad7cc68a3ad175d6aad7f4527d9e4d219b 100644
> --- a/documentation/ref-manual/system-requirements.rst
> +++ b/documentation/ref-manual/system-requirements.rst
> @@ -62,8 +62,14 @@ supported on the following distributions:
>   
>   -  Ubuntu 22.04 (LTS)
>   
> +-  Ubuntu 24.04 (LTS)
> +

24.10 as well it seems.

>   -  Fedora 38
>   
> +-  Fedora 39
> +

This one should already be in Scarthgap so split into a separate commit 
so it can be backported?

Cheers,
Quentin

Re: [docs] [yocto-docs PATCH 3/5] system-requirements: update list of supported distros

[Antonin Godard]

Hi Quentin,

On Mon Nov 25, 2024 at 7:04 PM CET, Quentin Schulz wrote:
> Hi Antonin,
>
> On 11/20/24 4:10 PM, Antonin Godard via lists.yoctoproject.org wrote:
>> To match the list in meta-poky/conf/distro/poky.conf.
>> 
>> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
>> ---
>>   documentation/ref-manual/system-requirements.rst | 10 ++++++++++
>>   1 file changed, 10 insertions(+)
>> 
>> diff --git a/documentation/ref-manual/system-requirements.rst b/documentation/ref-manual/system-requirements.rst
>> index ca75f849d0ad10344900c7525f7163726ffe5400..50c153ad7cc68a3ad175d6aad7f4527d9e4d219b 100644
>> --- a/documentation/ref-manual/system-requirements.rst
>> +++ b/documentation/ref-manual/system-requirements.rst
>> @@ -62,8 +62,14 @@ supported on the following distributions:
>>   
>>   -  Ubuntu 22.04 (LTS)
>>   
>> +-  Ubuntu 24.04 (LTS)
>> +
>
> 24.10 as well it seems.
>
>>   -  Fedora 38
>>   
>> +-  Fedora 39
>> +
>
> This one should already be in Scarthgap so split into a separate commit 
> so it can be backported?

Probably, I forgot about that - I'll double check, thank you!


Antonin

-- 
Antonin Godard, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com

[yocto-docs PATCH 4/5] system-requirements.rst: add dependencies for pdf builds

[Antonin Godard]

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).

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.

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
---
 documentation/poky.yaml.in                       | 79 +++++++++++++++++++++++-
 documentation/ref-manual/system-requirements.rst | 27 ++++++++
 2 files changed, 105 insertions(+), 1 deletion(-)

diff --git a/documentation/poky.yaml.in b/documentation/poky.yaml.in
index d0c8973db27340838f78f560c01d44fb67771b25..d95b73c74ad7979609c6e7f4e1be5343968da743 100644
--- a/documentation/poky.yaml.in
+++ b/documentation/poky.yaml.in
@@ -67,8 +67,17 @@ UBUNTU_DEBIAN_HOST_PACKAGES_DOC: >-
   python3-saneyaml
   python3-sphinx-rtd-theme
   sphinx
-  texlive-latex-extra
 
+UBUNTU_DEBIAN_HOST_PACKAGES_DOC_PDF: >-
+  fonts-freefont-otf
+  latexmk
+  tex-gyre
+  texlive-fonts-extra
+  texlive-fonts-recommended
+  texlive-lang-all
+  texlive-latex-extra
+  texlive-latex-recommended
+  texlive-xetex
 
 FEDORA_HOST_PACKAGES_ESSENTIAL: >-
   bzip2
@@ -131,6 +140,35 @@ FEDORA_HOST_PACKAGES_DOC: >-
   which
   texlive-fncychap
 
+FEDORA_HOST_PACKAGES_DOC_PDF: >-
+  latexmk
+  texlive-collection-fontsextra
+  texlive-collection-fontsrecommended
+  texlive-collection-langarabic
+  texlive-collection-langchinese
+  texlive-collection-langcjk
+  texlive-collection-langcyrillic
+  texlive-collection-langczechslovak
+  texlive-collection-langenglish
+  texlive-collection-langeuropean
+  texlive-collection-langfrench
+  texlive-collection-langgerman
+  texlive-collection-langgreek
+  texlive-collection-langitalian
+  texlive-collection-langjapanese
+  texlive-collection-langkorean
+  texlive-collection-langother
+  texlive-collection-langpolish
+  texlive-collection-langportuguese
+  texlive-collection-langspanish
+  texlive-collection-latex
+  texlive-collection-latexextra
+  texlive-collection-latexrecommended
+  texlive-collection-xetex
+  texlive-gnu-freefont
+  texlive-tex-gyre
+  texlive-xetex
+
 OPENSUSE_HOST_PACKAGES_ESSENTIAL: >-
   bzip2
   chrpath
@@ -171,6 +209,35 @@ OPENSUSE_HOST_PACKAGES_DOC: >-
   texlive-fncychap
   which
 
+OPENSUSE_HOST_PACKAGES_DOC_PDF: >-
+  texlive-collection-fontsextra
+  texlive-collection-fontsrecommended
+  texlive-collection-langarabic
+  texlive-collection-langchinese
+  texlive-collection-langcjk
+  texlive-collection-langcyrillic
+  texlive-collection-langczechslovak
+  texlive-collection-langenglish
+  texlive-collection-langeuropean
+  texlive-collection-langfrench
+  texlive-collection-langgerman
+  texlive-collection-langgreek
+  texlive-collection-langitalian
+  texlive-collection-langjapanese
+  texlive-collection-langkorean
+  texlive-collection-langother
+  texlive-collection-langpolish
+  texlive-collection-langportuguese
+  texlive-collection-langspanish
+  texlive-collection-latex
+  texlive-collection-latexextra
+  texlive-collection-latexrecommended
+  texlive-collection-xetex
+  texlive-gnu-freefont
+  texlive-latexmk
+  texlive-tex-gyre
+  texlive-xetex
+
 ALMALINUX_HOST_PACKAGES_ESSENTIAL: >-
   bzip2
   ccache
@@ -224,3 +291,13 @@ ALMALINUX_HOST_PACKAGES_DOC: >-
   python3-pip
   texlive-fncychap
   which
+
+ALMALINUX_HOST_PACKAGES_DOC_PDF: >-
+  latexmk
+  texlive-collection-fontsrecommended
+  texlive-collection-latex
+  texlive-collection-latexrecommended
+  texlive-collection-xetex
+  texlive-gnu-freefont
+  texlive-tex-gyre
+  texlive-xetex
diff --git a/documentation/ref-manual/system-requirements.rst b/documentation/ref-manual/system-requirements.rst
index 50c153ad7cc68a3ad175d6aad7f4527d9e4d219b..aa1f1958da580516b7f38fa1a325d1f03364ee66 100644
--- a/documentation/ref-manual/system-requirements.rst
+++ b/documentation/ref-manual/system-requirements.rst
@@ -184,6 +184,11 @@ Here are the packages needed to build Project documentation manuals::
 
    $ sudo apt install &UBUNTU_DEBIAN_HOST_PACKAGES_DOC;
 
+In addition to the previous packages, here are the packages needed to build the
+documentation in PDF format::
+
+   $ sudo apt install &UBUNTU_DEBIAN_HOST_PACKAGES_DOC_PDF;
+
 Fedora Packages
 ---------------
 
@@ -197,6 +202,11 @@ Here are the packages needed to build Project documentation manuals::
    $ sudo dnf install &FEDORA_HOST_PACKAGES_DOC;
    $ sudo pip3 install &PIP3_HOST_PACKAGES_DOC;
 
+In addition to the previous packages, here are the packages needed to build the
+documentation in PDF format::
+
+   $ sudo dnf install &FEDORA_HOST_PACKAGES_DOC_PDF;
+
 openSUSE Packages
 -----------------
 
@@ -211,6 +221,11 @@ Here are the packages needed to build Project documentation manuals::
    $ sudo zypper install &OPENSUSE_HOST_PACKAGES_DOC;
    $ sudo pip3 install &PIP3_HOST_PACKAGES_DOC;
 
+In addition to the previous packages, here are the packages needed to build the
+documentation in PDF format::
+
+   $ sudo zypper install &OPENSUSE_HOST_PACKAGES_DOC_PDF;
+
 
 AlmaLinux Packages
 ------------------
@@ -238,6 +253,18 @@ Here are the packages needed to build Project documentation manuals::
    $ sudo dnf install &ALMALINUX_HOST_PACKAGES_DOC;
    $ sudo pip3 install &PIP3_HOST_PACKAGES_DOC;
 
+In addition to the previous packages, here are the packages needed to build the
+documentation in PDF format::
+
+   $ sudo dnf install &ALMALINUX_HOST_PACKAGES_DOC_PDF;
+
+.. warning::
+
+   Unlike Fedora or OpenSUSE, AlmaLinux does not provide the packages
+   ``texlive-collection-fontsextra``, ``texlive-collection-lang*`` and
+   ``texlive-collection-latexextra``, so you may run into issues. These may be
+   installed using `tlmgr <https://tug.org/texlive/tlmgr.html>`_.
+
 .. _system-requirements-buildtools:
 
 Required Git, tar, Python, make and gcc Versions

-- 
2.46.1

Re: [docs] [yocto-docs PATCH 4/5] system-requirements.rst: add dependencies for pdf builds

[Quentin Schulz]

Hi Antonin,

On 11/20/24 4:10 PM, Antonin Godard via lists.yoctoproject.org wrote:
> 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).
> 
> 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.
> 
> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
> ---
>   documentation/poky.yaml.in                       | 79 +++++++++++++++++++++++-
>   documentation/ref-manual/system-requirements.rst | 27 ++++++++
>   2 files changed, 105 insertions(+), 1 deletion(-)
> 
> diff --git a/documentation/poky.yaml.in b/documentation/poky.yaml.in
> index d0c8973db27340838f78f560c01d44fb67771b25..d95b73c74ad7979609c6e7f4e1be5343968da743 100644
> --- a/documentation/poky.yaml.in
> +++ b/documentation/poky.yaml.in
> @@ -67,8 +67,17 @@ UBUNTU_DEBIAN_HOST_PACKAGES_DOC: >-
>     python3-saneyaml
>     python3-sphinx-rtd-theme
>     sphinx
> -  texlive-latex-extra
>   
> +UBUNTU_DEBIAN_HOST_PACKAGES_DOC_PDF: >-
> +  fonts-freefont-otf
> +  latexmk
> +  tex-gyre
> +  texlive-fonts-extra
> +  texlive-fonts-recommended
> +  texlive-lang-all
> +  texlive-latex-extra
> +  texlive-latex-recommended
> +  texlive-xetex
>   
>   FEDORA_HOST_PACKAGES_ESSENTIAL: >-
>     bzip2
> @@ -131,6 +140,35 @@ FEDORA_HOST_PACKAGES_DOC: >-
>     which
>     texlive-fncychap
>   
> +FEDORA_HOST_PACKAGES_DOC_PDF: >-
> +  latexmk
> +  texlive-collection-fontsextra
> +  texlive-collection-fontsrecommended
> +  texlive-collection-langarabic
> +  texlive-collection-langchinese
> +  texlive-collection-langcjk
> +  texlive-collection-langcyrillic
> +  texlive-collection-langczechslovak
> +  texlive-collection-langenglish
> +  texlive-collection-langeuropean
> +  texlive-collection-langfrench
> +  texlive-collection-langgerman
> +  texlive-collection-langgreek
> +  texlive-collection-langitalian
> +  texlive-collection-langjapanese
> +  texlive-collection-langkorean
> +  texlive-collection-langother
> +  texlive-collection-langpolish
> +  texlive-collection-langportuguese
> +  texlive-collection-langspanish

I'm wondering if we really need all languages or if we were too lazy to 
figure out which ones we actually need.

Also, you should be able to avoid listing them all by using 
'texlive-collection-lang*', dnf should be able to handle that just fine.

> +  texlive-collection-latex
> +  texlive-collection-latexextra
> +  texlive-collection-latexrecommended

latex-extra already requires latex-recommended which already requires 
latex so only the former is necessary.

Cheers,
Quentin

Re: [docs] [yocto-docs PATCH 4/5] system-requirements.rst: add dependencies for pdf builds

[Antonin Godard]

Hi Quentin,

On Mon Nov 25, 2024 at 7:11 PM CET, Quentin Schulz wrote:
> Hi Antonin,
>
> On 11/20/24 4:10 PM, Antonin Godard via lists.yoctoproject.org wrote:
>> 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).
>> 
>> 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.
>> 
>> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
>> ---
>>   documentation/poky.yaml.in                       | 79 +++++++++++++++++++++++-
>>   documentation/ref-manual/system-requirements.rst | 27 ++++++++
>>   2 files changed, 105 insertions(+), 1 deletion(-)
>> 
>> diff --git a/documentation/poky.yaml.in b/documentation/poky.yaml.in
>> index d0c8973db27340838f78f560c01d44fb67771b25..d95b73c74ad7979609c6e7f4e1be5343968da743 100644
>> --- a/documentation/poky.yaml.in
>> +++ b/documentation/poky.yaml.in
>> @@ -67,8 +67,17 @@ UBUNTU_DEBIAN_HOST_PACKAGES_DOC: >-
>>     python3-saneyaml
>>     python3-sphinx-rtd-theme
>>     sphinx
>> -  texlive-latex-extra
>>   
>> +UBUNTU_DEBIAN_HOST_PACKAGES_DOC_PDF: >-
>> +  fonts-freefont-otf
>> +  latexmk
>> +  tex-gyre
>> +  texlive-fonts-extra
>> +  texlive-fonts-recommended
>> +  texlive-lang-all
>> +  texlive-latex-extra
>> +  texlive-latex-recommended
>> +  texlive-xetex
>>   
>>   FEDORA_HOST_PACKAGES_ESSENTIAL: >-
>>     bzip2
>> @@ -131,6 +140,35 @@ FEDORA_HOST_PACKAGES_DOC: >-
>>     which
>>     texlive-fncychap
>>   
>> +FEDORA_HOST_PACKAGES_DOC_PDF: >-
>> +  latexmk
>> +  texlive-collection-fontsextra
>> +  texlive-collection-fontsrecommended
>> +  texlive-collection-langarabic
>> +  texlive-collection-langchinese
>> +  texlive-collection-langcjk
>> +  texlive-collection-langcyrillic
>> +  texlive-collection-langczechslovak
>> +  texlive-collection-langenglish
>> +  texlive-collection-langeuropean
>> +  texlive-collection-langfrench
>> +  texlive-collection-langgerman
>> +  texlive-collection-langgreek
>> +  texlive-collection-langitalian
>> +  texlive-collection-langjapanese
>> +  texlive-collection-langkorean
>> +  texlive-collection-langother
>> +  texlive-collection-langpolish
>> +  texlive-collection-langportuguese
>> +  texlive-collection-langspanish
>
> I'm wondering if we really need all languages or if we were too lazy to 
> figure out which ones we actually need.

Actually, I'd go with all of them... the initial reason for including those is
because contributors in the release notes may have names with international
characters. I'd include them all "to be safe" and avoid wondering about LaTeX
errors later.

> Also, you should be able to avoid listing them all by using 
> 'texlive-collection-lang*', dnf should be able to handle that just fine.

Thanks for the tip. I should be able to test that with my container scripts soon :)

>> +  texlive-collection-latex
>> +  texlive-collection-latexextra
>> +  texlive-collection-latexrecommended
>
> latex-extra already requires latex-recommended which already requires 
> latex so only the former is necessary.

+1


Thank you,
Antonin

-- 
Antonin Godard, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com

Re: [docs] [yocto-docs PATCH 4/5] system-requirements.rst: add dependencies for pdf builds

[Quentin Schulz]

Hi Antonin,

On 11/29/24 3:06 PM, Antonin Godard via lists.yoctoproject.org wrote:
> Hi Quentin,
> 
> On Mon Nov 25, 2024 at 7:11 PM CET, Quentin Schulz wrote:
>> Hi Antonin,
>>
>> On 11/20/24 4:10 PM, Antonin Godard via lists.yoctoproject.org wrote:
>>> 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).
>>>
>>> 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.
>>>
>>> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
>>> ---
>>>    documentation/poky.yaml.in                       | 79 +++++++++++++++++++++++-
>>>    documentation/ref-manual/system-requirements.rst | 27 ++++++++
>>>    2 files changed, 105 insertions(+), 1 deletion(-)
>>>
>>> diff --git a/documentation/poky.yaml.in b/documentation/poky.yaml.in
>>> index d0c8973db27340838f78f560c01d44fb67771b25..d95b73c74ad7979609c6e7f4e1be5343968da743 100644
>>> --- a/documentation/poky.yaml.in
>>> +++ b/documentation/poky.yaml.in
>>> @@ -67,8 +67,17 @@ UBUNTU_DEBIAN_HOST_PACKAGES_DOC: >-
>>>      python3-saneyaml
>>>      python3-sphinx-rtd-theme
>>>      sphinx
>>> -  texlive-latex-extra
>>>    
>>> +UBUNTU_DEBIAN_HOST_PACKAGES_DOC_PDF: >-
>>> +  fonts-freefont-otf
>>> +  latexmk
>>> +  tex-gyre
>>> +  texlive-fonts-extra
>>> +  texlive-fonts-recommended
>>> +  texlive-lang-all
>>> +  texlive-latex-extra
>>> +  texlive-latex-recommended
>>> +  texlive-xetex
>>>    
>>>    FEDORA_HOST_PACKAGES_ESSENTIAL: >-
>>>      bzip2
>>> @@ -131,6 +140,35 @@ FEDORA_HOST_PACKAGES_DOC: >-
>>>      which
>>>      texlive-fncychap
>>>    
>>> +FEDORA_HOST_PACKAGES_DOC_PDF: >-
>>> +  latexmk
>>> +  texlive-collection-fontsextra
>>> +  texlive-collection-fontsrecommended
>>> +  texlive-collection-langarabic
>>> +  texlive-collection-langchinese
>>> +  texlive-collection-langcjk
>>> +  texlive-collection-langcyrillic
>>> +  texlive-collection-langczechslovak
>>> +  texlive-collection-langenglish
>>> +  texlive-collection-langeuropean
>>> +  texlive-collection-langfrench
>>> +  texlive-collection-langgerman
>>> +  texlive-collection-langgreek
>>> +  texlive-collection-langitalian
>>> +  texlive-collection-langjapanese
>>> +  texlive-collection-langkorean
>>> +  texlive-collection-langother
>>> +  texlive-collection-langpolish
>>> +  texlive-collection-langportuguese
>>> +  texlive-collection-langspanish
>>
>> I'm wondering if we really need all languages or if we were too lazy to
>> figure out which ones we actually need.
> 
> Actually, I'd go with all of them... the initial reason for including those is
> because contributors in the release notes may have names with international
> characters. I'd include them all "to be safe" and avoid wondering about LaTeX
> errors later.
> 

Ah true, that was the reason, I had forgotten already with my name with 
boring letters :)

>> Also, you should be able to avoid listing them all by using
>> 'texlive-collection-lang*', dnf should be able to handle that just fine.
> 
> Thanks for the tip. I should be able to test that with my container scripts soon :)
> 
>>> +  texlive-collection-latex
>>> +  texlive-collection-latexextra
>>> +  texlive-collection-latexrecommended
>>
>> latex-extra already requires latex-recommended which already requires
>> latex so only the former is necessary.
> 
> +1
> 

Actually I think this is potentially a bad recommendation. It depends 
exactly what we need. But if we need stuff from latex-recommended or 
latex, we should explicitly list either or both, because it would 
prevent issues when the distro decides latexextra doesn't require 
latexrecommended which doesn't require latex anymore. This has happened 
to me (in a different context) when upgrading from Debian Bullseye to 
Bookworm.

Cheers,
Quentin

Re: [docs] [yocto-docs PATCH 4/5] system-requirements.rst: add dependencies for pdf builds

[Antonin Godard]

Hi Quentin,

On Fri Nov 29, 2024 at 3:28 PM CET, Quentin Schulz wrote:
[...]
>>>> +  texlive-collection-latex
>>>> +  texlive-collection-latexextra
>>>> +  texlive-collection-latexrecommended
>>>
>>> latex-extra already requires latex-recommended which already requires
>>> latex so only the former is necessary.
>> 
>> +1
>> 
>
> Actually I think this is potentially a bad recommendation. It depends 
> exactly what we need. But if we need stuff from latex-recommended or 
> latex, we should explicitly list either or both, because it would 
> prevent issues when the distro decides latexextra doesn't require 
> latexrecommended which doesn't require latex anymore. This has happened 
> to me (in a different context) when upgrading from Debian Bullseye to 
> Bookworm.

Okay, let's keep all of them to be safe then.


Thanks,
Antonin

-- 
Antonin Godard, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com

[yocto-docs PATCH 5/5] poky.yaml.in: add missing locales dependency

[Antonin Godard]

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

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
---
 documentation/poky.yaml.in | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/documentation/poky.yaml.in b/documentation/poky.yaml.in
index d95b73c74ad7979609c6e7f4e1be5343968da743..0158203da7d4db9eadf21943d10256c6bc49a290 100644
--- a/documentation/poky.yaml.in
+++ b/documentation/poky.yaml.in
@@ -63,6 +63,7 @@ UBUNTU_DEBIAN_HOST_PACKAGES_ESSENTIAL: >-
 UBUNTU_DEBIAN_HOST_PACKAGES_DOC: >-
   git
   librsvg2-bin
+  locales
   make
   python3-saneyaml
   python3-sphinx-rtd-theme
@@ -135,6 +136,7 @@ FEDORA_HOST_PACKAGES_DOC: >-
   python3-saneyaml
   python3-sphinx-rtd-theme
   git
+  glibc-locale-source
   make
   python3-pip
   which
@@ -203,6 +205,7 @@ OPENSUSE_PIP3_HOST_PACKAGES_ESSENTIAL: GitPython
 
 OPENSUSE_HOST_PACKAGES_DOC: >-
   git
+  glibc-i18ndata
   rsvg-convert
   make
   python3-pip
@@ -286,6 +289,7 @@ ALMALINUX_HOST_PACKAGES_ESSENTIAL_CMDS: |-
 
 ALMALINUX_HOST_PACKAGES_DOC: >-
   git
+  olibc-locale-source
   librsvg2-tools
   make
   python3-pip

-- 
2.46.1

Re: [docs] [yocto-docs PATCH 5/5] poky.yaml.in: add missing locales dependency

[Quentin Schulz]

Hi Antonin,

On 11/20/24 4:10 PM, Antonin Godard via lists.yoctoproject.org wrote:
> 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
> 
> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
> ---
>   documentation/poky.yaml.in | 4 ++++
>   1 file changed, 4 insertions(+)
> 
> diff --git a/documentation/poky.yaml.in b/documentation/poky.yaml.in
> index d95b73c74ad7979609c6e7f4e1be5343968da743..0158203da7d4db9eadf21943d10256c6bc49a290 100644
> --- a/documentation/poky.yaml.in
> +++ b/documentation/poky.yaml.in
> @@ -63,6 +63,7 @@ UBUNTU_DEBIAN_HOST_PACKAGES_ESSENTIAL: >-
>   UBUNTU_DEBIAN_HOST_PACKAGES_DOC: >-
>     git
>     librsvg2-bin
> +  locales
>     make
>     python3-saneyaml
>     python3-sphinx-rtd-theme
> @@ -135,6 +136,7 @@ FEDORA_HOST_PACKAGES_DOC: >-
>     python3-saneyaml
>     python3-sphinx-rtd-theme
>     git
> +  glibc-locale-source
>     make
>     python3-pip
>     which
> @@ -203,6 +205,7 @@ OPENSUSE_PIP3_HOST_PACKAGES_ESSENTIAL: GitPython
>   
>   OPENSUSE_HOST_PACKAGES_DOC: >-
>     git
> +  glibc-i18ndata
>     rsvg-convert
>     make
>     python3-pip
> @@ -286,6 +289,7 @@ ALMALINUX_HOST_PACKAGES_ESSENTIAL_CMDS: |-
>   
>   ALMALINUX_HOST_PACKAGES_DOC: >-
>     git
> +  olibc-locale-source

I believe this is a typo here and should read glibc-locale-source?

Cheers,
Quentin

Re: [docs] [yocto-docs PATCH 5/5] poky.yaml.in: add missing locales dependency

[Antonin Godard]

Hi Quentin,

On Mon Nov 25, 2024 at 7:12 PM CET, Quentin Schulz wrote:
> Hi Antonin,
>
> On 11/20/24 4:10 PM, Antonin Godard via lists.yoctoproject.org wrote:
>> 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
>> 
>> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
>> ---
>>   documentation/poky.yaml.in | 4 ++++
>>   1 file changed, 4 insertions(+)
>> 
>> diff --git a/documentation/poky.yaml.in b/documentation/poky.yaml.in
>> index d95b73c74ad7979609c6e7f4e1be5343968da743..0158203da7d4db9eadf21943d10256c6bc49a290 100644
>> --- a/documentation/poky.yaml.in
>> +++ b/documentation/poky.yaml.in
>> @@ -63,6 +63,7 @@ UBUNTU_DEBIAN_HOST_PACKAGES_ESSENTIAL: >-
>>   UBUNTU_DEBIAN_HOST_PACKAGES_DOC: >-
>>     git
>>     librsvg2-bin
>> +  locales
>>     make
>>     python3-saneyaml
>>     python3-sphinx-rtd-theme
>> @@ -135,6 +136,7 @@ FEDORA_HOST_PACKAGES_DOC: >-
>>     python3-saneyaml
>>     python3-sphinx-rtd-theme
>>     git
>> +  glibc-locale-source
>>     make
>>     python3-pip
>>     which
>> @@ -203,6 +205,7 @@ OPENSUSE_PIP3_HOST_PACKAGES_ESSENTIAL: GitPython
>>   
>>   OPENSUSE_HOST_PACKAGES_DOC: >-
>>     git
>> +  glibc-i18ndata
>>     rsvg-convert
>>     make
>>     python3-pip
>> @@ -286,6 +289,7 @@ ALMALINUX_HOST_PACKAGES_ESSENTIAL_CMDS: |-
>>   
>>   ALMALINUX_HOST_PACKAGES_DOC: >-
>>     git
>> +  olibc-locale-source
>
> I believe this is a typo here and should read glibc-locale-source?

Totally, thank you for noticing this.


Antonin

-- 
Antonin Godard, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com