summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
Diffstat (limited to 'documentation')
-rw-r--r--documentation/brief-yoctoprojectqs/index.rst2
-rw-r--r--documentation/poky.yaml.in213
-rw-r--r--documentation/ref-manual/system-requirements.rst22
3 files changed, 202 insertions, 35 deletions
diff --git a/documentation/brief-yoctoprojectqs/index.rst b/documentation/brief-yoctoprojectqs/index.rst
index c5400e4ac8..3d249eefaa 100644
--- a/documentation/brief-yoctoprojectqs/index.rst
+++ b/documentation/brief-yoctoprojectqs/index.rst
@@ -78,7 +78,7 @@ You must install essential host packages on your build host. The
78following command installs the host packages based on an Ubuntu 78following command installs the host packages based on an Ubuntu
79distribution:: 79distribution::
80 80
81 $ sudo apt install &UBUNTU_HOST_PACKAGES_ESSENTIAL; 81 $ sudo apt install &UBUNTU_DEBIAN_HOST_PACKAGES_ESSENTIAL;
82 82
83.. note:: 83.. note::
84 84
diff --git a/documentation/poky.yaml.in b/documentation/poky.yaml.in
index 197e6c757a..7824162c53 100644
--- a/documentation/poky.yaml.in
+++ b/documentation/poky.yaml.in
@@ -1,3 +1,7 @@
1#
2# Macros used in the documentation
3#
4
1DISTRO : "5.0" 5DISTRO : "5.0"
2DISTRO_NAME_NO_CAP : "scarthgap" 6DISTRO_NAME_NO_CAP : "scarthgap"
3DISTRO_NAME : "Scarthgap" 7DISTRO_NAME : "Scarthgap"
@@ -10,31 +14,6 @@ BITBAKE_SERIES : ""
10YOCTO_DL_URL : "https://downloads.yoctoproject.org" 14YOCTO_DL_URL : "https://downloads.yoctoproject.org"
11YOCTO_AB_URL : "https://autobuilder.yoctoproject.org" 15YOCTO_AB_URL : "https://autobuilder.yoctoproject.org"
12YOCTO_RELEASE_DL_URL : "&YOCTO_DL_URL;/releases/yocto/yocto-&DISTRO;" 16YOCTO_RELEASE_DL_URL : "&YOCTO_DL_URL;/releases/yocto/yocto-&DISTRO;"
13UBUNTU_HOST_PACKAGES_ESSENTIAL : "gawk wget git diffstat unzip texinfo gcc \
14 build-essential chrpath socat cpio python3 python3-pip python3-pexpect \
15 xz-utils debianutils iputils-ping python3-git python3-jinja2 \
16 python3-subunit zstd liblz4-tool file locales libacl1"
17FEDORA_HOST_PACKAGES_ESSENTIAL : "gawk make wget tar bzip2 gzip python3 unzip perl patch \
18 diffutils diffstat git cpp gcc gcc-c++ glibc-devel texinfo chrpath \
19 ccache perl-Data-Dumper perl-Text-ParseWords perl-Thread-Queue perl-bignum socat \
20 python3-pexpect findutils which file cpio python python3-pip xz python3-GitPython \
21 python3-jinja2 rpcgen perl-FindBin perl-File-Compare \
22 perl-File-Copy perl-locale zstd lz4 hostname glibc-langpack-en libacl"
23OPENSUSE_HOST_PACKAGES_ESSENTIAL : "python gcc gcc-c++ git chrpath make wget python-xml \
24 diffstat makeinfo python-curses patch socat python3 python3-curses tar python3-pip \
25 python3-pexpect xz which python3-Jinja2 rpcgen \
26 zstd lz4 bzip2 gzip hostname libacl1
27 \n\ $ sudo pip3 install GitPython"
28ALMALINUX_HOST_PACKAGES_ESSENTIAL : "-y epel-release
29 \n\ $ sudo yum install dnf-plugins-core
30 \n\ $ sudo dnf config-manager --set-enabled crb
31 \n\ $ sudo dnf makecache
32 \n\ $ sudo dnf install gawk make wget tar bzip2 gzip python3 unzip perl patch \
33 diffutils diffstat git cpp gcc gcc-c++ glibc-devel texinfo chrpath ccache \
34 socat perl-Data-Dumper perl-Text-ParseWords perl-Thread-Queue python3-pip \
35 python3-GitPython python3-jinja2 python3-pexpect xz which \
36 rpcgen zstd lz4 cpio glibc-langpack-en libacl"
37PIP3_HOST_PACKAGES_DOC : "$ sudo pip3 install sphinx sphinx_rtd_theme pyyaml"
38MIN_PYTHON_VERSION : "3.8.0" 17MIN_PYTHON_VERSION : "3.8.0"
39MIN_TAR_VERSION : "1.28" 18MIN_TAR_VERSION : "1.28"
40MIN_GIT_VERSION : "1.8.3.1" 19MIN_GIT_VERSION : "1.8.3.1"
@@ -46,3 +25,187 @@ MIN_DISK_SPACE : "90"
46MIN_DISK_SPACE_RM_WORK : "40" 25MIN_DISK_SPACE_RM_WORK : "40"
47# RAM (Gbytes) needed to generate qemux86-64 core-image-sato on Ubuntu 22.04 (x86-64) on a 4 core system 26# RAM (Gbytes) needed to generate qemux86-64 core-image-sato on Ubuntu 22.04 (x86-64) on a 4 core system
48MIN_RAM : "8" 27MIN_RAM : "8"
28
29#
30# Dependencies
31#
32
33# Shared between distros
34PIP3_HOST_PACKAGES_DOC: sphinx sphinx_rtd_theme pyyaml
35
36UBUNTU_DEBIAN_HOST_PACKAGES_ESSENTIAL: >-
37 build-essential
38 chrpath
39 cpio
40 debianutils
41 diffstat
42 file
43 gawk
44 gcc
45 git
46 iputils-ping
47 libacl1
48 liblz4-tool
49 locales
50 python3
51 python3-git
52 python3-jinja2
53 python3-pexpect
54 python3-pip
55 python3-subunit
56 socat
57 texinfo
58 unzip
59 wget
60 xz-utils
61 zstd
62
63UBUNTU_DEBIAN_HOST_PACKAGES_DOC: >-
64 git
65 inkscape
66 make
67 python3-saneyaml
68 python3-sphinx-rtd-theme
69 sphinx
70 texlive-latex-extra
71
72FEDORA_HOST_PACKAGES_ESSENTIAL: >-
73 bzip2
74 ccache
75 chrpath
76 cpio
77 cpp
78 diffstat
79 diffutils
80 file
81 findutils
82 gawk
83 gcc
84 gcc-c++
85 git
86 glibc-devel
87 glibc-langpack-en
88 gzip
89 hostname
90 libacl
91 lz4
92 make
93 patch
94 perl
95 perl-Data-Dumper
96 perl-File-Compare
97 perl-File-Copy
98 perl-FindBin
99 perl-Text-ParseWords
100 perl-Thread-Queue
101 perl-bignum
102 perl-locale
103 python
104 python3
105 python3-GitPython
106 python3-jinja2
107 python3-pexpect
108 python3-pip
109 rpcgen
110 socat
111 tar
112 texinfo
113 unzip
114 wget
115 which
116 xz
117 zstd
118
119FEDORA_HOST_PACKAGES_DOC: >-
120 git
121 inkscape
122 make
123 python3-pip
124 texlive-fncychap
125 which
126
127OPENSUSE_HOST_PACKAGES_ESSENTIAL: >-
128 bzip2
129 chrpath
130 diffstat
131 gcc
132 gcc-c++
133 git
134 gzip
135 hostname
136 libacl1
137 lz4
138 make
139 makeinfo
140 patch
141 python
142 python-curses
143 python-xml
144 python3
145 python3-Jinja2
146 python3-curses
147 python3-pexpect
148 python3-pip
149 rpcgen
150 socat
151 tar
152 wget
153 which
154 xz
155 zstd
156
157OPENSUSE_PIP3_HOST_PACKAGES_ESSENTIAL: GitPython
158
159OPENSUSE_HOST_PACKAGES_DOC: >-
160 git
161 inkscape
162 make
163 python3-pip
164 texlive-fncychap
165 which
166
167ALMALINUX_HOST_PACKAGES_ESSENTIAL: >-
168 bzip2
169 ccache
170 chrpath
171 cpio
172 cpp
173 diffstat
174 diffutils
175 gawk
176 gcc
177 gcc-c++
178 git
179 glibc-devel
180 glibc-langpack-en
181 gzip
182 libacl
183 lz4
184 make
185 patch
186 perl
187 perl-Data-Dumper
188 perl-Text-ParseWords
189 perl-Thread-Queue
190 python3
191 python3-GitPython
192 python3-jinja2
193 python3-pexpect
194 python3-pip
195 rpcgen
196 socat
197 tar
198 texinfo
199 unzip
200 wget
201 which
202 xz
203 zstd
204
205ALMALINUX_HOST_PACKAGES_DOC: >-
206 git
207 inkscape
208 make
209 python3-pip
210 texlive-fncychap
211 which
diff --git a/documentation/ref-manual/system-requirements.rst b/documentation/ref-manual/system-requirements.rst
index 43c3c5834b..0b40c3f5e5 100644
--- a/documentation/ref-manual/system-requirements.rst
+++ b/documentation/ref-manual/system-requirements.rst
@@ -150,7 +150,7 @@ Ubuntu and Debian
150Here are the packages needed to build an image on a headless system 150Here are the packages needed to build an image on a headless system
151with a supported Ubuntu or Debian Linux distribution:: 151with a supported Ubuntu or Debian Linux distribution::
152 152
153 $ sudo apt install &UBUNTU_HOST_PACKAGES_ESSENTIAL; 153 $ sudo apt install &UBUNTU_DEBIAN_HOST_PACKAGES_ESSENTIAL;
154 154
155You also need to ensure you have the ``en_US.UTF-8`` locale enabled:: 155You also need to ensure you have the ``en_US.UTF-8`` locale enabled::
156 156
@@ -181,8 +181,7 @@ If this is not the case, you can reconfigure the ``locales`` package to add it
181 181
182Here are the packages needed to build Project documentation manuals:: 182Here are the packages needed to build Project documentation manuals::
183 183
184 $ sudo apt install git make inkscape texlive-latex-extra 184 $ sudo apt install &UBUNTU_DEBIAN_HOST_PACKAGES_DOC;
185 $ sudo apt install sphinx python3-saneyaml python3-sphinx-rtd-theme
186 185
187Fedora Packages 186Fedora Packages
188--------------- 187---------------
@@ -194,8 +193,8 @@ with a supported Fedora Linux distribution::
194 193
195Here are the packages needed to build Project documentation manuals:: 194Here are the packages needed to build Project documentation manuals::
196 195
197 $ sudo dnf install git make python3-pip which inkscape texlive-fncychap 196 $ sudo dnf install &FEDORA_HOST_PACKAGES_DOC;
198 &PIP3_HOST_PACKAGES_DOC; 197 $ sudo pip3 install &PIP3_HOST_PACKAGES_DOC;
199 198
200openSUSE Packages 199openSUSE Packages
201----------------- 200-----------------
@@ -204,11 +203,12 @@ Here are the packages needed to build an image on a headless system
204with a supported openSUSE distribution:: 203with a supported openSUSE distribution::
205 204
206 $ sudo zypper install &OPENSUSE_HOST_PACKAGES_ESSENTIAL; 205 $ sudo zypper install &OPENSUSE_HOST_PACKAGES_ESSENTIAL;
206 $ sudo pip3 install &OPENSUSE_PIP3_HOST_PACKAGES_ESSENTIAL;
207 207
208Here are the packages needed to build Project documentation manuals:: 208Here are the packages needed to build Project documentation manuals::
209 209
210 $ sudo zypper install git make python3-pip which inkscape texlive-fncychap 210 $ sudo zypper install &OPENSUSE_HOST_PACKAGES_DOC;
211 &PIP3_HOST_PACKAGES_DOC; 211 $ sudo pip3 install &PIP3_HOST_PACKAGES_DOC;
212 212
213 213
214AlmaLinux Packages 214AlmaLinux Packages
@@ -217,6 +217,10 @@ AlmaLinux Packages
217Here are the packages needed to build an image on a headless system 217Here are the packages needed to build an image on a headless system
218with a supported AlmaLinux distribution:: 218with a supported AlmaLinux distribution::
219 219
220 $ sudo dnf install -y epel-release
221 $ sudo yum install dnf-plugins-core
222 $ sudo dnf config-manager --set-enabled crb
223 $ sudo dnf makecache
220 $ sudo dnf install &ALMALINUX_HOST_PACKAGES_ESSENTIAL; 224 $ sudo dnf install &ALMALINUX_HOST_PACKAGES_ESSENTIAL;
221 225
222.. note:: 226.. note::
@@ -234,8 +238,8 @@ with a supported AlmaLinux distribution::
234 238
235Here are the packages needed to build Project documentation manuals:: 239Here are the packages needed to build Project documentation manuals::
236 240
237 $ sudo dnf install git make python3-pip which inkscape texlive-fncychap 241 $ sudo dnf install &ALMALINUX_HOST_PACKAGES_DOC;
238 &PIP3_HOST_PACKAGES_DOC; 242 $ sudo pip3 install &PIP3_HOST_PACKAGES_DOC;
239 243
240.. _system-requirements-buildtools: 244.. _system-requirements-buildtools:
241 245