summaryrefslogtreecommitdiffstats
path: root/doc/book-enea-linux-release-info/doc/about_release.xml
blob: 0aadfb662866f7b56eb184581528546ead548ca2 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
<chapter id="relinfo-about-release">
  <title>About This Release</title>

  <para>This release of Enea Linux <xi:include href="eltf_params_updated.xml"
  xmlns:xi="http://www.w3.org/2001/XInclude"
  xpointer="element(EneaLinux_REL_VER/1)" /> provides a publicly available
  Enea Linux distribution for a selected set of targets. This release is
  generated from the Yocto Project <xi:include href="eltf_params_updated.xml"
  xmlns:xi="http://www.w3.org/2001/XInclude"
  xpointer="element(Yocto_VER/1)" /> distribution using the branch <xi:include
  href="eltf_params_updated.xml" xmlns:xi="http://www.w3.org/2001/XInclude"
  xpointer="element(Yocto_NAME/1)" />.<remark>INFO <emphasis
  role="bold">eltf_params_updated.xml</emphasis> contains many parameters in
  the book, also in the open source books, and MUST be created FROM <emphasis
  role="bold">eltf_params_template.xml</emphasis>. </remark></para>

  <para><remark>The parameters are automatically used in the books, via
  xi:include statements, similar to how parameters from pardoc-distro.xml are
  included in the book. Read the file <emphasis
  role="bold">eltf_params_updated_template_how_to_use.txt</emphasis> for
  important details about formats and how to do! The idea is that ELTF will
  auto-create/update it.</remark></para>

  <section id="relinfo-provided-contents">
    <title>Provided Contents</title>

    <para>The current release contains documentation, prebuilt kernels and
    images, a bootloader and an SDK. The directories structure is detailed
    below:</para>

    <programlisting>-- Documentation/
   /* Enea Linux 8 documentation */
   -- intel-corei7-64/
        /* artifacts for the reference machine */
             -- deb/
                /* deb packages */
             -- images/
                -- enea-image-rt
                   /* precompiled artifacts for the platform release image */
                    -- various artifacts (rootfs, kernel, config, dtb etc.)
                -- enea-image-rt-sdk
                   /* precompiled artifacts for the development process. The image
                      contains userspace tools and kernel configurations necessary
                      for developing, debugging and profiling applications and \
                      kernel modules */
                    -- various artifacts
             -- esdk
                /* Extensible SDK related artifacts including SDK installer and  */
                    /* manifests, self-extracting archive installing cross-compilation
                      toolchain for the platform */
                   -- x86_64-buildtools-nativesdk-standalone-8.0.sh
                      /* self-extracting archive installing additional tools
                         for the host machine */</programlisting>

    <para>The following set of artifacts is available:</para>

    <programlisting>--bzImage
   /* kernel image */
-- bzImage-&lt;target&gt;.bin
   /* kernel image, same as above */
-- config-&lt;target&gt;.config
   /* kernel configuration file */
-- enea-image-standard-&lt;target&gt;.ext4
   /* compressed EXT4 image of the rootfs */
-- enea-image-standard-&lt;target&gt;.tar.gz
   /* tar archive of the image */
-- modules-&lt;target&gt;.tgz
  /* external kernel modules */</programlisting>
  </section>

  <section id="relinfo-supported-host-environment">
    <title>Supported Host Environment</title>

    <para>The following environments have been validated as host environments
    for this release of Enea Linux: <emphasis role="bold">Ubuntu 16.04 LTS,
    64-bit</emphasis>.</para>

    <para><remark>INFO Below is a complete section with ID
    "eltf-target-tables-section" included from elft_params_updated.xml. It
    contains a variable number of target tables and the section title should
    be "Supported Targets with Parameters". It has have a short sentence about
    what it is in the beginning. The subtitles shall have the directory name
    of the target in the manifest.</remark></para>
  </section>

  <xi:include href="eltf_params_updated.xml"
              xmlns:xi="http://www.w3.org/2001/XInclude"
              xpointer="element(eltf-target-tables-section)" />

  <section id="relinfo-packages">
    <title>Provided Packages</title>

    <para><informaltable>
        <tgroup cols="2">
          <colspec align="left" colname="c1" colwidth="3*" />

          <colspec align="left" colname="c2" colwidth="6*" />

          <thead valign="bottom">
            <row>
              <entry>Type of Packages</entry>

              <entry>Reference</entry>
            </row>
          </thead>

          <tbody>
            <row>
              <entry>Packages in Enea Linux</entry>

              <entry><para>See the <olink
              targetdoc="book_enea_linux_open_source_rt"
              targetptr="book_enea_linux_open_source_rt"><trademark
              class="registered">Enea</trademark> Linux Open Source
              Report</olink></para></entry>
            </row>
          </tbody>
        </tgroup>
      </informaltable></para>
  </section>

  <section id="relinfo-provided-sdk">
    <title>Provided Toolchains (SDK)</title>

    <para>The SDK contains toolchains supporting cross-compilation of
    applications for the targets on an aarch64 host. For information on how to
    build and install a toolchain, see the chapter <olink
    targetdoc="book_enea_linux_user_guide_rt"
    targetptr="using_enealinux">Using Enea Linux, in the <xi:include
    href="../../s_docbuild/olinkdb/pardoc-names.xml"
    xmlns:xi="http://www.w3.org/2001/XInclude"
    xpointer="element(book_enea_linux_user_guide_standard/1)" /></olink>.
    <remark>INFO: This should be changed to book_enea_linux_user_guide_rt </remark>
    </para>
  </section>

  <section id="relinfo-documentation">
    <title>Provided Documentation</title>

    <para>The following Enea Linux manuals are available:</para>

    <itemizedlist spacing="compact">
      <listitem>
        <para><trademark class="registered">Enea</trademark> Linux Release
        Information (this document)</para>
      </listitem>

      <listitem>
        <para><olink targetdoc="book_enea_linux_user_guide_rt"
        targetptr="book_enea_linux_user_guide_rt"><trademark
        class="registered">Enea</trademark> Linux User's Guide</olink></para>
      </listitem>

      <listitem>
        <para><olink targetdoc="book_enea_linux_open_source_rt"
        targetptr="book_enea_linux_open_source_rt"><trademark
        class="registered">Enea</trademark> Linux Open Source
        Report</olink></para>
      </listitem>

      <listitem>
        <para><trademark class="registered">Enea</trademark> Linux Test
        Report</para>
      </listitem>

      <listitem>
        <para><trademark class="registered">Enea</trademark> Linux Security
        Report</para>
      </listitem>

      <listitem>
        <para><trademark class="registered">Enea</trademark><ulink
        url="http://linuxrealtime.org"> Linux Real-Time Guide</ulink></para>
      </listitem>
    </itemizedlist>
  </section>

  <section condition="hidden" id="relinfo-provided-other">
    <title>Other Provided Functionality</title>

    <para>The functionality in a distribution depends on included packages in
    the default image. In addition to the supported features, the following
    functionality is also available, among other:<remark>INFO: This section
    might be hidden by setting condition hidden on the section, MANUALLY in
    this file</remark></para>

    <itemizedlist spacing="compact">
      <listitem>
        <para>APT Package Management</para>
      </listitem>

      <listitem>
        <para>Eclipse ADT (excl. QEMU) and plug-ins for application
        development: LTTng, Perf, LatencyTOP, PowerTOP, SystemTap</para>
      </listitem>
    </itemizedlist>
  </section>

  <section id="relinfo-security-fixes">
    <title>Security Fixes</title>

    <para>See the <ulink
    url="https://www.enea.com/products/security/security-updates/">List of
    CVEs addressed in Enea Linux</ulink> for details.</para>
  </section>

  <section condition="hidden" id="relinfo-excluded">
    <title>Intentional Limitations</title>

    <para>The following functionality supported in other Enea Linux releases
    has been excluded in this release:<remark>INFO: This section might be
    hidden by setting condition hidden on the section, MANUALLY in this
    file.</remark><itemizedlist spacing="compact">
        <listitem>
          <para>Eclipse plug-ins for image creation (HOB)</para>
        </listitem>

        <listitem>
          <para>Networking features: DPDK vSwitch, DPDK</para>
        </listitem>

        <listitem>
          <para>Real-time features: Fully Preemptible Kernel (FPK) from the
          PREEMPT_RT patch</para>
        </listitem>

        <listitem>
          <para>Memory features: NUMA</para>
        </listitem>
      </itemizedlist></para>
  </section>
</chapter>