From 6a069943633dab7db0e18e222502a191205561bb Mon Sep 17 00:00:00 2001 From: Antonin Godard Date: Tue, 10 Dec 2024 11:00:24 +0100 Subject: 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 (cherry picked from commit 02c090718ac602f7d4760dd28dadbf0631668d49) Signed-off-by: Antonin Godard Signed-off-by: Steve Sakoman --- documentation/poky.yaml.in | 52 ++++++++++++++++++++++-- documentation/ref-manual/system-requirements.rst | 27 ++++++++++++ 2 files changed, 76 insertions(+), 3 deletions(-) (limited to 'documentation') 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: >- python3-saneyaml python3-sphinx-rtd-theme sphinx + +UBUNTU_DEBIAN_HOST_PACKAGES_DOC_PDF: >- + fonts-freefont-otf + latexmk + tex-gyre + texlive-fonts-extra + texlive-fonts-recommended + texlive-lang-all texlive-latex-extra + texlive-latex-recommended + texlive-xetex FEDORA_HOST_PACKAGES_ESSENTIAL: >- bzip2 @@ -123,9 +133,22 @@ FEDORA_HOST_PACKAGES_DOC: >- librsvg2-tools make python3-pip - texlive-fncychap which +FEDORA_HOST_PACKAGES_DOC_PDF: >- + 'texlive-collection-lang*' + latexmk + texlive-collection-fontsextra + texlive-collection-fontsrecommended + texlive-collection-latex + texlive-collection-latexextra + texlive-collection-latexrecommended + texlive-collection-xetex + texlive-fncychap + texlive-gnu-freefont + texlive-tex-gyre + texlive-xetex + OPENSUSE_HOST_PACKAGES_ESSENTIAL: >- bzip2 chrpath @@ -164,9 +187,22 @@ OPENSUSE_HOST_PACKAGES_DOC: >- make python3-pip rsvg-convert - texlive-fncychap which +OPENSUSE_HOST_PACKAGES_DOC_PDF: >- + 'texlive-collection-lang*' + texlive-collection-fontsextra + texlive-collection-fontsrecommended + texlive-collection-latex + texlive-collection-latexextra + texlive-collection-latexrecommended + texlive-collection-xetex + texlive-fncychap + texlive-gnu-freefont + texlive-latexmk + texlive-tex-gyre + texlive-xetex + ALMALINUX_HOST_PACKAGES_ESSENTIAL: >- bzip2 ccache @@ -211,5 +247,15 @@ ALMALINUX_HOST_PACKAGES_DOC: >- librsvg2-tools make python3-pip - texlive-fncychap which + +ALMALINUX_HOST_PACKAGES_DOC_PDF: >- + latexmk + texlive-collection-fontsrecommended + texlive-collection-latex + texlive-collection-latexrecommended + texlive-collection-xetex + texlive-fncychap + texlive-gnu-freefont + texlive-tex-gyre + 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:: $ sudo apt install &UBUNTU_DEBIAN_HOST_PACKAGES_DOC; +In addition to the previous packages, here are the packages needed to build the +documentation in PDF format:: + + $ sudo apt install &UBUNTU_DEBIAN_HOST_PACKAGES_DOC_PDF; + Fedora Packages --------------- @@ -206,6 +211,11 @@ Here are the packages needed to build Project documentation manuals:: $ sudo dnf install &FEDORA_HOST_PACKAGES_DOC; $ sudo pip3 install &PIP3_HOST_PACKAGES_DOC; +In addition to the previous packages, here are the packages needed to build the +documentation in PDF format:: + + $ sudo dnf install &FEDORA_HOST_PACKAGES_DOC_PDF; + openSUSE Packages ----------------- @@ -220,6 +230,11 @@ Here are the packages needed to build Project documentation manuals:: $ sudo zypper install &OPENSUSE_HOST_PACKAGES_DOC; $ sudo pip3 install &PIP3_HOST_PACKAGES_DOC; +In addition to the previous packages, here are the packages needed to build the +documentation in PDF format:: + + $ sudo zypper install &OPENSUSE_HOST_PACKAGES_DOC_PDF; + AlmaLinux Packages ------------------ @@ -251,6 +266,18 @@ Here are the packages needed to build Project documentation manuals:: $ sudo dnf install &ALMALINUX_HOST_PACKAGES_DOC; $ sudo pip3 install &PIP3_HOST_PACKAGES_DOC; +In addition to the previous packages, here are the packages needed to build the +documentation in PDF format:: + + $ sudo dnf install &ALMALINUX_HOST_PACKAGES_DOC_PDF; + +.. warning:: + + Unlike Fedora or OpenSUSE, AlmaLinux does not provide the packages + ``texlive-collection-fontsextra``, ``texlive-collection-lang*`` and + ``texlive-collection-latexextra``, so you may run into issues. These may be + installed using `tlmgr `_. + .. _system-requirements-buildtools: Required Git, tar, Python, make and gcc Versions -- cgit v1.2.3-54-g00ecf