diff options
| author | Michael Opdenacker <michael.opdenacker@bootlin.com> | 2023-03-15 18:50:10 +0100 |
|---|---|---|
| committer | Steve Sakoman <steve@sakoman.com> | 2024-03-01 05:19:55 -1000 |
| commit | f51a5fd78d3b5eddf91c2d81078584621d0fd8c5 (patch) | |
| tree | 84d21b74b5ebbb4151a66033816ecaaeffa5c394 /documentation | |
| parent | 54321fcec4a438978034d52fe98bc408f4dc0f0e (diff) | |
| download | poky-f51a5fd78d3b5eddf91c2d81078584621d0fd8c5.tar.gz | |
ref-manual: system-requirements.rst: simplify supported distro requirements
- This allows to continue sharing the updated Ubuntu/Debian requirements
with the brief-yoctoprojectqs/index.rst without indentation mismatches
(caused by using the same macro in two different contexts: in direct
text and in a bullet list).
- Update poky.yaml.in to adapt the number of spaces at the beginning
of lines.
- brief-yoctoprojectqs/index.rst: fix bad number of spaces
before quote block.
(From yocto-docs rev: 488731c09bf63fadc02ddcdd94fb3374dafce528)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
Diffstat (limited to 'documentation')
| -rw-r--r-- | documentation/brief-yoctoprojectqs/index.rst | 6 | ||||
| -rw-r--r-- | documentation/poky.yaml.in | 25 | ||||
| -rw-r--r-- | documentation/ref-manual/system-requirements.rst | 120 |
3 files changed, 48 insertions, 103 deletions
diff --git a/documentation/brief-yoctoprojectqs/index.rst b/documentation/brief-yoctoprojectqs/index.rst index f52b7fa0e0..db17437aa8 100644 --- a/documentation/brief-yoctoprojectqs/index.rst +++ b/documentation/brief-yoctoprojectqs/index.rst | |||
| @@ -76,11 +76,9 @@ Build Host Packages | |||
| 76 | 76 | ||
| 77 | You must install essential host packages on your build host. The | 77 | 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 | .. code-block:: shell | 81 | $ sudo apt install &UBUNTU_HOST_PACKAGES_ESSENTIAL; |
| 82 | |||
| 83 | $ sudo apt install &UBUNTU_HOST_PACKAGES_ESSENTIAL; | ||
| 84 | 82 | ||
| 85 | .. note:: | 83 | .. note:: |
| 86 | 84 | ||
diff --git a/documentation/poky.yaml.in b/documentation/poky.yaml.in index 8c6549d571..b9cdd844e4 100644 --- a/documentation/poky.yaml.in +++ b/documentation/poky.yaml.in | |||
| @@ -13,7 +13,8 @@ YOCTO_RELEASE_DL_URL : "&YOCTO_DL_URL;/releases/yocto/yocto-&DISTRO;" | |||
| 13 | UBUNTU_HOST_PACKAGES_ESSENTIAL : "gawk wget git diffstat unzip texinfo gcc \ | 13 | UBUNTU_HOST_PACKAGES_ESSENTIAL : "gawk wget git diffstat unzip texinfo gcc \ |
| 14 | build-essential chrpath socat cpio python3 python3-pip python3-pexpect \ | 14 | build-essential chrpath socat cpio python3 python3-pip python3-pexpect \ |
| 15 | xz-utils debianutils iputils-ping python3-git python3-jinja2 libegl1-mesa libsdl1.2-dev \ | 15 | xz-utils debianutils iputils-ping python3-git python3-jinja2 libegl1-mesa libsdl1.2-dev \ |
| 16 | pylint3 xterm python3-subunit mesa-common-dev zstd liblz4-tool" | 16 | python3-subunit mesa-common-dev zstd liblz4-tool file locales |
| 17 | \n\ $ sudo locale-gen en_US.UTF-8" | ||
| 17 | FEDORA_HOST_PACKAGES_ESSENTIAL : "gawk make wget tar bzip2 gzip python3 unzip perl patch \ | 18 | 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 | 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 | ccache perl-Data-Dumper perl-Text-ParseWords perl-Thread-Queue perl-bignum socat \ |
| @@ -22,20 +23,14 @@ FEDORA_HOST_PACKAGES_ESSENTIAL : "gawk make wget tar bzip2 gzip python3 unzip pe | |||
| 22 | perl-File-Copy perl-locale zstd lz4" | 23 | perl-File-Copy perl-locale zstd lz4" |
| 23 | OPENSUSE_HOST_PACKAGES_ESSENTIAL : "python gcc gcc-c++ git chrpath make wget python-xml \ | 24 | 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 | diffstat makeinfo python-curses patch socat python3 python3-curses tar python3-pip \ |
| 25 | python3-pexpect xz which python3-Jinja2 Mesa-libEGL1 libSDL-devel xterm rpcgen Mesa-dri-devel \ | 26 | python3-pexpect xz which python3-Jinja2 Mesa-libEGL1 libSDL-devel rpcgen Mesa-dri-devel \ |
| 26 | zstd lz4 | 27 | zstd lz4 bzip2 gzip hostname |
| 27 | \n\ $ sudo pip3 install GitPython" | 28 | \n\ $ sudo pip3 install GitPython" |
| 28 | CENTOS7_HOST_PACKAGES_ESSENTIAL : "-y epel-release | 29 | ALMALINUX_HOST_PACKAGES_ESSENTIAL : "-y epel-release |
| 29 | \n\ $ sudo yum makecache | 30 | \n\ $ sudo yum install dnf-plugins-core |
| 30 | \n\ $ sudo yum install gawk make wget tar bzip2 gzip python3 unzip perl patch \ | 31 | \n\ $ sudo dnf config-manager --set-enabled crb |
| 31 | diffutils diffstat git cpp gcc gcc-c++ glibc-devel texinfo chrpath socat \ | 32 | \n\ $ sudo dnf makecache |
| 32 | perl-Data-Dumper perl-Text-ParseWords perl-Thread-Queue python3-pip xz \ | 33 | \n\ $ sudo dnf install gawk make wget tar bzip2 gzip python3 unzip perl patch \ |
| 33 | which SDL-devel xterm mesa-libGL-devel zstd lz4 | ||
| 34 | \n\ $ sudo pip3 install GitPython jinja2" | ||
| 35 | CENTOS8_HOST_PACKAGES_ESSENTIAL : "-y epel-release | ||
| 36 | \n\ $ sudo dnf config-manager --set-enabled PowerTools | ||
| 37 | \n\ $ sudo dnf makecache | ||
| 38 | \n\ $ sudo dnf install gawk make wget tar bzip2 gzip python3 unzip perl patch \ | ||
| 39 | diffutils diffstat git cpp gcc gcc-c++ glibc-devel texinfo chrpath ccache \ | 34 | diffutils diffstat git cpp gcc gcc-c++ glibc-devel texinfo chrpath ccache \ |
| 40 | socat perl-Data-Dumper perl-Text-ParseWords perl-Thread-Queue python3-pip \ | 35 | socat perl-Data-Dumper perl-Text-ParseWords perl-Thread-Queue python3-pip \ |
| 41 | python3-GitPython python3-jinja2 python3-pexpect xz which SDL-devel xterm \ | 36 | python3-GitPython python3-jinja2 python3-pexpect xz which SDL-devel xterm \ |
diff --git a/documentation/ref-manual/system-requirements.rst b/documentation/ref-manual/system-requirements.rst index 8499c1b1e8..c5fe4da036 100644 --- a/documentation/ref-manual/system-requirements.rst +++ b/documentation/ref-manual/system-requirements.rst | |||
| @@ -155,8 +155,10 @@ function. | |||
| 155 | Ubuntu and Debian | 155 | Ubuntu and Debian |
| 156 | ----------------- | 156 | ----------------- |
| 157 | 157 | ||
| 158 | Here are the required packages by function given a | 158 | Here are the packages needed to build an image on a headless system |
| 159 | supported Ubuntu or Debian Linux distribution: | 159 | with a supported Ubuntu or Debian Linux distribution:: |
| 160 | |||
| 161 | $ sudo apt install &UBUNTU_HOST_PACKAGES_ESSENTIAL; | ||
| 160 | 162 | ||
| 161 | .. note:: | 163 | .. note:: |
| 162 | 164 | ||
| @@ -168,21 +170,10 @@ supported Ubuntu or Debian Linux distribution: | |||
| 168 | $ sudo apt build-dep qemu | 170 | $ sudo apt build-dep qemu |
| 169 | $ sudo apt remove oss4-dev | 171 | $ sudo apt remove oss4-dev |
| 170 | 172 | ||
| 171 | - For Debian-8, ``python3-git`` and ``pylint3`` are no longer | 173 | Here are the packages needed to build Project documentation manuals:: |
| 172 | available via ``apt``. | ||
| 173 | :: | ||
| 174 | |||
| 175 | $ sudo pip3 install GitPython pylint==1.9.5 | ||
| 176 | |||
| 177 | - *Essentials:* Packages needed to build an image on a headless system:: | ||
| 178 | 174 | ||
| 179 | $ sudo apt install &UBUNTU_HOST_PACKAGES_ESSENTIAL; | 175 | $ sudo apt install make python3-pip inkscape texlive-latex-extra |
| 180 | 176 | &PIP3_HOST_PACKAGES_DOC; | |
| 181 | - *Documentation:* Packages needed if you are going to build out the | ||
| 182 | Yocto Project documentation manuals:: | ||
| 183 | |||
| 184 | $ sudo apt install make python3-pip | ||
| 185 | &PIP3_HOST_PACKAGES_DOC; | ||
| 186 | 177 | ||
| 187 | .. note:: | 178 | .. note:: |
| 188 | 179 | ||
| @@ -193,94 +184,55 @@ supported Ubuntu or Debian Linux distribution: | |||
| 193 | Fedora Packages | 184 | Fedora Packages |
| 194 | --------------- | 185 | --------------- |
| 195 | 186 | ||
| 196 | Here are the required packages by function given a | 187 | Here are the packages needed to build an image on a headless system |
| 197 | supported Fedora Linux distribution: | 188 | with a supported Fedora Linux distribution:: |
| 198 | |||
| 199 | - *Essentials:* Packages needed to build an image for a headless | ||
| 200 | system:: | ||
| 201 | 189 | ||
| 202 | $ sudo dnf install &FEDORA_HOST_PACKAGES_ESSENTIAL; | 190 | $ sudo dnf install &FEDORA_HOST_PACKAGES_ESSENTIAL; |
| 203 | 191 | ||
| 204 | - *Documentation:* Packages needed if you are going to build out the | 192 | Here are the packages needed to build Project documentation manuals:: |
| 205 | Yocto Project documentation manuals:: | ||
| 206 | 193 | ||
| 207 | $ sudo dnf install make python3-pip which | 194 | $ sudo dnf install make python3-pip which inkscape texlive-fncychap |
| 208 | &PIP3_HOST_PACKAGES_DOC; | 195 | &PIP3_HOST_PACKAGES_DOC; |
| 209 | 196 | ||
| 210 | openSUSE Packages | 197 | openSUSE Packages |
| 211 | ----------------- | 198 | ----------------- |
| 212 | 199 | ||
| 213 | Here are the required packages by function given a | 200 | Here are the packages needed to build an image on a headless system |
| 214 | supported openSUSE Linux distribution: | 201 | with a supported openSUSE distribution:: |
| 215 | |||
| 216 | - *Essentials:* Packages needed to build an image for a headless | ||
| 217 | system:: | ||
| 218 | |||
| 219 | $ sudo zypper install &OPENSUSE_HOST_PACKAGES_ESSENTIAL; | ||
| 220 | |||
| 221 | - *Documentation:* Packages needed if you are going to build out the | ||
| 222 | Yocto Project documentation manuals:: | ||
| 223 | |||
| 224 | $ sudo zypper install make python3-pip which | ||
| 225 | &PIP3_HOST_PACKAGES_DOC; | ||
| 226 | |||
| 227 | |||
| 228 | CentOS-7 Packages | ||
| 229 | ----------------- | ||
| 230 | |||
| 231 | Here are the required packages by function given a | ||
| 232 | supported CentOS-7 Linux distribution: | ||
| 233 | 202 | ||
| 234 | - *Essentials:* Packages needed to build an image for a headless | 203 | $ sudo zypper install &OPENSUSE_HOST_PACKAGES_ESSENTIAL; |
| 235 | system:: | ||
| 236 | 204 | ||
| 237 | $ sudo yum install &CENTOS7_HOST_PACKAGES_ESSENTIAL; | 205 | Here are the packages needed to build Project documentation manuals:: |
| 238 | 206 | ||
| 239 | .. note:: | 207 | $ sudo zypper install make python3-pip which inkscape texlive-fncychap |
| 240 | 208 | &PIP3_HOST_PACKAGES_DOC; | |
| 241 | - Extra Packages for Enterprise Linux (i.e. ``epel-release``) is | ||
| 242 | a collection of packages from Fedora built on RHEL/CentOS for | ||
| 243 | easy installation of packages not included in enterprise Linux | ||
| 244 | by default. You need to install these packages separately. | ||
| 245 | 209 | ||
| 246 | - The ``makecache`` command consumes additional Metadata from | ||
| 247 | ``epel-release``. | ||
| 248 | 210 | ||
| 249 | - *Documentation:* Packages needed if you are going to build out the | 211 | AlmaLinux Packages |
| 250 | Yocto Project documentation manuals:: | 212 | ------------------ |
| 251 | 213 | ||
| 252 | $ sudo yum install make python3-pip which | 214 | Here are the packages needed to build an image on a headless system |
| 253 | &PIP3_HOST_PACKAGES_DOC; | 215 | with a supported AlmaLinux distribution:: |
| 254 | 216 | ||
| 255 | CentOS-8 Packages | 217 | $ sudo dnf install &ALMALINUX8_HOST_PACKAGES_ESSENTIAL; |
| 256 | ----------------- | ||
| 257 | 218 | ||
| 258 | Here are the required packages by function given a | 219 | .. note:: |
| 259 | supported CentOS-8 Linux distribution: | ||
| 260 | |||
| 261 | - *Essentials:* Packages needed to build an image for a headless | ||
| 262 | system:: | ||
| 263 | |||
| 264 | $ sudo dnf install &CENTOS8_HOST_PACKAGES_ESSENTIAL; | ||
| 265 | |||
| 266 | .. note:: | ||
| 267 | 220 | ||
| 268 | - Extra Packages for Enterprise Linux (i.e. ``epel-release``) is | 221 | - Extra Packages for Enterprise Linux (i.e. ``epel-release``) is |
| 269 | a collection of packages from Fedora built on RHEL/CentOS for | 222 | a collection of packages from Fedora built on RHEL/CentOS for |
| 270 | easy installation of packages not included in enterprise Linux | 223 | easy installation of packages not included in enterprise Linux |
| 271 | by default. You need to install these packages separately. | 224 | by default. You need to install these packages separately. |
| 272 | 225 | ||
| 273 | - The ``PowerTools`` repo provides additional packages such as | 226 | - The ``PowerTools/CRB`` repo provides additional packages such as |
| 274 | ``rpcgen`` and ``texinfo``. | 227 | ``rpcgen`` and ``texinfo``. |
| 275 | 228 | ||
| 276 | - The ``makecache`` command consumes additional Metadata from | 229 | - The ``makecache`` command consumes additional Metadata from |
| 277 | ``epel-release``. | 230 | ``epel-release``. |
| 278 | 231 | ||
| 279 | - *Documentation:* Packages needed if you are going to build out the | 232 | Here are the packages needed to build Project documentation manuals:: |
| 280 | Yocto Project documentation manuals:: | ||
| 281 | 233 | ||
| 282 | $ sudo dnf install make python3-pip which | 234 | $ sudo dnf install make python3-pip which inkscape texlive-fncychap |
| 283 | &PIP3_HOST_PACKAGES_DOC; | 235 | &PIP3_HOST_PACKAGES_DOC; |
| 284 | 236 | ||
| 285 | .. _system-requirements-buildtools: | 237 | .. _system-requirements-buildtools: |
| 286 | 238 | ||
