summaryrefslogtreecommitdiffstats
path: root/documentation/book-enea-linux-release-info/doc/about_release.xml
diff options
context:
space:
mode:
Diffstat (limited to 'documentation/book-enea-linux-release-info/doc/about_release.xml')
-rw-r--r--documentation/book-enea-linux-release-info/doc/about_release.xml416
1 files changed, 416 insertions, 0 deletions
diff --git a/documentation/book-enea-linux-release-info/doc/about_release.xml b/documentation/book-enea-linux-release-info/doc/about_release.xml
new file mode 100644
index 0000000..59cf24b
--- /dev/null
+++ b/documentation/book-enea-linux-release-info/doc/about_release.xml
@@ -0,0 +1,416 @@
1<?xml version="1.0" encoding="ISO-8859-1"?>
2<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
3"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
4<chapter id="relinfo-about-release">
5 <title>About This Release</title>
6
7 <para>This release <emphasis><xi:include
8 href="../../docsrc_common/pardoc-distro.xml"
9 xmlns:xi="http://www.w3.org/2001/XInclude"
10 xpointer="element(EneaLinux_REL_NAME/1)" /></emphasis> provides a publicly
11 available Enea Linux distribution for a selected set of PPC targets. This
12 release is generated from branch <xi:include
13 href="../../docsrc_common/pardoc-distro.xml"
14 xmlns:xi="http://www.w3.org/2001/XInclude"
15 xpointer="element(EneaLinux_BRANCH/1)" /> of applicable git
16 repositories.</para>
17
18 <para>Provided contents:<itemizedlist spacing="compact">
19 <listitem>
20 <para>Source code, recipes, scripts, and documentation for building
21 your own Linux kernel, root file system, and cross-compilation
22 toolchains (SDKs)</para>
23 </listitem>
24
25 <listitem>
26 <para>Default configurations for basic Yocto functionality</para>
27 </listitem>
28
29 <listitem condition="f_any">
30 <para>Feature-specific configurations to optionally add more
31 capabilities to the Linux kernel</para>
32 </listitem>
33
34 <listitem>
35 <para>Pre-built images (kernels, rootfs, dtb) and other binaries
36 available for download</para>
37 </listitem>
38
39 <listitem condition="eclipse">
40 <para>Eclipse executable plus application development tools (ADT) for
41 command line and Eclipse</para>
42 </listitem>
43 </itemizedlist></para>
44
45 <!-- At least one target must be listed otherwise PDF build fails -->
46
47 <para>Supported targets:<itemizedlist spacing="compact">
48 <listitem condition="t_p2041">
49 <para><xi:include href="../../docsrc_common/pardoc-distro.xml"
50 xmlns:xi="http://www.w3.org/2001/XInclude"
51 xpointer="element(EneaLinux_TARGET_NAME_P2041/1)" /></para>
52 </listitem>
53
54 <listitem condition="t_p3041">
55 <para><xi:include href="../../docsrc_common/pardoc-distro.xml"
56 xmlns:xi="http://www.w3.org/2001/XInclude"
57 xpointer="element(EneaLinux_TARGET_NAME_P3041/1)" /></para>
58 </listitem>
59
60 <listitem condition="t_t4240">
61 <para><xi:include href="../../docsrc_common/pardoc-distro.xml"
62 xmlns:xi="http://www.w3.org/2001/XInclude"
63 xpointer="element(EneaLinux_TARGET_NAME_T4240/1)" /></para>
64 </listitem>
65
66 <listitem condition="qemu">
67 <para>QEMU PPC</para>
68 </listitem>
69 </itemizedlist></para>
70
71 <para>Kernel configuration:</para>
72
73 <itemizedlist spacing="compact">
74 <listitem condition="t_p2041">
75 <para>P2041RDB: One kernel flavor (release)</para>
76 </listitem>
77
78 <listitem condition="t_p3041">
79 <para>P3041DS: One kernel flavor (release)</para>
80 </listitem>
81
82 <listitem condition="t_t4240">
83 <para>T4240RDB: Two kernel flavors (release &amp; debug)</para>
84 </listitem>
85
86 <listitem>
87 <para>Low-Latency Desktop (LLD)</para>
88 </listitem>
89 </itemizedlist>
90
91 <para>Supported host environment:<itemizedlist>
92 <listitem>
93 <para><xi:include href="../../docsrc_common/pardoc-distro.xml"
94 xmlns:xi="http://www.w3.org/2001/XInclude"
95 xpointer="element(EneaLinux_HOST_VER/1)" /></para>
96 </listitem>
97 </itemizedlist></para>
98
99 <para>Supported versions:<itemizedlist spacing="compact">
100 <listitem>
101 <para>Yocto version <xi:include
102 href="../../docsrc_common/pardoc-distro.xml"
103 xmlns:xi="http://www.w3.org/2001/XInclude"
104 xpointer="element(Yocto_VER/1)" /></para>
105 </listitem>
106
107 <listitem>
108 <para>poky source version <xi:include
109 href="../../docsrc_common/pardoc-distro.xml"
110 xmlns:xi="http://www.w3.org/2001/XInclude"
111 xpointer="element(Poky_VER/1)" /></para>
112 </listitem>
113
114 <listitem>
115 <para>gcc version: <xi:include
116 href="../../docsrc_common/pardoc-distro.xml"
117 xmlns:xi="http://www.w3.org/2001/XInclude"
118 xpointer="element(EneaLinux_GCC_VER/1)" /></para>
119 </listitem>
120
121 <listitem>
122 <para>Linux kernel version for all targets: <xi:include
123 href="../../docsrc_common/pardoc-distro.xml"
124 xmlns:xi="http://www.w3.org/2001/XInclude"
125 xpointer="element(EneaLinux_KERNEL_VER/1)" /></para>
126 </listitem>
127
128 <listitem condition="eclipse">
129 <para>Eclipse version <xi:include
130 href="../../docsrc_common/pardoc-distro.xml"
131 xmlns:xi="http://www.w3.org/2001/XInclude"
132 xpointer="element(Eclipse_VER/1)" /> <xi:include
133 href="../../docsrc_common/pardoc-distro.xml"
134 xmlns:xi="http://www.w3.org/2001/XInclude"
135 xpointer="element(Eclipse_NAME/1)" /></para>
136 </listitem>
137
138 <listitem>
139 <para>Package versions: See <xref linkend="relinfo-packages" /></para>
140 </listitem>
141 </itemizedlist></para>
142
143 <para>Distribution channel:<itemizedlist spacing="compact">
144 <listitem>
145 <para>All deliverables can be downloaded from <xi:include
146 href="../../docsrc_common/pardoc-distro.xml"
147 xmlns:xi="http://www.w3.org/2001/XInclude"
148 xpointer="element(ULINK_ENEA_LINUX_URL/1)" /></para>
149 </listitem>
150 </itemizedlist></para>
151
152 <para>Supported features: See <xref
153 linkend="relinfo-supported-features" />.</para>
154
155 <para condition="hidden">More details about this release are provided under
156 the following topics:<remark>Info This list is currently hidden (same as
157 TOC) until we might add useful descriptions of the
158 chapters</remark><itemizedlist spacing="compact">
159 <listitem>
160 <para><xref linkend="relinfo-supported-targets" /></para>
161 </listitem>
162
163 <listitem>
164 <para><xref linkend="relinfo-packages" /></para>
165 </listitem>
166
167 <listitem>
168 <para><xref linkend="relinfo-provided-sdk" /></para>
169 </listitem>
170
171 <listitem>
172 <para><xref linkend="relinfo-provided-drivers" /></para>
173 </listitem>
174
175 <listitem>
176 <para><xref linkend="relinfo-documentation" /></para>
177 </listitem>
178
179 <listitem condition="f_any">
180 <para><xref linkend="relinfo-supported-features" /></para>
181 </listitem>
182
183 <listitem>
184 <para><xref linkend="relinfo-provided-other" /></para>
185 </listitem>
186
187 <listitem>
188 <para><xref linkend="relinfo-security-fixes" /></para>
189 </listitem>
190
191 <listitem>
192 <para><xref linkend="relinfo-excluded" /></para>
193 </listitem>
194
195 <listitem>
196 <para><xref linkend="relinfo-changes" /></para>
197 </listitem>
198
199 <listitem>
200 <para><xref linkend="enea-linux-sysreq" /></para>
201 </listitem>
202
203 <listitem>
204 <para><xref linkend="bugs-limitations" /></para>
205 </listitem>
206 </itemizedlist></para>
207
208 <?hard-pagebreak ?>
209
210 <xi:include href="supported_architectures.xml"
211 xmlns:xi="http://www.w3.org/2001/XInclude" />
212
213 <section id="relinfo-packages">
214 <title>Provided Packages</title>
215
216 <para><informaltable>
217 <tgroup cols="2">
218 <colspec align="left" colname="c1" colwidth="3*" />
219
220 <colspec align="left" colname="c2" colwidth="6*" />
221
222 <thead valign="bottom">
223 <row>
224 <entry>Type of Packages and Provider</entry>
225
226 <entry>Reference</entry>
227 </row>
228 </thead>
229
230 <tbody>
231 <row>
232 <entry>Packages in Enea Linux images</entry>
233
234 <entry><para>See the <olink
235 targetdoc="book_enea_linux_open_source"
236 targetptr="book_enea_linux_open_source"><trademark
237 class="registered">Enea</trademark> Linux Open Source
238 Report</olink></para></entry>
239 </row>
240
241 <row condition="eclipse">
242 <entry>Tools in the Eclipse tarball provided with Enea
243 Linux</entry>
244
245 <entry><para>See the <olink
246 targetdoc="book_enea_linux_eclipse_open_source"
247 targetptr="book_enea_linux_eclipse_open_source"><trademark
248 class="registered">Enea</trademark> Linux Eclipse Open Source
249 Report</olink></para></entry>
250 </row>
251
252 <row>
253 <entry>Packages provided by Yocto</entry>
254
255 <entry><para>See the <xi:include
256 href="../../docsrc_common/pardoc-distro.xml"
257 xmlns:xi="http://www.w3.org/2001/XInclude"
258 xpointer="element(ULINK_YOCTO_DOWN_URL/1)" />, tab "Release
259 Notes"</para></entry>
260 </row>
261 </tbody>
262 </tgroup>
263 </informaltable></para>
264 </section>
265
266 <section id="relinfo-provided-sdk">
267 <title>Provided Toolchain/s (SDK)</title>
268
269 <para>The SDK contains toolchains supporting cross-compilation of
270 applications for the targets on an <xi:include
271 href="../../docsrc_common/pardoc-distro.xml"
272 xmlns:xi="http://www.w3.org/2001/XInclude"
273 xpointer="element(EneaLinux_SDK_HOST_ARCH/1)" /> host. See the <olink
274 targetdoc="book_enea_linux_users_guide"
275 targetptr="book_enea_linux_users_guide"><trademark
276 class="registered">Enea</trademark> Linux User's Guide</olink> for
277 information on how to build and install a toolchain.<remark>FIXME LATER
278 MAYBE: Sorry but 5.0-ppc does not support cross-compilation of 32-bit
279 applications for the T4240RDB 64bit target due to bugs in
280 Yocto.</remark></para>
281 </section>
282
283 <section id="relinfo-provided-drivers">
284 <title>Supported Drivers</title>
285
286 <para>No information of supported drivers is provided in this version of
287 the Release Information.</para>
288 </section>
289
290 <section id="relinfo-documentation">
291 <title>Provided Documentation</title>
292
293 <para>The following Enea Linux manuals are available for <xi:include
294 href="../../docsrc_common/pardoc-distro.xml"
295 xmlns:xi="http://www.w3.org/2001/XInclude"
296 xpointer="element(EneaLinux_REL_VER/1)" />:</para>
297
298 <itemizedlist spacing="compact">
299 <listitem>
300 <para>README.htm - top page of the documentation</para>
301 </listitem>
302
303 <listitem>
304 <para>README.release - text file describing the release contents,
305 installation, and quick getting started</para>
306 </listitem>
307
308 <listitem>
309 <para><link linkend="book_enea_linux_release_info"><trademark
310 class="registered">Enea</trademark> Linux Release Information (this
311 document)</link></para>
312 </listitem>
313
314 <listitem>
315 <para><olink targetdoc="book_enea_linux_users_guide"
316 targetptr="book_enea_linux_users_guide"><trademark
317 class="registered">Enea</trademark> Linux User's Guide</olink></para>
318 </listitem>
319
320 <listitem>
321 <para><olink targetdoc="book_enea_linux_open_source"
322 targetptr="book_enea_linux_open_source"><trademark
323 class="registered">Enea</trademark> Linux Open Source
324 Report</olink></para>
325 </listitem>
326
327 <listitem condition="eclipse">
328 <para><olink targetdoc="book_enea_linux_eclipse_open_source"
329 targetptr="book_enea_linux_eclipse_open_source"><trademark
330 class="registered">Enea</trademark> Linux Eclipse Open Source
331 Report</olink></para>
332 </listitem>
333 </itemizedlist>
334
335 <para condition="eclipse">The Enea Linux Eclipse tarball and Eclipse Open
336 Source Report is inherited from Enea Linux 4.0. How to use Eclipse is
337 described inside the <olink targetdoc="book_enea_linux_users_guide"
338 targetptr="book_enea_linux_users_guide"><trademark
339 class="registered">Enea</trademark> Linux User's Guide</olink>.</para>
340
341 <para condition="eclipse">Eclipse's own documentation is available in
342 tarball Enea-Linux-Eclipse_<xi:include
343 href="../../docsrc_common/pardoc-distro.xml"
344 xmlns:xi="http://www.w3.org/2001/XInclude"
345 xpointer="element(EneaLinux_REL_VER_ECLIPSE/1)" />.tar, directory
346 <filename>eclipse/readme</filename>.</para>
347 </section>
348
349 <?hard-pagebreak ?>
350
351 <xi:include href="supported_features.xml"
352 xmlns:xi="http://www.w3.org/2001/XInclude">
353 <xi:fallback>INFO: MISSING XINCLUDE CONTENT</xi:fallback>
354 </xi:include>
355
356 <section id="relinfo-provided-other">
357 <title>Other Provided Functionality</title>
358
359 <para>The functionality in a distribution depends on included packages in
360 the default image. In addition to the supported features, the following
361 functionality is also available, among other:</para>
362
363 <itemizedlist spacing="compact">
364 <listitem condition="t_t4240">
365 <para>On target T4240RDB:</para>
366
367 <itemizedlist spacing="compact">
368 <listitem>
369 <para>SRIO support in user space (NWRITE, NREAD, msg,
370 doorbell)</para>
371 </listitem>
372
373 <listitem>
374 <para>USDPAA</para>
375 </listitem>
376 </itemizedlist>
377 </listitem>
378
379 <listitem condition="pm_smart">
380 <para>Smart Package Management</para>
381 </listitem>
382
383 <listitem condition="eclipse">
384 <para>Eclipse ADT (excl. QEMU) and plug-ins for application
385 development: LTTng, Perf, LatencyTOP, PowerTOP, SystemTap</para>
386 </listitem>
387 </itemizedlist>
388 </section>
389
390 <xi:include href="../../../../documentation/book-enea-linux-release-info/doc/security_fixes.xml"
391 xmlns:xi="http://www.w3.org/2001/XInclude" />
392
393 <section id="relinfo-excluded">
394 <title>Intentional Limitations</title>
395
396 <para>The following functionality supported in other Enea Linux releases
397 has been excluded in this release:<itemizedlist spacing="compact">
398 <listitem>
399 <para>Eclipse plug-ins for image creation (HOB)</para>
400 </listitem>
401
402 <listitem>
403 <para>Networking features: DPDK vSwitch, DPDK</para>
404 </listitem>
405
406 <listitem>
407 <para>Real-time features: Fully Preemptible Kernel (FPK) from the
408 PREEMPT_RT patch</para>
409 </listitem>
410
411 <listitem>
412 <para>Memory features: NUMA</para>
413 </listitem>
414 </itemizedlist></para>
415 </section>
416</chapter> \ No newline at end of file
generated by cgit v1.2.3-54-g00ecf (git 2.39.0) at 2024-05-03 00:05:14 +0000