summaryrefslogtreecommitdiffstats
path: root/doc/book-enea-linux-release-info/doc/about_release.xml
diff options
context:
space:
mode:
Diffstat (limited to 'doc/book-enea-linux-release-info/doc/about_release.xml')
-rw-r--r--doc/book-enea-linux-release-info/doc/about_release.xml294
1 files changed, 294 insertions, 0 deletions
diff --git a/doc/book-enea-linux-release-info/doc/about_release.xml b/doc/book-enea-linux-release-info/doc/about_release.xml
new file mode 100644
index 0000000..01679f8
--- /dev/null
+++ b/doc/book-enea-linux-release-info/doc/about_release.xml
@@ -0,0 +1,294 @@
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 of Enea Linux <xi:include href="eltf_params_updated.xml"
8 xmlns:xi="http://www.w3.org/2001/XInclude"
9 xpointer="element(EneaLinux_REL_VER/1)" /> provides a publicly available
10 Enea Linux distribution for a selected set of targets. This release is
11 generated from the yocto <xi:include href="eltf_params_updated.xml"
12 xmlns:xi="http://www.w3.org/2001/XInclude"
13 xpointer="element(Yocto_VER/1)" /> distribution using the branch <xi:include
14 href="eltf_params_updated.xml" xmlns:xi="http://www.w3.org/2001/XInclude"
15 xpointer="element(Yocto_NAME/1)" />.<remark>INFO <emphasis
16 role="bold">eltf_params_updated.xml</emphasis> contains many parameters in
17 the book, also in the open source books, and MUST be created FROM <emphasis
18 role="bold">eltf_params_template.xml</emphasis>. The parameters are
19 automatically used in the books, via xi:include statements, similar to how
20 parameters from pardoc-distro.xml are included in the book. Read the file
21 <emphasis role="bold">eltf_params_updated_template_how_to_use.txt</emphasis>
22 for important details about formats and how to do! The idea is that ELTF
23 will auto-create/update it.</remark></para>
24
25 <section id="relinfo-provided-contents">
26 <title>Provided Contents</title>
27
28 <informaltable>
29 <tgroup cols="1">
30 <thead>
31 <row>
32 <entry>Item</entry>
33 </row>
34 </thead>
35
36 <tbody>
37 <row>
38 <entry><para>Source code, recipes and scripts for building the
39 distribution and SDKs. See <xref
40 linkend="relinfo-getting-enea-linux" />.</para></entry>
41 </row>
42
43 <row>
44 <entry><para>Documentation. See <xref
45 linkend="relinfo-documentation" />.</para></entry>
46 </row>
47
48 <row>
49 <entry>Pre-built binaries (kernel image, dtb &amp; rootfs)</entry>
50 </row>
51
52 <row>
53 <entry>Pre-built packages (RPM). See links for each
54 target.<remark>INFO Below is an Eclipse row from
55 eltf_params_updated.xml. MANUALLY if eclipse is not included, set
56 condition hidden on the row element BOTH in template.xml and in
57 updated.xml.</remark></entry>
58 </row>
59
60 <xi:include href="eltf_params_updated.xml"
61 xmlns:xi="http://www.w3.org/2001/XInclude"
62 xpointer="element(eltf-eclipse-version-row)" />
63 </tbody>
64 </tgroup>
65 </informaltable>
66 </section>
67
68 <section id="relinfo-supported-targets">
69 <title>Supported Targets</title>
70
71 <informaltable>
72 <tgroup cols="3">
73 <colspec align="left" colname="c1" colwidth="1*" />
74
75 <colspec align="left" colname="c2" colwidth="1*" />
76
77 <colspec align="left" colname="c3" colwidth="1*" />
78
79 <thead valign="bottom">
80 <row>
81 <entry>Target</entry>
82
83 <entry>Architecture</entry>
84
85 <entry>Specification</entry>
86 </row>
87 </thead>
88
89 <tbody>
90 <row>
91 <entry>P2041RDB</entry>
92
93 <entry><para>Power, e500mc</para></entry>
94
95 <entry>See <ulink
96 url="http://www.nxp.com/products/microcontrollers-and-processors/power-architecture-processors/qoriq-power-architecture-processors/p2041-qoriq-reference-design-board:RDP2041BOARD">link
97 to NXP's datasheet</ulink></entry>
98 </row>
99 </tbody>
100 </tgroup>
101 </informaltable>
102
103 <para><remark>FIXME should autocreate a list of targets, hopefully from
104 the generated README file, by using MAKEFILE to update pardoc-distro
105 AND/OR also auto-create an XML file to include here with description text
106 for each target etc..</remark></para>
107 </section>
108
109 <section id="relinfo-supported-host-environment">
110 <title>Supported Host Environment</title>
111
112 <itemizedlist>
113 <listitem>
114 <para>Ubuntu 14.04 LTS, 64-bit<remark>Hardcoded now in this XML file.
115 Might be moved to the parameter file later.</remark><remark>INFO Below
116 is a complete section with ID "eltf-target-tables-section" included
117 from elft_params_updated.xml. It contains a variable number of target
118 tables and the section title should be "Supported Targets with
119 Parameters". It has have a short sentence about what it is in the
120 beginning. The subtitles shall have the directory name of the target
121 in the manifest.</remark></para>
122 </listitem>
123 </itemizedlist>
124 </section>
125
126 <xi:include href="eltf_params_updated.xml"
127 xmlns:xi="http://www.w3.org/2001/XInclude"
128 xpointer="element(eltf-target-tables-section)" />
129
130 <section id="relinfo-packages">
131 <title>Provided Packages</title>
132
133 <para><informaltable>
134 <tgroup cols="2">
135 <colspec align="left" colname="c1" colwidth="3*" />
136
137 <colspec align="left" colname="c2" colwidth="6*" />
138
139 <thead valign="bottom">
140 <row>
141 <entry>Type of Packages</entry>
142
143 <entry>Reference</entry>
144 </row>
145 </thead>
146
147 <tbody>
148 <row>
149 <entry>Packages in Enea Linux</entry>
150
151 <entry><para>See the <olink
152 targetdoc="book_enea_linux_open_source"
153 targetptr="book_enea_linux_open_source"><trademark
154 class="registered">Enea</trademark> Linux Open Source
155 Report</olink></para></entry>
156 </row>
157
158 </tbody>
159 </tgroup>
160 </informaltable></para>
161 </section>
162
163 <section id="relinfo-provided-sdk">
164 <title>Provided Toolchain/s (SDK)</title>
165
166 <para>The SDK contains toolchains supporting cross-compilation of
167 applications for the targets on an x86_64 host. See the <olink
168 targetdoc="book_enea_linux_app_dev_guide"
169 targetptr="book_enea_linux_app_dev_guide"><trademark
170 class="registered">Enea</trademark> Linux Application Development
171 Guide</olink> for information on how to build and install a
172 toolchain.</para>
173 </section>
174
175 <section id="relinfo-documentation">
176 <title>Provided Documentation</title>
177
178 <para>The following Enea Linux manuals are available:</para>
179
180 <itemizedlist spacing="compact">
181 <listitem>
182 <para><trademark class="registered">Enea</trademark> Linux Release
183 Information (this document)</para>
184 </listitem>
185
186 <listitem>
187 <para><olink targetdoc="book_enea_linux_platforms_dev_guide"
188 targetptr="book_enea_linux_platforms_dev_guide"><trademark
189 class="registered">Enea</trademark> Linux Platforms Development
190 Guide</olink></para>
191 </listitem>
192
193 <listitem>
194 <para><olink targetdoc="book_enea_linux_app_dev_guide"
195 targetptr="book_enea_linux_app_dev_guide"><trademark
196 class="registered">Enea</trademark> Linux Application Development
197 Guide</olink></para>
198 </listitem>
199
200 <listitem>
201 <para><trademark class="registered">Enea</trademark> Linux Networking
202 Profile Guide</para>
203 </listitem>
204
205 <listitem>
206 <para><olink targetdoc="book_enea_linux_open_source"
207 targetptr="book_enea_linux_open_source"><trademark
208 class="registered">Enea</trademark> Linux Open Source
209 Report</olink></para>
210 </listitem>
211
212 <listitem>
213 <para><olink targetdoc="book_enea_linux_eclipse_open_source"
214 targetptr="book_enea_linux_eclipse_open_source"><trademark
215 class="registered">Enea</trademark> Linux Eclipse Open Source
216 Report</olink></para>
217 </listitem>
218
219 <listitem>
220 <para><trademark class="registered">Enea</trademark> Linux Test
221 Report</para>
222 </listitem>
223
224 <listitem>
225 <para><trademark class="registered">Enea</trademark> Linux Real-Time
226 Guide can be read at <ulink
227 url="http://linuxrealtime.org">http://linuxrealtime.org</ulink>.</para>
228 </listitem>
229 </itemizedlist>
230 </section>
231
232 <section condition="hidden" id="relinfo-provided-other">
233 <title>Other Provided Functionality</title>
234
235 <para>The functionality in a distribution depends on included packages in
236 the default image. In addition to the supported features, the following
237 functionality is also available, among other:<remark>INFO: This section
238 might be hidden by setting condition hidden on the section, MANUALLY in
239 this file.</remark></para>
240
241 <itemizedlist spacing="compact">
242 <listitem>
243 <para>On target T4240RDB:</para>
244
245 <itemizedlist spacing="compact">
246 <listitem>
247 <para>SRIO support in user space (NWRITE, NREAD, msg,
248 doorbell)</para>
249 </listitem>
250
251 <listitem>
252 <para>USDPAA</para>
253 </listitem>
254 </itemizedlist>
255 </listitem>
256
257 <listitem>
258 <para>Smart Package Management</para>
259 </listitem>
260 </itemizedlist>
261 </section>
262
263 <section id="relinfo-security-fixes">
264 <title>Security Fixes</title>
265
266 <para>See <ulink
267 url="http://www.enea.com/solutions/Enea-Linux/Security/CVEs-list">List of
268 CVEs addressed in Enea Linux</ulink> and <ulink
269 url="http://www.enea.com/solutions/Enea-Linux/Security#how-to-get-security-updates">How
270 to Get Security Updates</ulink>.</para>
271 </section>
272
273 <section condition="hidden" id="relinfo-excluded">
274 <title>Intentional Limitations</title>
275
276 <para>The following functionality supported in other Enea Linux releases
277 has been excluded in this release:<remark>INFO: This section might be
278 hidden by setting condition hidden on the section, MANUALLY in this
279 file.</remark><itemizedlist spacing="compact">
280 <listitem>
281 <para>Networking features: DPDK vSwitch, DPDK</para>
282 </listitem>
283
284 <listitem>
285 <para>Real-time features: Fully Preemptible Kernel (FPK) from the
286 PREEMPT_RT patch</para>
287 </listitem>
288
289 <listitem>
290 <para>Memory features: NUMA</para>
291 </listitem>
292 </itemizedlist></para>
293 </section>
294</chapter> \ No newline at end of file