summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
Diffstat (limited to 'documentation')
-rw-r--r--documentation/ref-manual/index.rst1
-rw-r--r--documentation/ref-manual/yocto-project-supported-features.rst263
2 files changed, 264 insertions, 0 deletions
diff --git a/documentation/ref-manual/index.rst b/documentation/ref-manual/index.rst
index a746dde492..53fa98cc99 100644
--- a/documentation/ref-manual/index.rst
+++ b/documentation/ref-manual/index.rst
@@ -11,6 +11,7 @@ Yocto Project Reference Manual
11 :numbered: 11 :numbered:
12 12
13 system-requirements 13 system-requirements
14 yocto-project-supported-features
14 terms 15 terms
15 release-process 16 release-process
16 structure 17 structure
diff --git a/documentation/ref-manual/yocto-project-supported-features.rst b/documentation/ref-manual/yocto-project-supported-features.rst
new file mode 100644
index 0000000000..bc1a813938
--- /dev/null
+++ b/documentation/ref-manual/yocto-project-supported-features.rst
@@ -0,0 +1,263 @@
1.. SPDX-License-Identifier: CC-BY-SA-2.0-UK
2
3**************************************************
4Yocto Project Supported Architectures And Features
5**************************************************
6
7The Yocto Project is putting continuous efforts into testing the changes made to
8the :term:`OpenEmbedded-Core (OE-Core)` metadata and core tools. The details on
9how this test environment functions is described in the
10:doc:`/test-manual/index`.
11
12These tests are also run for stable and :term:`LTS` versions of the Yocto
13Project. See the :doc:`/ref-manual/release-process` section of the Yocto Project
14Reference Manual for more information on these types of releases.
15
16The infrastructure behind the test environment is the
17:ref:`Yocto Project Autobuilder <test-manual/intro:Yocto Project Autobuilder
18Overview>`. The Autobuilder contains a set of Builders that are associated to an
19architecture or a feature to test. For example, the ``qemuarm64`` builder
20corresponds to testing the ARM 64-bit architecture.
21
22Below is a comprehensive list of target architectures and features that are
23supported, as well as their level of support. For each architecture or feature,
24their corresponding builders are also listed.
25
26Primary Supported
27=================
28
29The term "primary" means that dedicated builds for these architectures or
30features are being run on a daily basis on the Yocto Project Autobuilder and
31also tested with incoming changes before they merge. These changes are usually
32on the "-next" Git branches of the :term:`OpenEmbedded-Core (OE-Core)`
33repositories.
34
35Below is a list of primary tested features, their maintainer(s) and builder(s):
36
37.. list-table::
38 :widths: 20 20 20 40
39 :header-rows: 1
40
41 * - Feature
42 - Description
43 - Maintainer(s)
44 - Builder(s)
45 * - :wikipedia:`ARM <ARM_architecture_family>`
46 - ARM architecture testing
47 - Collective effort
48 - genericarm64,
49 genericarm64-alt,
50 musl-qemuarm64,
51 qemuarm,
52 qemuarm-alt,
53 qemuarm-oecore,
54 qemuarm-tc,
55 qemuarm64,
56 qemuarm64-alt,
57 qemuarm64-armhost,
58 qemuarm64-ltp,
59 qemuarm64-ptest,
60 qemuarm64-tc,
61 qemuarmv5
62 * - :yocto_git:`Beaglebone </poky/tree/meta-yocto-bsp/conf/machine/beaglebone-yocto.conf>`
63 - Beaglebone image and SDK build testing
64 - Collective effort
65 - beaglebone,
66 beaglebone-alt
67 * - :doc:`Reproducible </test-manual/reproducible-builds>`
68 - reproducibility testing
69 - Collective effort
70 - reproducible
71 * - :term:`Buildtools`
72 - Buildtools generation
73 - Collective effort
74 - buildtools
75 * - `meta-agl-core <https://gerrit.automotivelinux.org/gerrit/AGL/meta-agl>`__
76 - meta-agl-core layer testing
77 - TBD
78 - meta-agl-core
79 * - `meta-arm <https://git.yoctoproject.org/meta-arm>`__
80 - meta-arm layer testing
81 - TBD
82 - meta-arm
83 * - `meta-aws <https://github.com/aws4embeddedlinux/meta-aws>`__
84 - meta-aws layer testing
85 - TBD
86 - meta-aws
87 * - `meta-intel <https://git.yoctoproject.org/meta-intel>`__
88 - meta-intel layer testing
89 - TBD
90 - meta-intel
91 * - `meta-virtualization <https://git.yoctoproject.org/meta-virtualization/>`__
92 - meta-virtualization layer testing
93 - TBD
94 - meta-virt
95 * - :ref:`Multilib <dev-manual/libraries:Combining Multiple Versions of Library Files into One Image>`
96 - Multilib feature testing
97 - Collective effort
98 - multilib
99 * - :term:`OpenEmbedded-Core selftest<OpenEmbedded-Core (OE-Core)>`
100 - OpenEmbedded-Core layers selftests
101 - Collective effort
102 - oe-selftest-fedora,
103 oe-selftest-debian,
104 oe-selftest-armhost
105 * - Package managers
106 - Package managers (RPM, DEB and IPK formats) testing in the
107 :term:`OpenEmbedded Build System` (different from the
108 ``package-management`` :term:`image feature <IMAGE_FEATURES>`)
109 - Collective effort
110 - pkgman-non-rpm (other builders use RPM by default)
111 * - :ref:`Patchtest <contributor-guide/submit-changes:Validating Patches with Patchtest>`
112 - Patchtest tool selftests
113 - TBD
114 - patchtest-selftest
115 * - :wikipedia:`RISC-V (64-bit) <RISC-V>`
116 - RISC-V architecture testing (64-bit)
117 - Collective effort
118 - qemuriscv64,
119 qemuriscv64-ptest,
120 qemuriscv64-tc
121 * - :wikipedia:`systemd <Systemd>`
122 - Systemd init manager testing
123 - Collective effort
124 - no-x11, qa-extras2
125 * - :term:`Toaster`
126 - Toaster web interface testing
127 - Collective effort
128 - toaster
129 * - :ref:`Wic <dev-manual/wic:creating partitioned images using wic>`
130 - WIC image creation testing
131 - Collective effort
132 - wic
133 * - :wikipedia:`X86 <X86>`
134 - X86 architecture testing
135 - Collective effort
136 - genericx86,
137 genericx86-64,
138 genericx86-64-alt,
139 genericx86-alt,
140 musl-qemux86,
141 musl-qemux86-64,
142 qemux86,
143 qemux86-64,
144 qemux86-64-alt,
145 qemux86-64-ltp,
146 qemux86-64-ptest,
147 qemux86-64-tc,
148 qemux86-64-x32,
149 qemux86-alt,
150 qemux86-tc,
151 qemux86-world,
152 qemux86-world-alt
153
154Secondary Supported
155===================
156
157The term "secondary" means that in some cases there is code/feature/support
158which is desired by people using the project and is in the project's interests
159to support, however there isn't wide enough interest and support to justify
160testing all incoming changes on it. There are however project member
161organisations and maintainers willing to run tests and review fixes.
162
163This category may be applicable as support/usage in an area develops and grows,
164or as support/usage fades but we continue to have tests. It can also apply where
165resourcing isn't available for full primary support but there is
166member/maintainer support for running tests.
167
168We therefore have the following criteria and policies for such items:
169
170- It can be clearly isolated and defined by specific configuration.
171
172- There is a clear documented group of maintainers agreeing to maintain it.
173
174- Those maintainers are active and responsive.
175
176- It is being actively and publicly tested (potentially using
177 the :ref:`Autobuilder <test-manual/intro:Yocto Project Autobuilder Overview>`
178 by agreement, or otherwise).
179
180- Testing would not be part of standard incoming change testing and regressions
181 would not block incoming patches.
182
183- The :yocto_wiki:`SWAT </Yocto_Build_Failure_Swat_Team>` team would not handle
184 any test builds on the Autobuilder.
185
186- Test results can be submitted as part of the release process if desired.
187
188The Yocto Project :oe_wiki:`Technical Steering Committee (TSC) </TSC>` makes
189decisions on features in this status and Autobuilder testing. Such support would
190be dropped if the maintainers/testing were inactive.
191
192If you are interested in providing resources for improving testing please
193contact the :oe_wiki:`Technical Steering Committee (TSC) </TSC>`.
194
195Below is a list of secondary tested features, their maintainer(s) and
196builder(s):
197
198.. list-table::
199 :widths: 20 20 20 40
200 :header-rows: 1
201
202 * - Feature
203 - Description
204 - Maintainer(s)
205 - Builder(s)
206 * - :wikipedia:`PowerPC (32-bit) <PowerPC>`
207 - PowerPC architecture testing (32-bit)
208 - TBD
209 - qemuppc,
210 qemuppc-alt,
211 qemuppc-tc
212 * - :oe_git:`meta-openembedded </meta-openembedded>`
213 - meta-openembedded layer testing
214 - TBD
215 - meta-oe
216 * - `meta-mingw <https://git.yoctoproject.org/meta-mingw>`__
217 - mingw based SDKs testing
218 - TBD
219 - meta-mingw
220 * - `meta-webosose <https://github.com/webosose/meta-webosose>`__
221 - meta-webosose layer testing
222 - TBD
223 - meta-webosose
224 * - :wikipedia:`RISC-V (32-bit) <RISC-V>`
225 - RISC-V architecture testing (32-bit)
226 - Collective effort
227 - qemuriscv32,
228 qemuriscv32,
229 qemuriscv32-tc
230
231Untested
232========
233
234"Untested" means that whilst the configurations are present in the project, we
235don't currently run the tests on any regular basis and new changes are not
236tested against them. We may take patches in these areas if they make sense but
237it is on a best effort only basis.
238
239.. list-table::
240 :widths: 20 20 20 40
241 :header-rows: 1
242
243 * - Feature
244 - Description
245 - Maintainer(s)
246 - Builder(s)
247 * - `meta-exein <https://github.com/exein-io/meta-exein>`__
248 - meta-exein layer testing
249 - TBD
250 - meta-exein
251 * - :wikipedia:`MIPS <MIPS_architecture>`
252 - MIPS architecture testing
253 - No maintainers
254 - qemumips,
255 qemumips64,
256 qemumips-alt,
257 qemumips-tc,
258 qemumips64-tc
259 * - :wikipedia:`PowerPC (64-bit) <PowerPC>`
260 - PowerPC architecture testing (64-bit)
261 - No maintainers
262 - qemuppc64,
263 qemuppc64-tc