diff options
| author | Antonin Godard <antonin.godard@bootlin.com> | 2024-12-10 11:00:19 +0100 |
|---|---|---|
| committer | Steve Sakoman <steve@sakoman.com> | 2024-12-16 05:58:03 -0800 |
| commit | 1a65cc847f72c39ef40f2c58d23a90b3e6f9d931 (patch) | |
| tree | 6a14d20752886c9d82bc022bd16d411437a956d3 /documentation | |
| parent | 0bee34892d744458a5ed95550febfebd34d67c50 (diff) | |
| download | poky-1a65cc847f72c39ef40f2c58d23a90b3e6f9d931.tar.gz | |
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: 580b410c535f3b24f901cdbf011bf817038ba4c3)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit 1ed6118b7cf1b5dcbfca753c83fa30fb97bf44ad)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
Diffstat (limited to 'documentation')
| -rw-r--r-- | documentation/brief-yoctoprojectqs/index.rst | 2 | ||||
| -rw-r--r-- | documentation/poky.yaml.in | 213 | ||||
| -rw-r--r-- | documentation/ref-manual/system-requirements.rst | 22 |
3 files changed, 202 insertions, 35 deletions
diff --git a/documentation/brief-yoctoprojectqs/index.rst b/documentation/brief-yoctoprojectqs/index.rst index df9e7eadfb..3460a7437f 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 | |||
| 78 | following command installs the host packages based on an Ubuntu | 78 | following command installs the host packages based on an Ubuntu |
| 79 | distribution:: | 79 | distribution:: |
| 80 | 80 | ||
| 81 | $ sudo apt install &UBUNTU_HOST_PACKAGES_ESSENTIAL; | 81 | $ sudo apt install &UBUNTU_DEBIAN_HOST_PACKAGES_ESSENTIAL; |
| 82 | 82 | ||
| 83 | .. note:: | 83 | .. note:: |
| 84 | 84 | ||
diff --git a/documentation/poky.yaml.in b/documentation/poky.yaml.in index d9a0cc4d61..ccec88792a 100644 --- a/documentation/poky.yaml.in +++ b/documentation/poky.yaml.in | |||
| @@ -1,3 +1,7 @@ | |||
| 1 | # | ||
| 2 | # Macros used in the documentation | ||
| 3 | # | ||
| 4 | |||
| 1 | DISTRO : "4.0" | 5 | DISTRO : "4.0" |
| 2 | DISTRO_NAME_NO_CAP : "kirkstone" | 6 | DISTRO_NAME_NO_CAP : "kirkstone" |
| 3 | DISTRO_NAME : "Kirkstone" | 7 | DISTRO_NAME : "Kirkstone" |
| @@ -10,31 +14,6 @@ BITBAKE_SERIES : "" | |||
| 10 | YOCTO_DL_URL : "https://downloads.yoctoproject.org" | 14 | YOCTO_DL_URL : "https://downloads.yoctoproject.org" |
| 11 | YOCTO_AB_URL : "https://autobuilder.yoctoproject.org" | 15 | YOCTO_AB_URL : "https://autobuilder.yoctoproject.org" |
| 12 | YOCTO_RELEASE_DL_URL : "&YOCTO_DL_URL;/releases/yocto/yocto-&DISTRO;" | 16 | YOCTO_RELEASE_DL_URL : "&YOCTO_DL_URL;/releases/yocto/yocto-&DISTRO;" |
| 13 | UBUNTU_HOST_PACKAGES_ESSENTIAL : "gawk wget git diffstat unzip texinfo gcc \ | ||
| 14 | build-essential chrpath socat cpio python3 python3-pip python3-pexpect \ | ||
| 15 | xz-utils debianutils iputils-ping python3-git python3-jinja2 \ | ||
| 16 | python3-subunit zstd liblz4-tool file locales libacl1" | ||
| 17 | FEDORA_HOST_PACKAGES_ESSENTIAL : "gawk make wget tar bzip2 gzip python3 unzip perl patch \ | ||
| 18 | diffutils diffstat git cpp gcc gcc-c++ glibc-devel texinfo chrpath \ | ||
| 19 | ccache perl-Data-Dumper perl-Text-ParseWords perl-Thread-Queue perl-bignum socat \ | ||
| 20 | python3-pexpect findutils which file cpio python python3-pip xz python3-GitPython \ | ||
| 21 | python3-jinja2 rpcgen perl-FindBin perl-File-Compare \ | ||
| 22 | perl-File-Copy perl-locale zstd lz4 hostname glibc-langpack-en libacl" | ||
| 23 | OPENSUSE_HOST_PACKAGES_ESSENTIAL : "python gcc gcc-c++ git chrpath make wget python-xml \ | ||
| 24 | diffstat makeinfo python-curses patch socat python3 python3-curses tar python3-pip \ | ||
| 25 | python3-pexpect xz which python3-Jinja2 rpcgen \ | ||
| 26 | zstd lz4 bzip2 gzip hostname libacl1 | ||
| 27 | \n\ $ sudo pip3 install GitPython" | ||
| 28 | ALMALINUX_HOST_PACKAGES_ESSENTIAL : "-y epel-release | ||
| 29 | \n\ $ sudo yum install dnf-plugins-core | ||
| 30 | \n\ $ sudo dnf config-manager --set-enabled crb | ||
| 31 | \n\ $ sudo dnf makecache | ||
| 32 | \n\ $ sudo dnf install gawk make wget tar bzip2 gzip python3 unzip perl patch \ | ||
| 33 | diffutils diffstat git cpp gcc gcc-c++ glibc-devel texinfo chrpath ccache \ | ||
| 34 | socat perl-Data-Dumper perl-Text-ParseWords perl-Thread-Queue python3-pip \ | ||
| 35 | python3-GitPython python3-jinja2 python3-pexpect xz which \ | ||
| 36 | rpcgen zstd lz4 cpio glibc-langpack-en libacl" | ||
| 37 | PIP3_HOST_PACKAGES_DOC : "$ sudo pip3 install sphinx sphinx_rtd_theme pyyaml" | ||
| 38 | MIN_PYTHON_VERSION : "3.6.0" | 17 | MIN_PYTHON_VERSION : "3.6.0" |
| 39 | MIN_TAR_VERSION : "1.28" | 18 | MIN_TAR_VERSION : "1.28" |
| 40 | MIN_GIT_VERSION : "1.8.3.1" | 19 | MIN_GIT_VERSION : "1.8.3.1" |
| @@ -46,3 +25,187 @@ MIN_DISK_SPACE : "90" | |||
| 46 | MIN_DISK_SPACE_RM_WORK : "40" | 25 | MIN_DISK_SPACE_RM_WORK : "40" |
| 47 | # RAM (Gbytes) needed to generate qemux86-64 core-image-sato on Ubuntu 22.04 (x86-64) on a 4 core system | 26 | # RAM (Gbytes) needed to generate qemux86-64 core-image-sato on Ubuntu 22.04 (x86-64) on a 4 core system |
| 48 | MIN_RAM : "8" | 27 | MIN_RAM : "8" |
| 28 | |||
| 29 | # | ||
| 30 | # Dependencies | ||
| 31 | # | ||
| 32 | |||
| 33 | # Shared between distros | ||
| 34 | PIP3_HOST_PACKAGES_DOC: sphinx sphinx_rtd_theme pyyaml | ||
| 35 | |||
| 36 | UBUNTU_DEBIAN_HOST_PACKAGES_ESSENTIAL: >- | ||
| 37 | build-essential | ||
| 38 | chrpath | ||
| 39 | cpio | ||
| 40 | debianutils | ||
| 41 | diffstat | ||
| 42 | file | ||
| 43 | gawk | ||
| 44 | gcc | ||
| 45 | git | ||
| 46 | iputils-ping | ||
| 47 | libacl1 | ||
| 48 | liblz4-tool | ||
| 49 | locales | ||
| 50 | python3 | ||
| 51 | python3-git | ||
| 52 | python3-jinja2 | ||
| 53 | python3-pexpect | ||
| 54 | python3-pip | ||
| 55 | python3-subunit | ||
| 56 | socat | ||
| 57 | texinfo | ||
| 58 | unzip | ||
| 59 | wget | ||
| 60 | xz-utils | ||
| 61 | zstd | ||
| 62 | |||
| 63 | UBUNTU_DEBIAN_HOST_PACKAGES_DOC: >- | ||
| 64 | git | ||
| 65 | inkscape | ||
| 66 | make | ||
| 67 | python3-saneyaml | ||
| 68 | python3-sphinx-rtd-theme | ||
| 69 | sphinx | ||
| 70 | texlive-latex-extra | ||
| 71 | |||
| 72 | FEDORA_HOST_PACKAGES_ESSENTIAL: >- | ||
| 73 | bzip2 | ||
| 74 | ccache | ||
| 75 | chrpath | ||
| 76 | cpio | ||
| 77 | cpp | ||
| 78 | diffstat | ||
| 79 | diffutils | ||
| 80 | file | ||
| 81 | findutils | ||
| 82 | gawk | ||
| 83 | gcc | ||
| 84 | gcc-c++ | ||
| 85 | git | ||
| 86 | glibc-devel | ||
| 87 | glibc-langpack-en | ||
| 88 | gzip | ||
| 89 | hostname | ||
| 90 | libacl | ||
| 91 | lz4 | ||
| 92 | make | ||
| 93 | patch | ||
| 94 | perl | ||
| 95 | perl-Data-Dumper | ||
| 96 | perl-File-Compare | ||
| 97 | perl-File-Copy | ||
| 98 | perl-FindBin | ||
| 99 | perl-Text-ParseWords | ||
| 100 | perl-Thread-Queue | ||
| 101 | perl-bignum | ||
| 102 | perl-locale | ||
| 103 | python | ||
| 104 | python3 | ||
| 105 | python3-GitPython | ||
| 106 | python3-jinja2 | ||
| 107 | python3-pexpect | ||
| 108 | python3-pip | ||
| 109 | rpcgen | ||
| 110 | socat | ||
| 111 | tar | ||
| 112 | texinfo | ||
| 113 | unzip | ||
| 114 | wget | ||
| 115 | which | ||
| 116 | xz | ||
| 117 | zstd | ||
| 118 | |||
| 119 | FEDORA_HOST_PACKAGES_DOC: >- | ||
| 120 | git | ||
| 121 | inkscape | ||
| 122 | make | ||
| 123 | python3-pip | ||
| 124 | texlive-fncychap | ||
| 125 | which | ||
| 126 | |||
| 127 | OPENSUSE_HOST_PACKAGES_ESSENTIAL: >- | ||
| 128 | bzip2 | ||
| 129 | chrpath | ||
| 130 | diffstat | ||
| 131 | gcc | ||
| 132 | gcc-c++ | ||
| 133 | git | ||
| 134 | gzip | ||
| 135 | hostname | ||
| 136 | libacl1 | ||
| 137 | lz4 | ||
| 138 | make | ||
| 139 | makeinfo | ||
| 140 | patch | ||
| 141 | python | ||
| 142 | python-curses | ||
| 143 | python-xml | ||
| 144 | python3 | ||
| 145 | python3-Jinja2 | ||
| 146 | python3-curses | ||
| 147 | python3-pexpect | ||
| 148 | python3-pip | ||
| 149 | rpcgen | ||
| 150 | socat | ||
| 151 | tar | ||
| 152 | wget | ||
| 153 | which | ||
| 154 | xz | ||
| 155 | zstd | ||
| 156 | |||
| 157 | OPENSUSE_PIP3_HOST_PACKAGES_ESSENTIAL: GitPython | ||
| 158 | |||
| 159 | OPENSUSE_HOST_PACKAGES_DOC: >- | ||
| 160 | git | ||
| 161 | inkscape | ||
| 162 | make | ||
| 163 | python3-pip | ||
| 164 | texlive-fncychap | ||
| 165 | which | ||
| 166 | |||
| 167 | ALMALINUX_HOST_PACKAGES_ESSENTIAL: >- | ||
| 168 | bzip2 | ||
| 169 | ccache | ||
| 170 | chrpath | ||
| 171 | cpio | ||
| 172 | cpp | ||
| 173 | diffstat | ||
| 174 | diffutils | ||
| 175 | gawk | ||
| 176 | gcc | ||
| 177 | gcc-c++ | ||
| 178 | git | ||
| 179 | glibc-devel | ||
| 180 | glibc-langpack-en | ||
| 181 | gzip | ||
| 182 | libacl | ||
| 183 | lz4 | ||
| 184 | make | ||
| 185 | patch | ||
| 186 | perl | ||
| 187 | perl-Data-Dumper | ||
| 188 | perl-Text-ParseWords | ||
| 189 | perl-Thread-Queue | ||
| 190 | python3 | ||
| 191 | python3-GitPython | ||
| 192 | python3-jinja2 | ||
| 193 | python3-pexpect | ||
| 194 | python3-pip | ||
| 195 | rpcgen | ||
| 196 | socat | ||
| 197 | tar | ||
| 198 | texinfo | ||
| 199 | unzip | ||
| 200 | wget | ||
| 201 | which | ||
| 202 | xz | ||
| 203 | zstd | ||
| 204 | |||
| 205 | ALMALINUX_HOST_PACKAGES_DOC: >- | ||
| 206 | git | ||
| 207 | inkscape | ||
| 208 | make | ||
| 209 | python3-pip | ||
| 210 | texlive-fncychap | ||
| 211 | which | ||
diff --git a/documentation/ref-manual/system-requirements.rst b/documentation/ref-manual/system-requirements.rst index 5b0beab7c2..4db0d42777 100644 --- a/documentation/ref-manual/system-requirements.rst +++ b/documentation/ref-manual/system-requirements.rst | |||
| @@ -158,7 +158,7 @@ Ubuntu and Debian | |||
| 158 | Here are the packages needed to build an image on a headless system | 158 | Here are the packages needed to build an image on a headless system |
| 159 | with a supported Ubuntu or Debian Linux distribution:: | 159 | with a supported Ubuntu or Debian Linux distribution:: |
| 160 | 160 | ||
| 161 | $ sudo apt install &UBUNTU_HOST_PACKAGES_ESSENTIAL; | 161 | $ sudo apt install &UBUNTU_DEBIAN_HOST_PACKAGES_ESSENTIAL; |
| 162 | 162 | ||
| 163 | You also need to ensure you have the ``en_US.UTF-8`` locale enabled:: | 163 | You also need to ensure you have the ``en_US.UTF-8`` locale enabled:: |
| 164 | 164 | ||
| @@ -189,8 +189,7 @@ If this is not the case, you can reconfigure the ``locales`` package to add it | |||
| 189 | 189 | ||
| 190 | Here are the packages needed to build Project documentation manuals:: | 190 | Here are the packages needed to build Project documentation manuals:: |
| 191 | 191 | ||
| 192 | $ sudo apt install git make inkscape texlive-latex-extra | 192 | $ sudo apt install &UBUNTU_DEBIAN_HOST_PACKAGES_DOC; |
| 193 | $ sudo apt install sphinx python3-saneyaml python3-sphinx-rtd-theme | ||
| 194 | 193 | ||
| 195 | Fedora Packages | 194 | Fedora Packages |
| 196 | --------------- | 195 | --------------- |
| @@ -202,8 +201,8 @@ with a supported Fedora Linux distribution:: | |||
| 202 | 201 | ||
| 203 | Here are the packages needed to build Project documentation manuals:: | 202 | Here are the packages needed to build Project documentation manuals:: |
| 204 | 203 | ||
| 205 | $ sudo dnf install git make python3-pip which inkscape texlive-fncychap | 204 | $ sudo dnf install &FEDORA_HOST_PACKAGES_DOC; |
| 206 | &PIP3_HOST_PACKAGES_DOC; | 205 | $ sudo pip3 install &PIP3_HOST_PACKAGES_DOC; |
| 207 | 206 | ||
| 208 | openSUSE Packages | 207 | openSUSE Packages |
| 209 | ----------------- | 208 | ----------------- |
| @@ -212,11 +211,12 @@ Here are the packages needed to build an image on a headless system | |||
| 212 | with a supported openSUSE distribution:: | 211 | with a supported openSUSE distribution:: |
| 213 | 212 | ||
| 214 | $ sudo zypper install &OPENSUSE_HOST_PACKAGES_ESSENTIAL; | 213 | $ sudo zypper install &OPENSUSE_HOST_PACKAGES_ESSENTIAL; |
| 214 | $ sudo pip3 install &OPENSUSE_PIP3_HOST_PACKAGES_ESSENTIAL; | ||
| 215 | 215 | ||
| 216 | Here are the packages needed to build Project documentation manuals:: | 216 | Here are the packages needed to build Project documentation manuals:: |
| 217 | 217 | ||
| 218 | $ sudo zypper install git make python3-pip which inkscape texlive-fncychap | 218 | $ sudo zypper install &OPENSUSE_HOST_PACKAGES_DOC; |
| 219 | &PIP3_HOST_PACKAGES_DOC; | 219 | $ sudo pip3 install &PIP3_HOST_PACKAGES_DOC; |
| 220 | 220 | ||
| 221 | 221 | ||
| 222 | AlmaLinux Packages | 222 | AlmaLinux Packages |
| @@ -225,6 +225,10 @@ AlmaLinux Packages | |||
| 225 | Here are the packages needed to build an image on a headless system | 225 | Here are the packages needed to build an image on a headless system |
| 226 | with a supported AlmaLinux distribution:: | 226 | with a supported AlmaLinux distribution:: |
| 227 | 227 | ||
| 228 | $ sudo dnf install -y epel-release | ||
| 229 | $ sudo yum install dnf-plugins-core | ||
| 230 | $ sudo dnf config-manager --set-enabled crb | ||
| 231 | $ sudo dnf makecache | ||
| 228 | $ sudo dnf install &ALMALINUX_HOST_PACKAGES_ESSENTIAL; | 232 | $ sudo dnf install &ALMALINUX_HOST_PACKAGES_ESSENTIAL; |
| 229 | 233 | ||
| 230 | .. note:: | 234 | .. note:: |
| @@ -242,8 +246,8 @@ with a supported AlmaLinux distribution:: | |||
| 242 | 246 | ||
| 243 | Here are the packages needed to build Project documentation manuals:: | 247 | Here are the packages needed to build Project documentation manuals:: |
| 244 | 248 | ||
| 245 | $ sudo dnf install git make python3-pip which inkscape texlive-fncychap | 249 | $ sudo dnf install &ALMALINUX_HOST_PACKAGES_DOC; |
| 246 | &PIP3_HOST_PACKAGES_DOC; | 250 | $ sudo pip3 install &PIP3_HOST_PACKAGES_DOC; |
| 247 | 251 | ||
| 248 | .. _system-requirements-buildtools: | 252 | .. _system-requirements-buildtools: |
| 249 | 253 | ||
