summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual
diff options
context:
space:
mode:
authorAntonin Godard <antonin.godard@bootlin.com>2024-12-10 11:00:24 +0100
committerRichard Purdie <richard.purdie@linuxfoundation.org>2024-12-16 11:04:53 +0000
commit783347d27b179d85098dc2166bc8234a08b7811b (patch)
treef5ccf56c2bf05cf668889b8e5b98f72d515372b0 /documentation/ref-manual
parent8c7e7f6805d97e544a98fae067c4126f57680d9a (diff)
downloadpoky-783347d27b179d85098dc2166bc8234a08b7811b.tar.gz
system-requirements.rst: add dependencies for pdf builds
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). Move the texlive-fncychap documentation dependency to the PDF specific dependency. 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. (From yocto-docs rev: 02c090718ac602f7d4760dd28dadbf0631668d49) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/ref-manual')
-rw-r--r--documentation/ref-manual/system-requirements.rst27
1 files changed, 27 insertions, 0 deletions
diff --git a/documentation/ref-manual/system-requirements.rst b/documentation/ref-manual/system-requirements.rst
index 7c7f518d9f..b087d374d2 100644
--- a/documentation/ref-manual/system-requirements.rst
+++ b/documentation/ref-manual/system-requirements.rst
@@ -193,6 +193,11 @@ Here are the packages needed to build Project documentation manuals::
193 193
194 $ sudo apt install &UBUNTU_DEBIAN_HOST_PACKAGES_DOC; 194 $ sudo apt install &UBUNTU_DEBIAN_HOST_PACKAGES_DOC;
195 195
196In addition to the previous packages, here are the packages needed to build the
197documentation in PDF format::
198
199 $ sudo apt install &UBUNTU_DEBIAN_HOST_PACKAGES_DOC_PDF;
200
196Fedora Packages 201Fedora Packages
197--------------- 202---------------
198 203
@@ -206,6 +211,11 @@ Here are the packages needed to build Project documentation manuals::
206 $ sudo dnf install &FEDORA_HOST_PACKAGES_DOC; 211 $ sudo dnf install &FEDORA_HOST_PACKAGES_DOC;
207 $ sudo pip3 install &PIP3_HOST_PACKAGES_DOC; 212 $ sudo pip3 install &PIP3_HOST_PACKAGES_DOC;
208 213
214In addition to the previous packages, here are the packages needed to build the
215documentation in PDF format::
216
217 $ sudo dnf install &FEDORA_HOST_PACKAGES_DOC_PDF;
218
209openSUSE Packages 219openSUSE Packages
210----------------- 220-----------------
211 221
@@ -220,6 +230,11 @@ Here are the packages needed to build Project documentation manuals::
220 $ sudo zypper install &OPENSUSE_HOST_PACKAGES_DOC; 230 $ sudo zypper install &OPENSUSE_HOST_PACKAGES_DOC;
221 $ sudo pip3 install &PIP3_HOST_PACKAGES_DOC; 231 $ sudo pip3 install &PIP3_HOST_PACKAGES_DOC;
222 232
233In addition to the previous packages, here are the packages needed to build the
234documentation in PDF format::
235
236 $ sudo zypper install &OPENSUSE_HOST_PACKAGES_DOC_PDF;
237
223 238
224AlmaLinux Packages 239AlmaLinux Packages
225------------------ 240------------------
@@ -251,6 +266,18 @@ Here are the packages needed to build Project documentation manuals::
251 $ sudo dnf install &ALMALINUX_HOST_PACKAGES_DOC; 266 $ sudo dnf install &ALMALINUX_HOST_PACKAGES_DOC;
252 $ sudo pip3 install &PIP3_HOST_PACKAGES_DOC; 267 $ sudo pip3 install &PIP3_HOST_PACKAGES_DOC;
253 268
269In addition to the previous packages, here are the packages needed to build the
270documentation in PDF format::
271
272 $ sudo dnf install &ALMALINUX_HOST_PACKAGES_DOC_PDF;
273
274.. warning::
275
276 Unlike Fedora or OpenSUSE, AlmaLinux does not provide the packages
277 ``texlive-collection-fontsextra``, ``texlive-collection-lang*`` and
278 ``texlive-collection-latexextra``, so you may run into issues. These may be
279 installed using `tlmgr <https://tug.org/texlive/tlmgr.html>`_.
280
254.. _system-requirements-buildtools: 281.. _system-requirements-buildtools:
255 282
256Required Git, tar, Python, make and gcc Versions 283Required Git, tar, Python, make and gcc Versions