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.xml235
1 files changed, 235 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..cb75bc1
--- /dev/null
+++ b/doc/book-enea-linux-release-info/doc/about_release.xml
@@ -0,0 +1,235 @@
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 Project <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>. </remark></para>
19
20 <para><remark>The parameters are automatically used in the books, via
21 xi:include statements, similar to how parameters from pardoc-distro.xml are
22 included in the book. Read the file <emphasis
23 role="bold">eltf_params_updated_template_how_to_use.txt</emphasis> for
24 important details about formats and how to do! The idea is that ELTF will
25 auto-create/update it.</remark></para>
26
27 <section id="relinfo-provided-contents">
28 <title>Provided Contents</title>
29
30 <para>The current release contains documentation, prebuilt kernels and
31 images, a bootloader and an SDK. The directories structure is detailed
32 below:</para>
33
34 <programlisting>-- Documentation/
35 /* Enea Linux 8 documentation */
36 -- intel-corei7-64/
37 /* artifacts for the reference machine */
38 -- deb/
39 /* deb packages */
40 -- images/
41 -- enea-image-rt
42 /* precompiled artifacts for the platform release image */
43 -- various artifacts (rootfs, kernel, config, dtb etc.)
44 -- enea-image-rt-sdk
45 /* precompiled artifacts for the development process. The image
46 contains userspace tools and kernel configurations necessary
47 for developing, debugging and profiling applications and \
48 kernel modules */
49 -- various artifacts
50 -- sdk
51 /* SDK related artifacts including SDK installer and manifests */
52 /* self-extracting archive installing cross-compilation
53 toolchain for the platform */
54 -- x86_64-buildtools-nativesdk-standalone-8.0.sh
55 /* self-extracting archive installing additional tools
56 for the host machine */</programlisting>
57
58 <para>The following set of artifacts is available:</para>
59
60 <programlisting>-- Image
61 /* kernel image */
62-- Image-target.bin
63 /* kernel image, same as above */
64-- Image-target.dtb
65 /* the device tree blob */
66-- config-target.config
67 /* kernel configuration file */
68-- image-name-target.ext3
69 /* compressed EXT3 image of the rootfs */
70-- image-name-target.tar.bz2
71 /* tar archive of the image */
72-- modules-&lt;target&gt;.tgz
73 /* external kernel modules */</programlisting>
74 </section>
75
76 <section id="relinfo-supported-host-environment">
77 <title>Supported Host Environment</title>
78
79 <para>The following environments have been validated as host environments
80 for this release of Enea Linux: <emphasis role="bold">Ubuntu 16.04 LTS,
81 64-bit</emphasis>.</para>
82
83 <para><remark>INFO Below is a complete section with ID
84 "eltf-target-tables-section" included from elft_params_updated.xml. It
85 contains a variable number of target tables and the section title should
86 be "Supported Targets with Parameters". It has have a short sentence about
87 what it is in the beginning. The subtitles shall have the directory name
88 of the target in the manifest.</remark></para>
89 </section>
90
91 <xi:include href="eltf_params_updated.xml"
92 xmlns:xi="http://www.w3.org/2001/XInclude"
93 xpointer="element(eltf-target-tables-section)" />
94
95 <section id="relinfo-packages">
96 <title>Provided Packages</title>
97
98 <para><informaltable>
99 <tgroup cols="2">
100 <colspec align="left" colname="c1" colwidth="3*" />
101
102 <colspec align="left" colname="c2" colwidth="6*" />
103
104 <thead valign="bottom">
105 <row>
106 <entry>Type of Packages</entry>
107
108 <entry>Reference</entry>
109 </row>
110 </thead>
111
112 <tbody>
113 <row>
114 <entry>Packages in Enea Linux</entry>
115
116 <entry><para>See the <olink
117 targetdoc="book_enea_linux_open_source_rt"
118 targetptr="book_enea_linux_open_source_rt"><trademark
119 class="registered">Enea</trademark> Linux Open Source
120 Report</olink></para></entry>
121 </row>
122 </tbody>
123 </tgroup>
124 </informaltable></para>
125 </section>
126
127 <section id="relinfo-provided-sdk">
128 <title>Provided Toolchains (SDK)</title>
129
130 <para>The SDK contains toolchains supporting cross-compilation of
131 applications for the targets on an aarch64 host. For information on how to
132 build and install a toolchain, see the chapter <olink
133 targetdoc="book_enea_linux_user_guide_rt"
134 targetptr="using_enealinux">Using Enea Linux, in the <xi:include
135 href="../../s_docbuild/olinkdb/pardoc-names.xml"
136 xmlns:xi="http://www.w3.org/2001/XInclude"
137 xpointer="element(book_enea_linux_user_guide_standard/1)" /></olink>.</para>
138 </section>
139
140 <section id="relinfo-documentation">
141 <title>Provided Documentation</title>
142
143 <para>The following Enea Linux manuals are available:</para>
144
145 <itemizedlist spacing="compact">
146 <listitem>
147 <para><trademark class="registered">Enea</trademark> Linux Release
148 Information (this document)</para>
149 </listitem>
150
151 <listitem>
152 <para><olink targetdoc="book_enea_linux_user_guide_rt"
153 targetptr="book_enea_linux_user_guide_rt"><trademark
154 class="registered">Enea</trademark> Linux User's Guide</olink></para>
155 </listitem>
156
157 <listitem>
158 <para><olink targetdoc="book_enea_linux_open_source_rt"
159 targetptr="book_enea_linux_open_source_rt"><trademark
160 class="registered">Enea</trademark> Linux Open Source
161 Report</olink></para>
162 </listitem>
163
164 <listitem>
165 <para><trademark class="registered">Enea</trademark> Linux Test
166 Report</para>
167 </listitem>
168
169 <listitem>
170 <para><trademark class="registered">Enea</trademark> Linux Security
171 Report</para>
172 </listitem>
173
174 <listitem>
175 <para><trademark class="registered">Enea</trademark><ulink
176 url="http://linuxrealtime.org"> Linux Real-Time Guide</ulink></para>
177 </listitem>
178 </itemizedlist>
179 </section>
180
181 <section condition="hidden" id="relinfo-provided-other">
182 <title>Other Provided Functionality</title>
183
184 <para>The functionality in a distribution depends on included packages in
185 the default image. In addition to the supported features, the following
186 functionality is also available, among other:<remark>INFO: This section
187 might be hidden by setting condition hidden on the section, MANUALLY in
188 this file</remark></para>
189
190 <itemizedlist spacing="compact">
191 <listitem>
192 <para>APT Package Management</para>
193 </listitem>
194
195 <listitem>
196 <para>Eclipse ADT (excl. QEMU) and plug-ins for application
197 development: LTTng, Perf, LatencyTOP, PowerTOP, SystemTap</para>
198 </listitem>
199 </itemizedlist>
200 </section>
201
202 <section id="relinfo-security-fixes">
203 <title>Security Fixes</title>
204
205 <para>See the <ulink
206 url="https://www.enea.com/products/security/security-updates/">List of
207 CVEs addressed in Enea Linux</ulink> for details.</para>
208 </section>
209
210 <section condition="hidden" id="relinfo-excluded">
211 <title>Intentional Limitations</title>
212
213 <para>The following functionality supported in other Enea Linux releases
214 has been excluded in this release:<remark>INFO: This section might be
215 hidden by setting condition hidden on the section, MANUALLY in this
216 file.</remark><itemizedlist spacing="compact">
217 <listitem>
218 <para>Eclipse plug-ins for image creation (HOB)</para>
219 </listitem>
220
221 <listitem>
222 <para>Networking features: DPDK vSwitch, DPDK</para>
223 </listitem>
224
225 <listitem>
226 <para>Real-time features: Fully Preemptible Kernel (FPK) from the
227 PREEMPT_RT patch</para>
228 </listitem>
229
230 <listitem>
231 <para>Memory features: NUMA</para>
232 </listitem>
233 </itemizedlist></para>
234 </section>
235</chapter>