summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual
diff options
context:
space:
mode:
authorAntonin Godard <antonin.godard@bootlin.com>2024-12-10 11:00:24 +0100
committerSteve Sakoman <steve@sakoman.com>2024-12-18 06:43:48 -0800
commitaee2a47dd999c89811647260db4170e821c04733 (patch)
tree672ef9d45f4bcd0a2013da19ea192d27f91e7102 /documentation/ref-manual
parent24c9c0a423450fb475677be3603553cdb064f757 (diff)
downloadpoky-aee2a47dd999c89811647260db4170e821c04733.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: 804240fa86fee63d0d2dd029d941cf14b23bd730) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 02c090718ac602f7d4760dd28dadbf0631668d49) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
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 541cedb106..74cca1bc36 100644
--- a/documentation/ref-manual/system-requirements.rst
+++ b/documentation/ref-manual/system-requirements.rst
@@ -187,6 +187,11 @@ Here are the packages needed to build Project documentation manuals::
187 187
188 $ sudo apt install &UBUNTU_DEBIAN_HOST_PACKAGES_DOC; 188 $ sudo apt install &UBUNTU_DEBIAN_HOST_PACKAGES_DOC;
189 189
190In addition to the previous packages, here are the packages needed to build the
191documentation in PDF format::
192
193 $ sudo apt install &UBUNTU_DEBIAN_HOST_PACKAGES_DOC_PDF;
194
190Fedora Packages 195Fedora Packages
191--------------- 196---------------
192 197
@@ -200,6 +205,11 @@ Here are the packages needed to build Project documentation manuals::
200 $ sudo dnf install &FEDORA_HOST_PACKAGES_DOC; 205 $ sudo dnf install &FEDORA_HOST_PACKAGES_DOC;
201 $ sudo pip3 install &PIP3_HOST_PACKAGES_DOC; 206 $ sudo pip3 install &PIP3_HOST_PACKAGES_DOC;
202 207
208In addition to the previous packages, here are the packages needed to build the
209documentation in PDF format::
210
211 $ sudo dnf install &FEDORA_HOST_PACKAGES_DOC_PDF;
212
203openSUSE Packages 213openSUSE Packages
204----------------- 214-----------------
205 215
@@ -214,6 +224,11 @@ Here are the packages needed to build Project documentation manuals::
214 $ sudo zypper install &OPENSUSE_HOST_PACKAGES_DOC; 224 $ sudo zypper install &OPENSUSE_HOST_PACKAGES_DOC;
215 $ sudo pip3 install &PIP3_HOST_PACKAGES_DOC; 225 $ sudo pip3 install &PIP3_HOST_PACKAGES_DOC;
216 226
227In addition to the previous packages, here are the packages needed to build the
228documentation in PDF format::
229
230 $ sudo zypper install &OPENSUSE_HOST_PACKAGES_DOC_PDF;
231
217 232
218AlmaLinux Packages 233AlmaLinux Packages
219------------------ 234------------------
@@ -245,6 +260,18 @@ Here are the packages needed to build Project documentation manuals::
245 $ sudo dnf install &ALMALINUX_HOST_PACKAGES_DOC; 260 $ sudo dnf install &ALMALINUX_HOST_PACKAGES_DOC;
246 $ sudo pip3 install &PIP3_HOST_PACKAGES_DOC; 261 $ sudo pip3 install &PIP3_HOST_PACKAGES_DOC;
247 262
263In addition to the previous packages, here are the packages needed to build the
264documentation in PDF format::
265
266 $ sudo dnf install &ALMALINUX_HOST_PACKAGES_DOC_PDF;
267
268.. warning::
269
270 Unlike Fedora or OpenSUSE, AlmaLinux does not provide the packages
271 ``texlive-collection-fontsextra``, ``texlive-collection-lang*`` and
272 ``texlive-collection-latexextra``, so you may run into issues. These may be
273 installed using `tlmgr <https://tug.org/texlive/tlmgr.html>`_.
274
248.. _system-requirements-buildtools: 275.. _system-requirements-buildtools:
249 276
250Required Git, tar, Python, make and gcc Versions 277Required Git, tar, Python, make and gcc Versions