diff options
author | Michael Opdenacker <michael.opdenacker@bootlin.com> | 2023-03-15 18:50:10 +0100 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2023-03-20 13:16:52 +0000 |
commit | ee1a0825b7d65ef7fb173e210051995222af6ae4 (patch) | |
tree | 083fdeab2e5b762b56ca51c6ff6dd4bd02d7cc99 | |
parent | 443a9f2658d137def30e54fa6f7c4aab95c861f0 (diff) | |
download | poky-ee1a0825b7d65ef7fb173e210051995222af6ae4.tar.gz |
ref-manual: system-requirements.rst: simplify supported distro requirements
- This allows to continue sharing the updated Ubuntu/Debian requirements
with the brief-yoctoprojectqs/index.rst without indentation mismatches
(caused by using the same macro in two different contexts: in direct
text and in a bullet list).
- Update poky.yaml.in to adapt the number of spaces at the beginning
of lines.
- brief-yoctoprojectqs/index.rst: fix bad number of spaces
before quote block.
(From yocto-docs rev: 38a3228f8981674bc75de135246c4f9eff7b43a1)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
-rw-r--r-- | documentation/brief-yoctoprojectqs/index.rst | 6 | ||||
-rw-r--r-- | documentation/poky.yaml.in | 12 | ||||
-rw-r--r-- | documentation/ref-manual/system-requirements.rst | 83 |
3 files changed, 42 insertions, 59 deletions
diff --git a/documentation/brief-yoctoprojectqs/index.rst b/documentation/brief-yoctoprojectqs/index.rst index c8310e0066..7b8baf233a 100644 --- a/documentation/brief-yoctoprojectqs/index.rst +++ b/documentation/brief-yoctoprojectqs/index.rst | |||
@@ -70,11 +70,9 @@ Build Host Packages | |||
70 | 70 | ||
71 | You must install essential host packages on your build host. The | 71 | You must install essential host packages on your build host. The |
72 | following command installs the host packages based on an Ubuntu | 72 | following command installs the host packages based on an Ubuntu |
73 | distribution: | 73 | distribution:: |
74 | 74 | ||
75 | .. code-block:: shell | 75 | $ sudo apt install &UBUNTU_HOST_PACKAGES_ESSENTIAL; |
76 | |||
77 | $ sudo apt install &UBUNTU_HOST_PACKAGES_ESSENTIAL; | ||
78 | 76 | ||
79 | .. note:: | 77 | .. note:: |
80 | 78 | ||
diff --git a/documentation/poky.yaml.in b/documentation/poky.yaml.in index 44654aa62f..30e1050824 100644 --- a/documentation/poky.yaml.in +++ b/documentation/poky.yaml.in | |||
@@ -14,7 +14,7 @@ UBUNTU_HOST_PACKAGES_ESSENTIAL : "gawk wget git diffstat unzip texinfo gcc \ | |||
14 | build-essential chrpath socat cpio python3 python3-pip python3-pexpect \ | 14 | build-essential chrpath socat cpio python3 python3-pip python3-pexpect \ |
15 | xz-utils debianutils iputils-ping python3-git python3-jinja2 libegl1-mesa libsdl1.2-dev \ | 15 | xz-utils debianutils iputils-ping python3-git python3-jinja2 libegl1-mesa libsdl1.2-dev \ |
16 | python3-subunit mesa-common-dev zstd liblz4-tool file locales | 16 | python3-subunit mesa-common-dev zstd liblz4-tool file locales |
17 | \n\ $ sudo locale-gen en_US.UTF-8" | 17 | \n\ $ sudo locale-gen en_US.UTF-8" |
18 | FEDORA_HOST_PACKAGES_ESSENTIAL : "gawk make wget tar bzip2 gzip python3 unzip perl patch \ | 18 | FEDORA_HOST_PACKAGES_ESSENTIAL : "gawk make wget tar bzip2 gzip python3 unzip perl patch \ |
19 | diffutils diffstat git cpp gcc gcc-c++ glibc-devel texinfo chrpath \ | 19 | diffutils diffstat git cpp gcc gcc-c++ glibc-devel texinfo chrpath \ |
20 | ccache perl-Data-Dumper perl-Text-ParseWords perl-Thread-Queue perl-bignum socat \ | 20 | ccache perl-Data-Dumper perl-Text-ParseWords perl-Thread-Queue perl-bignum socat \ |
@@ -25,12 +25,12 @@ OPENSUSE_HOST_PACKAGES_ESSENTIAL : "python gcc gcc-c++ git chrpath make wget pyt | |||
25 | diffstat makeinfo python-curses patch socat python3 python3-curses tar python3-pip \ | 25 | diffstat makeinfo python-curses patch socat python3 python3-curses tar python3-pip \ |
26 | python3-pexpect xz which python3-Jinja2 Mesa-libEGL1 libSDL-devel rpcgen Mesa-dri-devel \ | 26 | python3-pexpect xz which python3-Jinja2 Mesa-libEGL1 libSDL-devel rpcgen Mesa-dri-devel \ |
27 | zstd lz4 bzip2 gzip hostname | 27 | zstd lz4 bzip2 gzip hostname |
28 | \n\ $ sudo pip3 install GitPython" | 28 | \n\ $ sudo pip3 install GitPython" |
29 | ALMALINUX_HOST_PACKAGES_ESSENTIAL : "-y epel-release | 29 | ALMALINUX_HOST_PACKAGES_ESSENTIAL : "-y epel-release |
30 | \n\ $ sudo yum install dnf-plugins-core | 30 | \n\ $ sudo yum install dnf-plugins-core |
31 | \n\ $ sudo dnf config-manager --set-enabled crb | 31 | \n\ $ sudo dnf config-manager --set-enabled crb |
32 | \n\ $ sudo dnf makecache | 32 | \n\ $ sudo dnf makecache |
33 | \n\ $ sudo dnf install gawk make wget tar bzip2 gzip python3 unzip perl patch \ | 33 | \n\ $ sudo dnf install gawk make wget tar bzip2 gzip python3 unzip perl patch \ |
34 | diffutils diffstat git cpp gcc gcc-c++ glibc-devel texinfo chrpath ccache \ | 34 | diffutils diffstat git cpp gcc gcc-c++ glibc-devel texinfo chrpath ccache \ |
35 | socat perl-Data-Dumper perl-Text-ParseWords perl-Thread-Queue python3-pip \ | 35 | socat perl-Data-Dumper perl-Text-ParseWords perl-Thread-Queue python3-pip \ |
36 | python3-GitPython python3-jinja2 python3-pexpect xz which SDL-devel \ | 36 | python3-GitPython python3-jinja2 python3-pexpect xz which SDL-devel \ |
diff --git a/documentation/ref-manual/system-requirements.rst b/documentation/ref-manual/system-requirements.rst index 1bbe7b894d..0fbe3f12c8 100644 --- a/documentation/ref-manual/system-requirements.rst +++ b/documentation/ref-manual/system-requirements.rst | |||
@@ -110,8 +110,10 @@ function. | |||
110 | Ubuntu and Debian | 110 | Ubuntu and Debian |
111 | ----------------- | 111 | ----------------- |
112 | 112 | ||
113 | Here are the required packages by function given a | 113 | Here are the packages needed to build an image on a headless system |
114 | supported Ubuntu or Debian Linux distribution: | 114 | with a supported Ubuntu or Debian Linux distribution:: |
115 | |||
116 | $ sudo apt install &UBUNTU_HOST_PACKAGES_ESSENTIAL; | ||
115 | 117 | ||
116 | .. note:: | 118 | .. note:: |
117 | 119 | ||
@@ -123,80 +125,63 @@ supported Ubuntu or Debian Linux distribution: | |||
123 | $ sudo apt build-dep qemu | 125 | $ sudo apt build-dep qemu |
124 | $ sudo apt remove oss4-dev | 126 | $ sudo apt remove oss4-dev |
125 | 127 | ||
126 | - *Essentials:* Packages needed to build an image on a headless system:: | 128 | Here are the packages needed to build Project documentation manuals:: |
127 | |||
128 | $ sudo apt install &UBUNTU_HOST_PACKAGES_ESSENTIAL; | ||
129 | 129 | ||
130 | - *Documentation:* Packages needed if you are going to build out the | 130 | $ sudo apt install make python3-pip inkscape texlive-latex-extra |
131 | Yocto Project documentation manuals:: | 131 | &PIP3_HOST_PACKAGES_DOC; |
132 | |||
133 | $ sudo apt install make python3-pip inkscape texlive-latex-extra | ||
134 | &PIP3_HOST_PACKAGES_DOC; | ||
135 | 132 | ||
136 | Fedora Packages | 133 | Fedora Packages |
137 | --------------- | 134 | --------------- |
138 | 135 | ||
139 | Here are the required packages by function given a | 136 | Here are the packages needed to build an image on a headless system |
140 | supported Fedora Linux distribution: | 137 | with a supported Fedora Linux distribution:: |
141 | |||
142 | - *Essentials:* Packages needed to build an image for a headless | ||
143 | system:: | ||
144 | 138 | ||
145 | $ sudo dnf install &FEDORA_HOST_PACKAGES_ESSENTIAL; | 139 | $ sudo dnf install &FEDORA_HOST_PACKAGES_ESSENTIAL; |
146 | 140 | ||
147 | - *Documentation:* Packages needed if you are going to build out the | 141 | Here are the packages needed to build Project documentation manuals:: |
148 | Yocto Project documentation manuals:: | ||
149 | 142 | ||
150 | $ sudo dnf install make python3-pip which inkscape texlive-fncychap | 143 | $ sudo dnf install make python3-pip which inkscape texlive-fncychap |
151 | &PIP3_HOST_PACKAGES_DOC; | 144 | &PIP3_HOST_PACKAGES_DOC; |
152 | 145 | ||
153 | openSUSE Packages | 146 | openSUSE Packages |
154 | ----------------- | 147 | ----------------- |
155 | 148 | ||
156 | Here are the required packages by function given a | 149 | Here are the packages needed to build an image on a headless system |
157 | supported openSUSE Linux distribution: | 150 | with a supported openSUSE distribution:: |
158 | 151 | ||
159 | - *Essentials:* Packages needed to build an image for a headless | 152 | $ sudo zypper install &OPENSUSE_HOST_PACKAGES_ESSENTIAL; |
160 | system:: | ||
161 | 153 | ||
162 | $ sudo zypper install &OPENSUSE_HOST_PACKAGES_ESSENTIAL; | 154 | Here are the packages needed to build Project documentation manuals:: |
163 | 155 | ||
164 | - *Documentation:* Packages needed if you are going to build out the | 156 | $ sudo zypper install make python3-pip which inkscape texlive-fncychap |
165 | Yocto Project documentation manuals:: | 157 | &PIP3_HOST_PACKAGES_DOC; |
166 | |||
167 | $ sudo zypper install make python3-pip which inkscape texlive-fncychap | ||
168 | &PIP3_HOST_PACKAGES_DOC; | ||
169 | 158 | ||
170 | 159 | ||
171 | AlmaLinux Packages | 160 | AlmaLinux Packages |
172 | ------------------ | 161 | ------------------ |
173 | 162 | ||
174 | Here are the required packages by function given a | 163 | Here are the packages needed to build an image on a headless system |
175 | supported AlmaLinux Linux distribution: | 164 | with a supported AlmaLinux distribution:: |
176 | |||
177 | - *Essentials:* Packages needed to build an image for a headless | ||
178 | system:: | ||
179 | 165 | ||
180 | $ sudo dnf install &ALMALINUX8_HOST_PACKAGES_ESSENTIAL; | 166 | $ sudo dnf install &ALMALINUX8_HOST_PACKAGES_ESSENTIAL; |
181 | 167 | ||
182 | .. note:: | 168 | .. note:: |
183 | 169 | ||
184 | - Extra Packages for Enterprise Linux (i.e. ``epel-release``) is | 170 | - Extra Packages for Enterprise Linux (i.e. ``epel-release``) is |
185 | a collection of packages from Fedora built on RHEL/CentOS for | 171 | a collection of packages from Fedora built on RHEL/CentOS for |
186 | easy installation of packages not included in enterprise Linux | 172 | easy installation of packages not included in enterprise Linux |
187 | by default. You need to install these packages separately. | 173 | by default. You need to install these packages separately. |
188 | 174 | ||
189 | - The ``PowerTools/CRB`` repo provides additional packages such as | 175 | - The ``PowerTools/CRB`` repo provides additional packages such as |
190 | ``rpcgen`` and ``texinfo``. | 176 | ``rpcgen`` and ``texinfo``. |
191 | 177 | ||
192 | - The ``makecache`` command consumes additional Metadata from | 178 | - The ``makecache`` command consumes additional Metadata from |
193 | ``epel-release``. | 179 | ``epel-release``. |
194 | 180 | ||
195 | - *Documentation:* Packages needed if you are going to build out the | 181 | Here are the packages needed to build Project documentation manuals:: |
196 | Yocto Project documentation manuals:: | ||
197 | 182 | ||
198 | $ sudo dnf install make python3-pip which inkscape texlive-fncychap | 183 | $ sudo dnf install make python3-pip which inkscape texlive-fncychap |
199 | &PIP3_HOST_PACKAGES_DOC; | 184 | &PIP3_HOST_PACKAGES_DOC; |
200 | 185 | ||
201 | .. _system-requirements-buildtools: | 186 | .. _system-requirements-buildtools: |
202 | 187 | ||