From 9d7930a4e0d0566e41ad0e0cf551cab04e847d64 Mon Sep 17 00:00:00 2001 From: Quentin Schulz Date: Mon, 27 Jan 2025 19:37:04 +0100 Subject: docs: use literalinclude for system requirements The YAML variables for the host dependencies are updated by hand and actually only used inside code blocks. Let's migrate all instructions into separate shell scripts that are then literalinclude'd into the Sphinx documentation. This allows a few things: - ability to run shellcheck on the scripts if we ever want to - manually calling the appropriate script from a supported distro to build stuff (distro or bitbake/yocto stuff) - use this script to create containers to do CI of documentation on different distros, to make sure our instructions are all up to date, (From yocto-docs rev: 8d993022c2aefc0fde9baa949d39d7a3613f9f46) Signed-off-by: Quentin Schulz Reviewed-by: Antonin Godard Tested-by: Antonin Godard Signed-off-by: Antonin Godard Signed-off-by: Richard Purdie --- documentation/tools/host_packages_scripts/almalinux_docs.sh | 1 + documentation/tools/host_packages_scripts/almalinux_docs_pdf.sh | 1 + documentation/tools/host_packages_scripts/almalinux_essential.sh | 5 +++++ documentation/tools/host_packages_scripts/fedora_docs.sh | 1 + documentation/tools/host_packages_scripts/fedora_docs_pdf.sh | 1 + documentation/tools/host_packages_scripts/fedora_essential.sh | 1 + documentation/tools/host_packages_scripts/opensuse_docs.sh | 1 + documentation/tools/host_packages_scripts/opensuse_docs_pdf.sh | 1 + documentation/tools/host_packages_scripts/opensuse_essential.sh | 2 ++ documentation/tools/host_packages_scripts/pip3_docs.sh | 1 + documentation/tools/host_packages_scripts/ubuntu_docs.sh | 1 + documentation/tools/host_packages_scripts/ubuntu_docs_pdf.sh | 1 + documentation/tools/host_packages_scripts/ubuntu_essential.sh | 1 + 13 files changed, 18 insertions(+) create mode 100644 documentation/tools/host_packages_scripts/almalinux_docs.sh create mode 100644 documentation/tools/host_packages_scripts/almalinux_docs_pdf.sh create mode 100644 documentation/tools/host_packages_scripts/almalinux_essential.sh create mode 100644 documentation/tools/host_packages_scripts/fedora_docs.sh create mode 100644 documentation/tools/host_packages_scripts/fedora_docs_pdf.sh create mode 100644 documentation/tools/host_packages_scripts/fedora_essential.sh create mode 100644 documentation/tools/host_packages_scripts/opensuse_docs.sh create mode 100644 documentation/tools/host_packages_scripts/opensuse_docs_pdf.sh create mode 100644 documentation/tools/host_packages_scripts/opensuse_essential.sh create mode 100644 documentation/tools/host_packages_scripts/pip3_docs.sh create mode 100644 documentation/tools/host_packages_scripts/ubuntu_docs.sh create mode 100644 documentation/tools/host_packages_scripts/ubuntu_docs_pdf.sh create mode 100644 documentation/tools/host_packages_scripts/ubuntu_essential.sh (limited to 'documentation/tools/host_packages_scripts') diff --git a/documentation/tools/host_packages_scripts/almalinux_docs.sh b/documentation/tools/host_packages_scripts/almalinux_docs.sh new file mode 100644 index 0000000000..8188d529a1 --- /dev/null +++ b/documentation/tools/host_packages_scripts/almalinux_docs.sh @@ -0,0 +1 @@ +sudo dnf install git glibc-locale-source librsvg2-tools make python3-pip which diff --git a/documentation/tools/host_packages_scripts/almalinux_docs_pdf.sh b/documentation/tools/host_packages_scripts/almalinux_docs_pdf.sh new file mode 100644 index 0000000000..8341eb8c25 --- /dev/null +++ b/documentation/tools/host_packages_scripts/almalinux_docs_pdf.sh @@ -0,0 +1 @@ +sudo dnf install 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/tools/host_packages_scripts/almalinux_essential.sh b/documentation/tools/host_packages_scripts/almalinux_essential.sh new file mode 100644 index 0000000000..16f25fa1f2 --- /dev/null +++ b/documentation/tools/host_packages_scripts/almalinux_essential.sh @@ -0,0 +1,5 @@ +sudo dnf install -y epel-release +sudo yum install dnf-plugins-core +sudo dnf config-manager --set-enabled crb +sudo dnf makecache +sudo dnf install bzip2 ccache chrpath cpio cpp diffstat diffutils gawk gcc gcc-c++ git glibc-devel glibc-langpack-en gzip libacl lz4 make patch perl perl-Data-Dumper perl-Text-ParseWords perl-Thread-Queue python3 python3-GitPython python3-jinja2 python3-pexpect python3-pip rpcgen socat tar texinfo unzip wget which xz zstd diff --git a/documentation/tools/host_packages_scripts/fedora_docs.sh b/documentation/tools/host_packages_scripts/fedora_docs.sh new file mode 100644 index 0000000000..8188d529a1 --- /dev/null +++ b/documentation/tools/host_packages_scripts/fedora_docs.sh @@ -0,0 +1 @@ +sudo dnf install git glibc-locale-source librsvg2-tools make python3-pip which diff --git a/documentation/tools/host_packages_scripts/fedora_docs_pdf.sh b/documentation/tools/host_packages_scripts/fedora_docs_pdf.sh new file mode 100644 index 0000000000..816f1c36ec --- /dev/null +++ b/documentation/tools/host_packages_scripts/fedora_docs_pdf.sh @@ -0,0 +1 @@ +sudo dnf install '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 diff --git a/documentation/tools/host_packages_scripts/fedora_essential.sh b/documentation/tools/host_packages_scripts/fedora_essential.sh new file mode 100644 index 0000000000..4841853e1e --- /dev/null +++ b/documentation/tools/host_packages_scripts/fedora_essential.sh @@ -0,0 +1 @@ +sudo dnf install bzip2 ccache chrpath cpio cpp diffstat diffutils file findutils gawk gcc gcc-c++ git glibc-devel glibc-langpack-en gzip hostname libacl lz4 make patch perl perl-Data-Dumper perl-File-Compare perl-File-Copy perl-FindBin perl-Text-ParseWords perl-Thread-Queue perl-bignum perl-locale python python3 python3-GitPython python3-jinja2 python3-pexpect python3-pip rpcgen socat tar texinfo unzip wget which xz zstd diff --git a/documentation/tools/host_packages_scripts/opensuse_docs.sh b/documentation/tools/host_packages_scripts/opensuse_docs.sh new file mode 100644 index 0000000000..7d36eb0f99 --- /dev/null +++ b/documentation/tools/host_packages_scripts/opensuse_docs.sh @@ -0,0 +1 @@ +sudo zypper install git glibc-i18ndata make python3-pip rsvg-convert which diff --git a/documentation/tools/host_packages_scripts/opensuse_docs_pdf.sh b/documentation/tools/host_packages_scripts/opensuse_docs_pdf.sh new file mode 100644 index 0000000000..ee9f07886c --- /dev/null +++ b/documentation/tools/host_packages_scripts/opensuse_docs_pdf.sh @@ -0,0 +1 @@ +sudo zypper install '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 diff --git a/documentation/tools/host_packages_scripts/opensuse_essential.sh b/documentation/tools/host_packages_scripts/opensuse_essential.sh new file mode 100644 index 0000000000..a784f4a5dc --- /dev/null +++ b/documentation/tools/host_packages_scripts/opensuse_essential.sh @@ -0,0 +1,2 @@ +sudo zypper install bzip2 chrpath diffstat gcc gcc-c++ git gzip hostname libacl1 lz4 make makeinfo patch python python-curses python-xml python3 python3-Jinja2 python3-curses python3-pexpect python3-pip rpcgen socat tar wget which xz zstd +sudo pip3 install GitPython diff --git a/documentation/tools/host_packages_scripts/pip3_docs.sh b/documentation/tools/host_packages_scripts/pip3_docs.sh new file mode 100644 index 0000000000..fd6ad98053 --- /dev/null +++ b/documentation/tools/host_packages_scripts/pip3_docs.sh @@ -0,0 +1 @@ +sudo pip3 install sphinx sphinx_rtd_theme pyyaml diff --git a/documentation/tools/host_packages_scripts/ubuntu_docs.sh b/documentation/tools/host_packages_scripts/ubuntu_docs.sh new file mode 100644 index 0000000000..d2a1832e27 --- /dev/null +++ b/documentation/tools/host_packages_scripts/ubuntu_docs.sh @@ -0,0 +1 @@ +sudo apt install git librsvg2-bin locales make python3-saneyaml python3-saneyaml python3-sphinx-rtd-theme sphinx diff --git a/documentation/tools/host_packages_scripts/ubuntu_docs_pdf.sh b/documentation/tools/host_packages_scripts/ubuntu_docs_pdf.sh new file mode 100644 index 0000000000..d6310bd21d --- /dev/null +++ b/documentation/tools/host_packages_scripts/ubuntu_docs_pdf.sh @@ -0,0 +1 @@ +sudo apt install fonts-freefont-otf latexmk tex-gyre texlive-fonts-extra texlive-fonts-recommended texlive-lang-all texlive-latex-extra texlive-latex-recommended texlive-xetex diff --git a/documentation/tools/host_packages_scripts/ubuntu_essential.sh b/documentation/tools/host_packages_scripts/ubuntu_essential.sh new file mode 100644 index 0000000000..f3388c88c9 --- /dev/null +++ b/documentation/tools/host_packages_scripts/ubuntu_essential.sh @@ -0,0 +1 @@ +sudo apt-get install build-essential chrpath cpio debianutils diffstat file gawk gcc git iputils-ping libacl1 liblz4-tool locales python3 python3-git python3-jinja2 python3-pexpect python3-pip python3-subunit socat texinfo unzip wget xz-utils zstd -- cgit v1.2.3-54-g00ecf