[PATCH 1/2] poky.yaml.in, system-requirements.rst: update system requirements

[PATCH 1/2] poky.yaml.in, system-requirements.rst: update system requirements

[michael.opdenacker]

From: Michael Opdenacker <michael.opdenacker@bootlin.com>

- 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

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reported-by: Randy MacLeod <randy.macleod@windriver.com>
---
 documentation/poky.yaml.in                    | 21 +++++++------------
 .../ref-manual/system-requirements.rst        | 10 ++++-----
 2 files changed, 13 insertions(+), 18 deletions(-)

diff --git a/documentation/poky.yaml.in b/documentation/poky.yaml.in
index cdccf6f3ca..44654aa62f 100644
--- a/documentation/poky.yaml.in
+++ b/documentation/poky.yaml.in
@@ -13,33 +13,28 @@ 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 libegl1-mesa libsdl1.2-dev \
-     python3-subunit mesa-common-dev zstd liblz4-tool"
+     python3-subunit mesa-common-dev zstd liblz4-tool file locales
+     \n\      $ sudo locale-gen en_US.UTF-8"
 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 SDL-devel rpcgen mesa-libGL-devel perl-FindBin perl-File-Compare \
-     perl-File-Copy perl-locale zstd lz4"
+     perl-File-Copy perl-locale zstd lz4 hostname glibc-langpack-en"
 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 Mesa-libEGL1 libSDL-devel rpcgen Mesa-dri-devel \
-     zstd lz4
+     zstd lz4 bzip2 gzip hostname
      \n\      $ sudo pip3 install GitPython"
-CENTOS7_HOST_PACKAGES_ESSENTIAL : "-y epel-release
-     \n\      $ sudo yum makecache
-     \n\      $ sudo yum install gawk make wget tar bzip2 gzip python3 unzip perl patch \
-     diffutils diffstat git cpp gcc gcc-c++ glibc-devel texinfo chrpath socat \
-     perl-Data-Dumper perl-Text-ParseWords perl-Thread-Queue python3-pip xz \
-     which SDL-devel mesa-libGL-devel zstd lz4
-     \n\      $ sudo pip3 install GitPython jinja2"
-CENTOS8_HOST_PACKAGES_ESSENTIAL : "-y epel-release
-     \n\      $ sudo dnf config-manager --set-enabled PowerTools
+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 SDL-devel \
-     rpcgen mesa-libGL-devel zstd lz4"
+     rpcgen mesa-libGL-devel zstd lz4 cpio glibc-langpack-en"
 PIP3_HOST_PACKAGES_DOC : "$ sudo pip3 install sphinx sphinx_rtd_theme pyyaml"
 MIN_PYTHON_VERSION : "3.8.0"
 MIN_TAR_VERSION : "1.28"
diff --git a/documentation/ref-manual/system-requirements.rst b/documentation/ref-manual/system-requirements.rst
index 38d4aaf5a7..1bbe7b894d 100644
--- a/documentation/ref-manual/system-requirements.rst
+++ b/documentation/ref-manual/system-requirements.rst
@@ -168,16 +168,16 @@ supported openSUSE Linux distribution:
       &PIP3_HOST_PACKAGES_DOC;
 
 
-AlmaLinux-8 Packages
---------------------
+AlmaLinux Packages
+------------------
 
 Here are the required packages by function given a
-supported AlmaLinux-8 Linux distribution:
+supported AlmaLinux Linux distribution:
 
 -  *Essentials:* Packages needed to build an image for a headless
    system::
 
-      $ sudo dnf install &CENTOS8_HOST_PACKAGES_ESSENTIAL;
+      $ sudo dnf install &ALMALINUX8_HOST_PACKAGES_ESSENTIAL;
 
    .. note::
 
@@ -186,7 +186,7 @@ supported AlmaLinux-8 Linux distribution:
          easy installation of packages not included in enterprise Linux
          by default. You need to install these packages separately.
 
-      -  The ``PowerTools`` repo provides additional packages such as
+      -  The ``PowerTools/CRB`` repo provides additional packages such as
          ``rpcgen`` and ``texinfo``.
 
       -  The ``makecache`` command consumes additional Metadata from
-- 
2.34.1

[PATCH 2/2] ref-manual: system-requirements.rst: simplify supported distro requirements

[michael.opdenacker]

From: Michael Opdenacker <michael.opdenacker@bootlin.com>

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

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
---
 documentation/brief-yoctoprojectqs/index.rst  |  6 +-
 documentation/poky.yaml.in                    | 12 +--
 .../ref-manual/system-requirements.rst        | 83 ++++++++-----------
 3 files changed, 42 insertions(+), 59 deletions(-)

diff --git a/documentation/brief-yoctoprojectqs/index.rst b/documentation/brief-yoctoprojectqs/index.rst
index c8310e0066..7b8baf233a 100644
--- a/documentation/brief-yoctoprojectqs/index.rst
+++ b/documentation/brief-yoctoprojectqs/index.rst
@@ -70,11 +70,9 @@ Build Host Packages
 
 You must install essential host packages on your build host. The
 following command installs the host packages based on an Ubuntu
-distribution:
+distribution::
 
-.. code-block:: shell
-
-  $ sudo apt install &UBUNTU_HOST_PACKAGES_ESSENTIAL;
+   $ sudo apt install &UBUNTU_HOST_PACKAGES_ESSENTIAL;
 
 .. note::
 
diff --git a/documentation/poky.yaml.in b/documentation/poky.yaml.in
index 44654aa62f..30e1050824 100644
--- a/documentation/poky.yaml.in
+++ b/documentation/poky.yaml.in
@@ -14,7 +14,7 @@ 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 libegl1-mesa libsdl1.2-dev \
      python3-subunit mesa-common-dev zstd liblz4-tool file locales
-     \n\      $ sudo locale-gen en_US.UTF-8"
+     \n\   $ sudo locale-gen en_US.UTF-8"
 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 \
@@ -25,12 +25,12 @@ OPENSUSE_HOST_PACKAGES_ESSENTIAL : "python gcc gcc-c++ git chrpath make wget pyt
      diffstat makeinfo python-curses patch socat python3 python3-curses tar python3-pip \
      python3-pexpect xz which python3-Jinja2 Mesa-libEGL1 libSDL-devel rpcgen Mesa-dri-devel \
      zstd lz4 bzip2 gzip hostname
-     \n\      $ sudo pip3 install GitPython"
+     \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 \
+     \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 SDL-devel \
diff --git a/documentation/ref-manual/system-requirements.rst b/documentation/ref-manual/system-requirements.rst
index 1bbe7b894d..0fbe3f12c8 100644
--- a/documentation/ref-manual/system-requirements.rst
+++ b/documentation/ref-manual/system-requirements.rst
@@ -110,8 +110,10 @@ function.
 Ubuntu and Debian
 -----------------
 
-Here are the required packages by function given a
-supported Ubuntu or Debian Linux distribution:
+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;
 
 .. note::
 
@@ -123,80 +125,63 @@ supported Ubuntu or Debian Linux distribution:
          $ sudo apt build-dep qemu
          $ sudo apt remove oss4-dev
 
--  *Essentials:* Packages needed to build an image on a headless system::
-
-      $ sudo apt install &UBUNTU_HOST_PACKAGES_ESSENTIAL;
+Here are the packages needed to build Project documentation manuals::
 
--  *Documentation:* Packages needed if you are going to build out the
-   Yocto Project documentation manuals::
-
-      $ sudo apt install make python3-pip inkscape texlive-latex-extra
-      &PIP3_HOST_PACKAGES_DOC;
+   $ sudo apt install make python3-pip inkscape texlive-latex-extra
+   &PIP3_HOST_PACKAGES_DOC;
 
 Fedora Packages
 ---------------
 
-Here are the required packages by function given a
-supported Fedora Linux distribution:
-
--  *Essentials:* Packages needed to build an image for a headless
-   system::
+Here are the packages needed to build an image on a headless system
+with a supported Fedora Linux distribution::
 
-      $ sudo dnf install &FEDORA_HOST_PACKAGES_ESSENTIAL;
+   $ sudo dnf install &FEDORA_HOST_PACKAGES_ESSENTIAL;
 
--  *Documentation:* Packages needed if you are going to build out the
-   Yocto Project documentation manuals::
+Here are the packages needed to build Project documentation manuals::
 
-      $ sudo dnf install make python3-pip which inkscape texlive-fncychap
-      &PIP3_HOST_PACKAGES_DOC;
+   $ sudo dnf install make python3-pip which inkscape texlive-fncychap
+   &PIP3_HOST_PACKAGES_DOC;
 
 openSUSE Packages
 -----------------
 
-Here are the required packages by function given a
-supported openSUSE Linux distribution:
+Here are the packages needed to build an image on a headless system
+with a supported openSUSE distribution::
 
--  *Essentials:* Packages needed to build an image for a headless
-   system::
+   $ sudo zypper install &OPENSUSE_HOST_PACKAGES_ESSENTIAL;
 
-      $ sudo zypper install &OPENSUSE_HOST_PACKAGES_ESSENTIAL;
+Here are the packages needed to build Project documentation manuals::
 
--  *Documentation:* Packages needed if you are going to build out the
-   Yocto Project documentation manuals::
-
-      $ sudo zypper install make python3-pip which inkscape texlive-fncychap
-      &PIP3_HOST_PACKAGES_DOC;
+   $ sudo zypper install make python3-pip which inkscape texlive-fncychap
+   &PIP3_HOST_PACKAGES_DOC;
 
 
 AlmaLinux Packages
 ------------------
 
-Here are the required packages by function given a
-supported AlmaLinux Linux distribution:
-
--  *Essentials:* Packages needed to build an image for a headless
-   system::
+Here are the packages needed to build an image on a headless system
+with a supported AlmaLinux distribution::
 
-      $ sudo dnf install &ALMALINUX8_HOST_PACKAGES_ESSENTIAL;
+   $ sudo dnf install &ALMALINUX8_HOST_PACKAGES_ESSENTIAL;
 
-   .. note::
+.. note::
 
-      -  Extra Packages for Enterprise Linux (i.e. ``epel-release``) is
-         a collection of packages from Fedora built on RHEL/CentOS for
-         easy installation of packages not included in enterprise Linux
-         by default. You need to install these packages separately.
+   -  Extra Packages for Enterprise Linux (i.e. ``epel-release``) is
+      a collection of packages from Fedora built on RHEL/CentOS for
+      easy installation of packages not included in enterprise Linux
+      by default. You need to install these packages separately.
 
-      -  The ``PowerTools/CRB`` repo provides additional packages such as
-         ``rpcgen`` and ``texinfo``.
+   -  The ``PowerTools/CRB`` repo provides additional packages such as
+      ``rpcgen`` and ``texinfo``.
 
-      -  The ``makecache`` command consumes additional Metadata from
-         ``epel-release``.
+   -  The ``makecache`` command consumes additional Metadata from
+      ``epel-release``.
 
--  *Documentation:* Packages needed if you are going to build out the
-   Yocto Project documentation manuals::
+Here are the packages needed to build Project documentation manuals::
 
-      $ sudo dnf install make python3-pip which inkscape texlive-fncychap
-      &PIP3_HOST_PACKAGES_DOC;
+   $ sudo dnf install make python3-pip which inkscape texlive-fncychap
+   &PIP3_HOST_PACKAGES_DOC;
 
 .. _system-requirements-buildtools:
 
-- 
2.34.1

Re: [PATCH 1/2] poky.yaml.in, system-requirements.rst: update system requirements

[Randy MacLeod]

[-- Attachment #1: Type: text/plain, Size: 5479 bytes --]

On 2023-03-15 16:42, michael.opdenacker@bootlin.com wrote:
> From: Michael Opdenacker<michael.opdenacker@bootlin.com>
>
> - 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
>
> Signed-off-by: Michael Opdenacker<michael.opdenacker@bootlin.com>
> Reported-by: Randy MacLeod<randy.macleod@windriver.com>
> ---
>   documentation/poky.yaml.in                    | 21 +++++++------------
>   .../ref-manual/system-requirements.rst        | 10 ++++-----
>   2 files changed, 13 insertions(+), 18 deletions(-)


LGTM, thanks Michael!

../Randy

>
> diff --git a/documentation/poky.yaml.in b/documentation/poky.yaml.in
> index cdccf6f3ca..44654aa62f 100644
> --- a/documentation/poky.yaml.in
> +++ b/documentation/poky.yaml.in
> @@ -13,33 +13,28 @@ 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 libegl1-mesa libsdl1.2-dev \
> -     python3-subunit mesa-common-dev zstd liblz4-tool"
> +     python3-subunit mesa-common-dev zstd liblz4-tool file locales
> +     \n\      $ sudo locale-gen en_US.UTF-8"
>   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 SDL-devel rpcgen mesa-libGL-devel perl-FindBin perl-File-Compare \
> -     perl-File-Copy perl-locale zstd lz4"
> +     perl-File-Copy perl-locale zstd lz4 hostname glibc-langpack-en"
>   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 Mesa-libEGL1 libSDL-devel rpcgen Mesa-dri-devel \
> -     zstd lz4
> +     zstd lz4 bzip2 gzip hostname
>        \n\      $ sudo pip3 install GitPython"
> -CENTOS7_HOST_PACKAGES_ESSENTIAL : "-y epel-release
> -     \n\      $ sudo yum makecache
> -     \n\      $ sudo yum install gawk make wget tar bzip2 gzip python3 unzip perl patch \
> -     diffutils diffstat git cpp gcc gcc-c++ glibc-devel texinfo chrpath socat \
> -     perl-Data-Dumper perl-Text-ParseWords perl-Thread-Queue python3-pip xz \
> -     which SDL-devel mesa-libGL-devel zstd lz4
> -     \n\      $ sudo pip3 install GitPython jinja2"
> -CENTOS8_HOST_PACKAGES_ESSENTIAL : "-y epel-release
> -     \n\      $ sudo dnf config-manager --set-enabled PowerTools
> +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 SDL-devel \
> -     rpcgen mesa-libGL-devel zstd lz4"
> +     rpcgen mesa-libGL-devel zstd lz4 cpio glibc-langpack-en"
>   PIP3_HOST_PACKAGES_DOC : "$ sudo pip3 install sphinx sphinx_rtd_theme pyyaml"
>   MIN_PYTHON_VERSION : "3.8.0"
>   MIN_TAR_VERSION : "1.28"
> diff --git a/documentation/ref-manual/system-requirements.rst b/documentation/ref-manual/system-requirements.rst
> index 38d4aaf5a7..1bbe7b894d 100644
> --- a/documentation/ref-manual/system-requirements.rst
> +++ b/documentation/ref-manual/system-requirements.rst
> @@ -168,16 +168,16 @@ supported openSUSE Linux distribution:
>         &PIP3_HOST_PACKAGES_DOC;
>   
>   
> -AlmaLinux-8 Packages
> ---------------------
> +AlmaLinux Packages
> +------------------
>   
>   Here are the required packages by function given a
> -supported AlmaLinux-8 Linux distribution:
> +supported AlmaLinux Linux distribution:
>   
>   -  *Essentials:* Packages needed to build an image for a headless
>      system::
>   
> -      $ sudo dnf install &CENTOS8_HOST_PACKAGES_ESSENTIAL;
> +      $ sudo dnf install &ALMALINUX8_HOST_PACKAGES_ESSENTIAL;
>   
>      .. note::
>   
> @@ -186,7 +186,7 @@ supported AlmaLinux-8 Linux distribution:
>            easy installation of packages not included in enterprise Linux
>            by default. You need to install these packages separately.
>   
> -      -  The ``PowerTools`` repo provides additional packages such as
> +      -  The ``PowerTools/CRB`` repo provides additional packages such as
>            ``rpcgen`` and ``texinfo``.
>   
>         -  The ``makecache`` command consumes additional Metadata from


-- 
# Randy MacLeod
# Wind River Linux

[-- Attachment #2: Type: text/html, Size: 6316 bytes --]