diff options
Diffstat (limited to 'documentation/ref-manual/system-requirements.rst')
-rw-r--r-- | documentation/ref-manual/system-requirements.rst | 130 |
1 files changed, 102 insertions, 28 deletions
diff --git a/documentation/ref-manual/system-requirements.rst b/documentation/ref-manual/system-requirements.rst index 0fc92550a5..14b635013b 100644 --- a/documentation/ref-manual/system-requirements.rst +++ b/documentation/ref-manual/system-requirements.rst | |||
@@ -58,24 +58,34 @@ Supported Linux Distributions | |||
58 | Currently, the &DISTRO; release ("&DISTRO_NAME;") of the Yocto Project is | 58 | Currently, the &DISTRO; release ("&DISTRO_NAME;") of the Yocto Project is |
59 | supported on the following distributions: | 59 | supported on the following distributions: |
60 | 60 | ||
61 | - Ubuntu 20.04 (LTS) | ||
62 | |||
63 | - Ubuntu 22.04 (LTS) | 61 | - Ubuntu 22.04 (LTS) |
64 | 62 | ||
65 | - Fedora 38 | 63 | - Ubuntu 24.04 (LTS) |
64 | |||
65 | - Ubuntu 24.10 | ||
66 | |||
67 | - Fedora 39 | ||
66 | 68 | ||
67 | - CentOS Stream 8 | 69 | - Fedora 40 |
70 | |||
71 | - Fedora 41 | ||
72 | |||
73 | - CentOS Stream 9 | ||
68 | 74 | ||
69 | - Debian GNU/Linux 11 (Bullseye) | 75 | - Debian GNU/Linux 11 (Bullseye) |
70 | 76 | ||
71 | - Debian GNU/Linux 12 (Bookworm) | 77 | - Debian GNU/Linux 12 (Bookworm) |
72 | 78 | ||
73 | - OpenSUSE Leap 15.4 | 79 | - OpenSUSE Leap 15.5 |
80 | |||
81 | - OpenSUSE Leap 15.6 | ||
74 | 82 | ||
75 | - AlmaLinux 8 | 83 | - AlmaLinux 8 |
76 | 84 | ||
77 | - AlmaLinux 9 | 85 | - AlmaLinux 9 |
78 | 86 | ||
87 | - Rocky 8 | ||
88 | |||
79 | - Rocky 9 | 89 | - Rocky 9 |
80 | 90 | ||
81 | The following distribution versions are still tested, even though the | 91 | The following distribution versions are still tested, even though the |
@@ -83,11 +93,15 @@ organizations publishing them no longer make updates publicly available: | |||
83 | 93 | ||
84 | - Ubuntu 18.04 (LTS) | 94 | - Ubuntu 18.04 (LTS) |
85 | 95 | ||
96 | - Ubuntu 20.04 (LTS) | ||
97 | |||
86 | - Ubuntu 23.04 | 98 | - Ubuntu 23.04 |
87 | 99 | ||
88 | Note that the Yocto Project doesn't have access to private updates | 100 | Note that the Yocto Project doesn't have access to private updates |
89 | that some of these versions may have. Therefore, our testing has | 101 | that some of these versions may have. Therefore, our testing has |
90 | limited value if you have access to such updates. | 102 | limited value if you have access to such updates. Also, :term:`buildtools` |
103 | may have to be used on older releases in order to get current enough | ||
104 | tools, such as python. | ||
91 | 105 | ||
92 | Finally, here are the distribution versions which were previously | 106 | Finally, here are the distribution versions which were previously |
93 | tested on former revisions of "&DISTRO_NAME;", but no longer are: | 107 | tested on former revisions of "&DISTRO_NAME;", but no longer are: |
@@ -131,7 +145,7 @@ tested on former revisions of "&DISTRO_NAME;", but no longer are: | |||
131 | interested in hearing about your experience. For information on | 145 | interested in hearing about your experience. For information on |
132 | how to submit a bug, see the Yocto Project | 146 | how to submit a bug, see the Yocto Project |
133 | :yocto_wiki:`Bugzilla wiki page </Bugzilla_Configuration_and_Bug_Tracking>` | 147 | :yocto_wiki:`Bugzilla wiki page </Bugzilla_Configuration_and_Bug_Tracking>` |
134 | and the ":doc:`../contributor-guide/report-defect`" | 148 | and the ":doc:`/contributor-guide/report-defect`" |
135 | section in the Yocto Project and OpenEmbedded Contributor Guide. | 149 | section in the Yocto Project and OpenEmbedded Contributor Guide. |
136 | 150 | ||
137 | Required Packages for the Build Host | 151 | Required Packages for the Build Host |
@@ -148,12 +162,30 @@ Ubuntu and Debian | |||
148 | ----------------- | 162 | ----------------- |
149 | 163 | ||
150 | Here are the packages needed to build an image on a headless system | 164 | Here are the packages needed to build an image on a headless system |
151 | with a supported Ubuntu or Debian Linux distribution:: | 165 | with a supported Ubuntu or Debian Linux distribution: |
166 | |||
167 | .. literalinclude:: ../tools/host_packages_scripts/ubuntu_essential.sh | ||
168 | :language: shell | ||
169 | |||
170 | You also need to ensure you have the ``en_US.UTF-8`` locale enabled:: | ||
171 | |||
172 | $ locale --all-locales | grep en_US.utf8 | ||
173 | |||
174 | If this is not the case, you can reconfigure the ``locales`` package to add it | ||
175 | (requires an interactive shell):: | ||
152 | 176 | ||
153 | $ sudo apt install &UBUNTU_HOST_PACKAGES_ESSENTIAL; | 177 | $ sudo dpkg-reconfigure locales |
154 | 178 | ||
155 | .. note:: | 179 | .. note:: |
156 | 180 | ||
181 | - If you are not in an interactive shell, ``dpkg-reconfigure`` will | ||
182 | not work as expected. To add the locale you will need to edit | ||
183 | ``/etc/locale.gen`` file to add/uncomment the ``en_US.UTF-8`` locale. | ||
184 | A naive way to do this as root is:: | ||
185 | |||
186 | $ echo "en_US.UTF-8 UTF-8" >> /etc/locale.gen | ||
187 | $ locale-gen | ||
188 | |||
157 | - If your build system has the ``oss4-dev`` package installed, you | 189 | - If your build system has the ``oss4-dev`` package installed, you |
158 | might experience QEMU build failures due to the package installing | 190 | might experience QEMU build failures due to the package installing |
159 | its own custom ``/usr/include/linux/soundcard.h`` on the Debian | 191 | its own custom ``/usr/include/linux/soundcard.h`` on the Debian |
@@ -162,45 +194,71 @@ with a supported Ubuntu or Debian Linux distribution:: | |||
162 | $ sudo apt build-dep qemu | 194 | $ sudo apt build-dep qemu |
163 | $ sudo apt remove oss4-dev | 195 | $ sudo apt remove oss4-dev |
164 | 196 | ||
165 | Here are the packages needed to build Project documentation manuals:: | 197 | Here are the packages needed to build Project documentation manuals: |
198 | |||
199 | .. literalinclude:: ../tools/host_packages_scripts/ubuntu_docs.sh | ||
200 | :language: shell | ||
201 | |||
202 | In addition to the previous packages, here are the packages needed to build the | ||
203 | documentation in PDF format: | ||
166 | 204 | ||
167 | $ sudo apt install git make inkscape texlive-latex-extra | 205 | .. literalinclude:: ../tools/host_packages_scripts/ubuntu_docs_pdf.sh |
168 | $ sudo apt install sphinx python3-saneyaml python3-sphinx-rtd-theme | 206 | :language: shell |
169 | 207 | ||
170 | Fedora Packages | 208 | Fedora Packages |
171 | --------------- | 209 | --------------- |
172 | 210 | ||
173 | Here are the packages needed to build an image on a headless system | 211 | Here are the packages needed to build an image on a headless system |
174 | with a supported Fedora Linux distribution:: | 212 | with a supported Fedora Linux distribution: |
213 | |||
214 | .. literalinclude:: ../tools/host_packages_scripts/fedora_essential.sh | ||
215 | :language: shell | ||
216 | |||
217 | Here are the packages needed to build Project documentation manuals: | ||
218 | |||
219 | .. literalinclude:: ../tools/host_packages_scripts/fedora_docs.sh | ||
220 | :language: shell | ||
175 | 221 | ||
176 | $ sudo dnf install &FEDORA_HOST_PACKAGES_ESSENTIAL; | 222 | .. literalinclude:: ../tools/host_packages_scripts/pip3_docs.sh |
223 | :language: shell | ||
177 | 224 | ||
178 | Here are the packages needed to build Project documentation manuals:: | 225 | In addition to the previous packages, here are the packages needed to build the |
226 | documentation in PDF format: | ||
179 | 227 | ||
180 | $ sudo dnf install git make python3-pip which inkscape texlive-fncychap | 228 | .. literalinclude:: ../tools/host_packages_scripts/fedora_docs_pdf.sh |
181 | &PIP3_HOST_PACKAGES_DOC; | 229 | :language: shell |
182 | 230 | ||
183 | openSUSE Packages | 231 | openSUSE Packages |
184 | ----------------- | 232 | ----------------- |
185 | 233 | ||
186 | Here are the packages needed to build an image on a headless system | 234 | Here are the packages needed to build an image on a headless system |
187 | with a supported openSUSE distribution:: | 235 | with a supported openSUSE distribution: |
188 | 236 | ||
189 | $ sudo zypper install &OPENSUSE_HOST_PACKAGES_ESSENTIAL; | 237 | .. literalinclude:: ../tools/host_packages_scripts/opensuse_essential.sh |
238 | :language: shell | ||
190 | 239 | ||
191 | Here are the packages needed to build Project documentation manuals:: | 240 | Here are the packages needed to build Project documentation manuals: |
192 | 241 | ||
193 | $ sudo zypper install git make python3-pip which inkscape texlive-fncychap | 242 | .. literalinclude:: ../tools/host_packages_scripts/opensuse_docs.sh |
194 | &PIP3_HOST_PACKAGES_DOC; | 243 | :language: shell |
195 | 244 | ||
245 | .. literalinclude:: ../tools/host_packages_scripts/pip3_docs.sh | ||
246 | :language: shell | ||
247 | |||
248 | In addition to the previous packages, here are the packages needed to build the | ||
249 | documentation in PDF format: | ||
250 | |||
251 | .. literalinclude:: ../tools/host_packages_scripts/opensuse_docs_pdf.sh | ||
252 | :language: shell | ||
196 | 253 | ||
197 | AlmaLinux Packages | 254 | AlmaLinux Packages |
198 | ------------------ | 255 | ------------------ |
199 | 256 | ||
200 | Here are the packages needed to build an image on a headless system | 257 | Here are the packages needed to build an image on a headless system |
201 | with a supported AlmaLinux distribution:: | 258 | with a supported AlmaLinux distribution: |
202 | 259 | ||
203 | $ sudo dnf install &ALMALINUX_HOST_PACKAGES_ESSENTIAL; | 260 | .. literalinclude:: ../tools/host_packages_scripts/almalinux_essential.sh |
261 | :language: shell | ||
204 | 262 | ||
205 | .. note:: | 263 | .. note:: |
206 | 264 | ||
@@ -215,10 +273,26 @@ with a supported AlmaLinux distribution:: | |||
215 | - The ``makecache`` command consumes additional Metadata from | 273 | - The ``makecache`` command consumes additional Metadata from |
216 | ``epel-release``. | 274 | ``epel-release``. |
217 | 275 | ||
218 | Here are the packages needed to build Project documentation manuals:: | 276 | Here are the packages needed to build Project documentation manuals: |
277 | |||
278 | .. literalinclude:: ../tools/host_packages_scripts/almalinux_docs.sh | ||
279 | :language: shell | ||
280 | |||
281 | .. literalinclude:: ../tools/host_packages_scripts/pip3_docs.sh | ||
282 | :language: shell | ||
283 | |||
284 | .. warning:: | ||
285 | |||
286 | Unlike Fedora or OpenSUSE, AlmaLinux does not provide the packages | ||
287 | ``texlive-collection-fontsextra``, ``texlive-collection-lang*`` and | ||
288 | ``texlive-collection-latexextra``, so you may run into issues. These may be | ||
289 | installed using `tlmgr <https://tug.org/texlive/tlmgr.html>`_. | ||
290 | |||
291 | In addition to the previous packages, here are the packages needed to build the | ||
292 | documentation in PDF format: | ||
219 | 293 | ||
220 | $ sudo dnf install git make python3-pip which inkscape texlive-fncychap | 294 | .. literalinclude:: ../tools/host_packages_scripts/almalinux_docs_pdf.sh |
221 | &PIP3_HOST_PACKAGES_DOC; | 295 | :language: shell |
222 | 296 | ||
223 | .. _system-requirements-buildtools: | 297 | .. _system-requirements-buildtools: |
224 | 298 | ||
@@ -319,7 +393,7 @@ If you would prefer not to use the ``install-buildtools`` script, you can instea | |||
319 | download and run a pre-built :term:`buildtools` installer yourself with the following | 393 | download and run a pre-built :term:`buildtools` installer yourself with the following |
320 | steps: | 394 | steps: |
321 | 395 | ||
322 | #. Go to :yocto_dl:`/releases/yocto/yocto-&DISTRO;/buildtools/`, locate and | 396 | #. Go to :yocto_dl:`/releases/yocto/&DISTRO_REL_LATEST_TAG;/buildtools/`, locate and |
323 | download the ``.sh`` file corresponding to your host architecture | 397 | download the ``.sh`` file corresponding to your host architecture |
324 | and to :term:`buildtools`, :term:`buildtools-extended` or :term:`buildtools-make`. | 398 | and to :term:`buildtools`, :term:`buildtools-extended` or :term:`buildtools-make`. |
325 | 399 | ||