summaryrefslogtreecommitdiffstats
path: root/documentation
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-17 12:58:11 -0800
commit6a069943633dab7db0e18e222502a191205561bb (patch)
tree5c8f478697b7db683e07f9afbefd7286e70bab9a /documentation
parenta5efa185bba1b016bd426617b92812886b7052f6 (diff)
downloadpoky-6a069943633dab7db0e18e222502a191205561bb.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: 01048d7de570a9d896c5aab294008396e2d78607) 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')
-rw-r--r--documentation/poky.yaml.in52
-rw-r--r--documentation/ref-manual/system-requirements.rst27
2 files changed, 76 insertions, 3 deletions
diff --git a/documentation/poky.yaml.in b/documentation/poky.yaml.in
index eedefcdea8..0933cbbd35 100644
--- a/documentation/poky.yaml.in
+++ b/documentation/poky.yaml.in
@@ -68,7 +68,17 @@ UBUNTU_DEBIAN_HOST_PACKAGES_DOC: >-
68 python3-saneyaml 68 python3-saneyaml
69 python3-sphinx-rtd-theme 69 python3-sphinx-rtd-theme
70 sphinx 70 sphinx
71
72UBUNTU_DEBIAN_HOST_PACKAGES_DOC_PDF: >-
73 fonts-freefont-otf
74 latexmk
75 tex-gyre
76 texlive-fonts-extra
77 texlive-fonts-recommended
78 texlive-lang-all
71 texlive-latex-extra 79 texlive-latex-extra
80 texlive-latex-recommended
81 texlive-xetex
72 82
73FEDORA_HOST_PACKAGES_ESSENTIAL: >- 83FEDORA_HOST_PACKAGES_ESSENTIAL: >-
74 bzip2 84 bzip2
@@ -123,9 +133,22 @@ FEDORA_HOST_PACKAGES_DOC: >-
123 librsvg2-tools 133 librsvg2-tools
124 make 134 make
125 python3-pip 135 python3-pip
126 texlive-fncychap
127 which 136 which
128 137
138FEDORA_HOST_PACKAGES_DOC_PDF: >-
139 'texlive-collection-lang*'
140 latexmk
141 texlive-collection-fontsextra
142 texlive-collection-fontsrecommended
143 texlive-collection-latex
144 texlive-collection-latexextra
145 texlive-collection-latexrecommended
146 texlive-collection-xetex
147 texlive-fncychap
148 texlive-gnu-freefont
149 texlive-tex-gyre
150 texlive-xetex
151
129OPENSUSE_HOST_PACKAGES_ESSENTIAL: >- 152OPENSUSE_HOST_PACKAGES_ESSENTIAL: >-
130 bzip2 153 bzip2
131 chrpath 154 chrpath
@@ -164,9 +187,22 @@ OPENSUSE_HOST_PACKAGES_DOC: >-
164 make 187 make
165 python3-pip 188 python3-pip
166 rsvg-convert 189 rsvg-convert
167 texlive-fncychap
168 which 190 which
169 191
192OPENSUSE_HOST_PACKAGES_DOC_PDF: >-
193 'texlive-collection-lang*'
194 texlive-collection-fontsextra
195 texlive-collection-fontsrecommended
196 texlive-collection-latex
197 texlive-collection-latexextra
198 texlive-collection-latexrecommended
199 texlive-collection-xetex
200 texlive-fncychap
201 texlive-gnu-freefont
202 texlive-latexmk
203 texlive-tex-gyre
204 texlive-xetex
205
170ALMALINUX_HOST_PACKAGES_ESSENTIAL: >- 206ALMALINUX_HOST_PACKAGES_ESSENTIAL: >-
171 bzip2 207 bzip2
172 ccache 208 ccache
@@ -211,5 +247,15 @@ ALMALINUX_HOST_PACKAGES_DOC: >-
211 librsvg2-tools 247 librsvg2-tools
212 make 248 make
213 python3-pip 249 python3-pip
214 texlive-fncychap
215 which 250 which
251
252ALMALINUX_HOST_PACKAGES_DOC_PDF: >-
253 latexmk
254 texlive-collection-fontsrecommended
255 texlive-collection-latex
256 texlive-collection-latexrecommended
257 texlive-collection-xetex
258 texlive-fncychap
259 texlive-gnu-freefont
260 texlive-tex-gyre
261 texlive-xetex
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