summaryrefslogtreecommitdiffstats
path: root/doc/book-enea-linux-release-info/doc
diff options
context:
space:
mode:
authorSona Sarmadi <sona.sarmadi@enea.com>2018-08-28 07:11:55 +0200
committerSona Sarmadi <sona.sarmadi@enea.com>2018-08-29 12:20:43 +0200
commita6d4e68bf121a3d0e1e626f4d288ad2b594947e2 (patch)
treeca5a1852672f31e3d9ae3eb86c499891bee6e80a /doc/book-enea-linux-release-info/doc
parent77870b91014d5f28f2555149db1c8ef193f24f3b (diff)
downloadel_releases-rt-a6d4e68bf121a3d0e1e626f4d288ad2b594947e2.tar.gz
First draft of doc copied from standard profile
-updated rel-info -updated UG -added new chapterdoc for RT: Real-Time in Enea Linux Change-Id: If8cec0e29d1d6aa4a09507881d815af13dd68ee2 Signed-off-by: Sona Sarmadi <sona.sarmadi@enea.com>
Diffstat (limited to 'doc/book-enea-linux-release-info/doc')
-rw-r--r--doc/book-enea-linux-release-info/doc/about_release.xml235
-rw-r--r--doc/book-enea-linux-release-info/doc/book.xml22
-rw-r--r--doc/book-enea-linux-release-info/doc/build_boot_template.xml34
-rw-r--r--doc/book-enea-linux-release-info/doc/eltf_params_template.xml151
-rw-r--r--doc/book-enea-linux-release-info/doc/eltf_params_updated.xml282
-rw-r--r--doc/book-enea-linux-release-info/doc/eltf_params_updated_template_how_to_use.txt320
-rw-r--r--doc/book-enea-linux-release-info/doc/getting_enea_linux.xml185
-rw-r--r--doc/book-enea-linux-release-info/doc/jiraissues_override.xml32
-rw-r--r--doc/book-enea-linux-release-info/doc/known_bugs_and_limitations.xml377
-rw-r--r--doc/book-enea-linux-release-info/doc/main_changes.xml54
-rw-r--r--doc/book-enea-linux-release-info/doc/prerequisites.xml34
-rw-r--r--doc/book-enea-linux-release-info/doc/system_requirements.xml159
12 files changed, 1885 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>
diff --git a/doc/book-enea-linux-release-info/doc/book.xml b/doc/book-enea-linux-release-info/doc/book.xml
new file mode 100644
index 0000000..13aff10
--- /dev/null
+++ b/doc/book-enea-linux-release-info/doc/book.xml
@@ -0,0 +1,22 @@
1<?xml version="1.0" encoding="ISO-8859-1"?>
2<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
3"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
4<!ENTITY % local.common.attrib "xml:base CDATA #IMPLIED">
5]>
6<book id="book_enea_linux_release_info_rt">
7 <title><trademark class="registered">Enea</trademark> Linux Release Information</title>
8 <subtitle>Release Version
9 <xi:include href="eltf_params_updated.xml" xpointer="element(EneaLinux_REL_VER/1)"
10 xmlns:xi="http://www.w3.org/2001/XInclude" /></subtitle>
11 <!-- OLINKDBPATH_USED_BY_XMLMIND ../../s_docbuild/olinkdb -->
12 <xi:include href="../../s_docbuild/template/docsrc_common/bookinfo_userdoc.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
13 <xi:include href="about_release.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
14 <!--
15 <xi:include href="prerequisites.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
16 <xi:include href="getting_enea_linux.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
17 <xi:include href="build_boot_generated.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
18 -->
19 <xi:include href="main_changes.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
20 <xi:include href="known_bugs_and_limitations.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
21 <xi:include href="../../s_docbuild/template/docsrc_common/contacting_enea_enea_linux.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
22</book>
diff --git a/doc/book-enea-linux-release-info/doc/build_boot_template.xml b/doc/book-enea-linux-release-info/doc/build_boot_template.xml
new file mode 100644
index 0000000..e39dd81
--- /dev/null
+++ b/doc/book-enea-linux-release-info/doc/build_boot_template.xml
@@ -0,0 +1,34 @@
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-build-boot">
5 <title>Target Specific Instructions</title>
6
7 <para>If the source has been fetched (<xref
8 linkend="relinfo-getting-source" />), there will be a target specific README
9 file containing the build and boot instructions. To make it easier for the
10 reader, the contents of this file(s) have been extracted into the following
11 sections.</para>
12
13 <note>
14 <para>The build process duration may vary and be longer than expected in
15 some cases, depending on the individual build resources and parameters of
16 each target/machine supported in this release.</para>
17 </note>
18
19 <para><remark>NOTE: Only EDIT THE TEMPLATE build_boot_template.xml file here
20 and also only edit the manifest template ".README" (name starting by a dot)!
21 A new build_boot_generated.xml file is created from the template and
22 sections are added below automatically from the README files for each target
23 when building the book! Only in the template file you see a line below with
24 SCRIPT_...._HERE and the text telling that this is a template
25 file.</remark></para>
26
27 <para>SCRIPT_INCLUDES_BUILD_BOOT_SECTIONS_HERE</para>
28
29 <para><emphasis role="bold">This is a template file which you can edit. When
30 the book is built, a new XML chapter file is created where the above part of
31 this file is copied to the new XML file and all from the line above is
32 replaced automatically by build and boot sections from the README
33 files!</emphasis></para>
34</chapter> \ No newline at end of file
diff --git a/doc/book-enea-linux-release-info/doc/eltf_params_template.xml b/doc/book-enea-linux-release-info/doc/eltf_params_template.xml
new file mode 100644
index 0000000..278ad71
--- /dev/null
+++ b/doc/book-enea-linux-release-info/doc/eltf_params_template.xml
@@ -0,0 +1,151 @@
1<?xml version="1.0" encoding="ISO-8859-1"?>
2<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
3"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
4<section id="eltf_created_params">
5 <title>File with Parameters in the Book Auto-updated by ELFT</title>
6
7 <note>
8 <para>See the <emphasis
9 role="bold">eltf_params_updated_template_howto_use.txt</emphasis> text
10 file for description of how to create the final <emphasis
11 role="bold">eltf_params_updated.xml</emphasis> from this template and for
12 all <emphasis role="bold">REQUIREMENTS</emphasis>. Use the command
13 "<emphasis role="bold">make eltf</emphasis>" to extract a full list of all
14 ELTF variables, which always begins with ELTF_ and don't only rely on the
15 howto text file list! The plan is that ELTF will auto-update this when
16 needed.</para>
17 </note>
18
19 <section id="host_prereq">
20 <title>Common Parameters</title>
21
22 <bridgehead>A programlisting, ID
23 "eltf-prereq-apt-get-commands-host"</bridgehead>
24
25 <para id="eltf-prereq-apt-get-commands-host"><programlisting>ELTF_PL_HOST_PREREQ</programlisting></para>
26
27 <bridgehead>A programlisting, ID
28 "eltf-getting-repo-install-command"</bridgehead>
29
30 <para id="eltf-getting-repo-install-command"><programlisting>ELTF_PL_GET_REPO</programlisting></para>
31
32 <bridgehead>Several phrase elements, various IDs. Ensure EL_REL_VER is
33 correct also compared to the "previous" REL VER in pardoc-distro.xml
34 "prev_baseline".</bridgehead>
35
36 <para id="EneaLinux_REL_VER"><phrase>ELTF_EL_REL_VER</phrase></para>
37
38 <para id="Yocto_VER"><phrase>ELTF_YOCTO_VER</phrase></para>
39
40 <para id="Yocto_NAME"><phrase>ELTF_YOCTO_NAME</phrase></para>
41
42 <para id="ULINK_YOCTO_PROJECT_DOWNLOAD"><ulink
43 url="ELTF_YOCTO_PROJ_DOWNLOAD_URL">ELTF_YOCTO_PROJ_DOWNLOAD_TXTURL</ulink></para>
44
45 <para id="ULINK_ENEA_LINUX_URL"><ulink
46 url="ELTF_EL_DOWNLOAD_URL">ELTF_EL_DOWNLOAD_TXTURL</ulink></para>
47
48 <bridgehead>A programlisting, ID "eltf-repo-cloning-enea-linux". Use
49 $MACHINE/default.xml as parameter, where MACHINE is one of the target
50 directory names in the manifest.</bridgehead>
51
52 <para id="eltf-repo-cloning-enea-linux"><programlisting>ELTF_PL_CLONE_W_REPO</programlisting></para>
53
54 <bridgehead>A table with ONE row, only the row with ID
55 "eltf-eclipse-version-row" is included in the book. MANUALLY BOTH in the
56 template.xml and in the updated.xml, set condition hidden on the
57 &lt;row&gt;, if eclipse is not in the release.</bridgehead>
58
59 <informaltable>
60 <tgroup cols="1">
61 <tbody>
62 <row id="eltf-eclipse-version-row">
63 <entry>Eclipse version ELTF_ECLIPSE_VERSION plus command line
64 development tools are included in this Enea Linux release.</entry>
65 </row>
66 </tbody>
67 </tgroup>
68 </informaltable>
69
70 <bridgehead>Below is one big section with title "Supported Targets with
71 Parameters". The entire section is included completely in the book via ID
72 "eltf-target-tables-section" and shall be LAST in the template. The
73 template contains ONE target subsection. COPY/APPEND it, if multiple
74 targets exist in the release and optionally add rows with additional
75 target parameters in each target subsection table.</bridgehead>
76 </section>
77
78 <section id="eltf-target-tables-section">
79 <title>Supported Targets with Parameters</title>
80
81 <para>The tables below describes the target(s) supported in this Enea
82 Linux release.</para>
83
84 <section id="eltf-target-table-ELTF_T_MANIFEST_DIR">
85 <title>MACHINE ELTF_T_MANIFEST_DIR - Information</title>
86
87 <para><informaltable>
88 <tgroup cols="2">
89 <colspec colwidth="6*" />
90
91 <colspec colwidth="9*" />
92
93 <tbody>
94 <row>
95 <entry>Target official name</entry>
96
97 <entry>ELTF_T_NAME</entry>
98 </row>
99
100 <row>
101 <entry>Architecture and Description</entry>
102
103 <entry>ELTF_T_ARC_DESC</entry>
104 </row>
105
106 <row>
107 <entry>Link to target datasheet</entry>
108
109 <entry>See <ulink
110 url="ELTF_T_DS_URL">ELTF_T_DS_TXTURL</ulink></entry>
111 </row>
112
113 <row>
114 <entry>Poky version</entry>
115
116 <entry>ELTF_T_POKY_VER</entry>
117 </row>
118
119 <row>
120 <entry>GCC version</entry>
121
122 <entry>ELTF_T_GCC_VER</entry>
123 </row>
124
125 <row>
126 <entry>Linux Kernel Version</entry>
127
128 <entry>ELTF_T_KERN_VER</entry>
129 </row>
130
131 <row>
132 <entry>Supported Drivers</entry>
133
134 <entry>ELTF_T_DRIVERS</entry>
135 </row>
136
137 <row>
138 <entry>Enea rpm folder for downloading RPM packages for this
139 target</entry>
140
141 <entry><ulink
142 url="ELTF_T_EL_RPM_URL">ELTF_T_EL_RPM_TXTURL</ulink></entry>
143 </row>
144 </tbody>
145 </tgroup>
146 </informaltable></para>
147 </section>
148
149 <!-- ELTFADD_MORE_TARGET_SECTIONS_BELOW_IF_NEEDED -->
150 </section>
151</section> \ No newline at end of file
diff --git a/doc/book-enea-linux-release-info/doc/eltf_params_updated.xml b/doc/book-enea-linux-release-info/doc/eltf_params_updated.xml
new file mode 100644
index 0000000..dfcee4a
--- /dev/null
+++ b/doc/book-enea-linux-release-info/doc/eltf_params_updated.xml
@@ -0,0 +1,282 @@
1<?xml version="1.0" encoding="ISO-8859-1"?>
2<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
3"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
4<section id="eltf_created_params">
5 <title>File with Parameters in the Book Auto-updated by ELFT</title>
6
7 <note>
8 <para>See the <emphasis
9 role="bold">eltf_params_updated_template_howto_use.txt</emphasis> text
10 file for description of how to create the final <emphasis
11 role="bold">eltf_params_updated.xml</emphasis> from this template and for
12 all <emphasis role="bold">REQUIREMENTS</emphasis>. Use the command
13 "<emphasis role="bold">make eltf</emphasis>" to extract a full list of all
14 ELTF variables, which always begins with ELTF_ and don't only rely on the
15 howto text file list! The plan is that ELTF will auto-update this when
16 needed.</para>
17 </note>
18
19 <section id="host_prereq">
20 <title>Common Parameters</title>
21
22 <bridgehead>A programlisting, ID
23 "eltf-prereq-apt-get-commands-host"</bridgehead>
24
25 <para id="eltf-prereq-apt-get-commands-host"><programlisting># Host Ubuntu 16.04.2 LTS 64bit
26sudo apt-get -y update
27sudo apt-get -y install sed wget subversion git-core coreutils unzip texi2html \
28 texinfo libsdl1.2-dev docbook-utils fop gawk python-pysqlite2 diffstat \
29 make gcc build-essential xsltproc g++ desktop-file-utils chrpath \
30 libgl1-mesa-dev libglu1-mesa-dev autoconf automake groff libtool xterm \
31 libxml-parser-perl</programlisting></para>
32
33 <bridgehead>A programlisting, ID
34 "eltf-getting-repo-install-command"</bridgehead>
35
36 <para id="eltf-getting-repo-install-command"><programlisting>mkdir -p ~/bin
37curl https://storage.googleapis.com/git-repo-downloads/repo &gt; ~/bin/repo
38chmod a+x ~/bin/repo
39export PATH=~/bin:$PATH</programlisting></para>
40
41 <bridgehead>Several phrase elements, various IDs. Ensure EL_REL_VER is
42 correct also compared to the "previous" REL VER in pardoc-distro.xml
43 "prev_baseline".</bridgehead>
44
45 <para id="EneaLinux_REL_VER"><phrase>8</phrase></para>
46
47 <para id="Yocto_VER"><phrase>2.5</phrase></para>
48
49 <para id="Yocto_NAME"><phrase>sumo</phrase></para>
50
51 <para id="ULINK_YOCTO_PROJECT_DOWNLOAD"><ulink
52 url="http://www.yoctoproject.org/downloads">http://www.yoctoproject.org/downloads</ulink></para>
53
54 <para id="ULINK_ENEA_LINUX_URL"><ulink
55 url="http://linux.enea.com/EneaLinux7.0">http://linux.enea.com/EneaLinux8.0</ulink></para>
56
57 <bridgehead>A programlisting, ID "eltf-repo-cloning-enea-linux". Use
58 $MACHINE/default.xml as parameter, where MACHINE is one of the target
59 directory names in the manifest.</bridgehead>
60
61 <para id="eltf-repo-cloning-enea-linux"><programlisting>mkdir enea-linux
62cd enea-linux
63repo init -u git@git.enea.com:linux/manifests/el_manifests-rt.git \
64 -b refs/tags/Enea_Linux_8.0 -m $MACHINE/default.xml
65repo sync</programlisting></para>
66
67 <bridgehead>A table with ONE row, only the row with ID
68 "eltf-eclipse-version-row" is included in the book. MANUALLY in book, set
69 condition hidden if eclipse is not in the release.</bridgehead>
70
71 <informaltable>
72 <tgroup cols="1">
73 <tbody>
74 <row id="eltf-eclipse-version-row">
75 <entry>Eclipse version 4.7 (Oxygen) plus command line development
76 tools are included in this Enea Linux release.</entry>
77 </row>
78 </tbody>
79 </tgroup>
80 </informaltable>
81
82 <bridgehead>Below is one big section with title "Supported Targets with
83 Parameters". The entire section is included completely in the book via ID
84 "eltf-target-tables-section" and shall be LAST in the template. The
85 template contains ONE target subsection. COPY/APPEND it, if multiple
86 targets exist in the release and optionally add rows with additional
87 target parameters in each target subsection table.</bridgehead>
88 </section>
89
90 <section id="eltf-target-tables-section">
91 <title>Supported Reference Boards with Parameters</title>
92
93 <para>The table(s) below describes the target(s) supported in this Enea
94 Linux release.</para>
95
96 <table>
97 <title>MACHINE Information Intel Xeon D</title>
98
99 <tgroup cols="2">
100 <colspec align="center" />
101
102 <thead>
103 <row>
104 <entry align="center">Component</entry>
105
106 <entry align="center">Description</entry>
107 </row>
108 </thead>
109
110 <tbody>
111 <row>
112 <entry align="left">Target official name</entry>
113
114 <entry>Intel Xeon D</entry>
115 </row>
116
117 <row>
118 <entry align="left">Architecture and Description</entry>
119
120 <entry>x86-64</entry>
121 </row>
122
123 <row>
124 <entry align="left">Link to target datasheet</entry>
125
126 <entry><ulink
127 url="https://www.intel.com/content/www/us/en/processors/xeon/xeon-d-1500-datasheet-vol-1.html">Intel
128 Xeon D datasheet</ulink></entry>
129 </row>
130
131 <row>
132 <entry align="left">Poky version</entry>
133
134 <entry>Git-commit-id: TBD</entry>
135 </row>
136
137 <row>
138 <entry align="left">GCC version</entry>
139
140 <entry>7.3</entry>
141 </row>
142
143 <row>
144 <entry align="left">Linux Kernel Version</entry>
145
146 <entry>4.14</entry>
147 </row>
148
149 <row condition="hidden">
150 <entry align="left">Supported Drivers</entry>
151
152 <entry>Ethernet, RTC, UART</entry>
153 </row>
154 </tbody>
155 </tgroup>
156 </table>
157
158 <table>
159 <title>MACHINE Information Intel Atom C3000</title>
160
161 <tgroup cols="2">
162 <colspec align="center" />
163
164 <thead>
165 <row>
166 <entry align="center">Component</entry>
167
168 <entry align="center">Description</entry>
169 </row>
170 </thead>
171
172 <tbody>
173 <row>
174 <entry align="left">Target official name</entry>
175
176 <entry>Intel Atom C3000</entry>
177 </row>
178
179 <row>
180 <entry align="left">Architecture and Description</entry>
181
182 <entry>x86-64</entry>
183 </row>
184
185 <row>
186 <entry align="left">Link to target datasheet</entry>
187
188 <entry><ulink
189 url="https://www.intel.com/content/www/us/en/products/docs/processors/atom/c-series/c3000-family-datasheet.html">Intel
190 Atom datasheet</ulink></entry>
191 </row>
192
193 <row>
194 <entry align="left">Poky version</entry>
195
196 <entry>Git-commit-id: TBD</entry>
197 </row>
198
199 <row>
200 <entry align="left">GCC version</entry>
201
202 <entry>7.3</entry>
203 </row>
204
205 <row>
206 <entry align="left">Linux Kernel Version</entry>
207
208 <entry>4.14</entry>
209 </row>
210
211 <row condition="hidden">
212 <entry align="left">Supported Drivers</entry>
213
214 <entry>Ethernet, RTC, UART</entry>
215 </row>
216 </tbody>
217 </tgroup>
218 </table>
219
220 <table>
221 <title>MACHINE Information Intel NUC Kaby Lake</title>
222
223 <tgroup cols="2">
224 <colspec align="center" />
225
226 <thead>
227 <row>
228 <entry align="center">Component</entry>
229
230 <entry align="center">Description</entry>
231 </row>
232 </thead>
233
234 <tbody>
235 <row>
236 <entry align="left">Target official name</entry>
237
238 <entry>Intel NUC Kaby Lake</entry>
239 </row>
240
241 <row>
242 <entry align="left">Architecture and Description</entry>
243
244 <entry>x86-64</entry>
245 </row>
246
247 <row>
248 <entry align="left">Link to target datasheet</entry>
249
250 <entry><ulink
251 url="https://www.intel.com/content/dam/www/public/us/en/documents/product-briefs/nuc-kit-nuc7i5bnh-nuc7i5bnk-brief.pdf">Intel
252 NUC Kaby Lake datasheet</ulink></entry>
253 </row>
254
255 <row>
256 <entry align="left">Poky version</entry>
257
258 <entry>Git-commit-id: TBD</entry>
259 </row>
260
261 <row>
262 <entry align="left">GCC version</entry>
263
264 <entry>7.3</entry>
265 </row>
266
267 <row>
268 <entry align="left">Linux Kernel Version</entry>
269
270 <entry>4.14</entry>
271 </row>
272
273 <row condition="hidden">
274 <entry align="left">Supported Drivers</entry>
275
276 <entry>Ethernet, RTC, UART</entry>
277 </row>
278 </tbody>
279 </tgroup>
280 </table>
281 </section>
282</section>
diff --git a/doc/book-enea-linux-release-info/doc/eltf_params_updated_template_how_to_use.txt b/doc/book-enea-linux-release-info/doc/eltf_params_updated_template_how_to_use.txt
new file mode 100644
index 0000000..6e1358f
--- /dev/null
+++ b/doc/book-enea-linux-release-info/doc/eltf_params_updated_template_how_to_use.txt
@@ -0,0 +1,320 @@
1eltf_params_template_updated_howto_use.txt
2
3This is a way to collect all parameters for an Enea Linux release
4in one parameter file, easy to automatically update by ELTF regularly.
5
6NOTE: Both the release info AND the open source books use parameters from
7 here, but the XML file is inside the release info book directory.
8
9NOTE: The manifest_conf.mk, or overridden by the environment variable
10 MANIFESTHASH, contains the full tag (or hashvalue) for downloading
11 the manifest when the books are built. The list of target
12 directories are fetched from the manifest into the book.
13 The eltf_params_updates.xml can all the time contain
14 the final next complete tag e.g. refs/tags/EL6 or similar
15 in the ELTF_PL_CLONE_W_REPO parameter command lines.
16
17The ordinary book XML files use xi:include statements to include elements
18from this parameter file. The book XML files can thus be manually edited.
19Before editing, you must run "make init".
20Any other text in the template or updated.xml file, outside the parts that
21are included in the book, are not used but still all must be correct
22DocBook XML files.
23
24ELTF work:
25 template => ELTF replaces ALL ELTF_xxx variables => updated XML file
26 => push to git only if changed
27
28
29eltf_params_template.xml (in git)
30 File used by ELTF to autocreate/update the real parameter
31 file eltf_params_updated.xml.
32
33eltf_params_updated.xml (in git)
34 Real parameter file where ELTF has replaced all ELTF_xx variables with
35 strings, in several cases with multiline strings.
36 No spaces or linefeed allowed in beginning or end of the variable values!
37
38
39xi:include: Each parameter is xi:include'ed in various book files, using
40 the IDs existing in the parameter files.
41 In most cases the 1:st element inside an element with an ID is included
42 using a format like eltf-prereq-apt-get-commands-host/1.
43 In very few cases the element with the ID is included in the book, one
44 example is the target section which has an ID, but which contains
45 multiple subsections, one per target.
46 All IDs in a book must be unique.
47
48DocBook XML: All XML files must be correct DocBook XML files.
49
50Do NOT edit/save the real *updated.xml file with XMLmind to avoid changes
51 not done by ELTF. But it is OK to open the real file in XMLmind to
52 check that the format is correct.
53
54ELTF should autocreate a temporary "real" file but only replace
55 and push the eltf_params_updated.xml if it is changed.
56
57
58make eltf
59 This lists all ELTF_xxx variables and some rules how to treat them
60
61DocBook Format: All elements - rules:
62 Several strict generic XML rules apply for all strings:
63 1. No TABs allowed or any other control chr than "linefeed"
64 2. Only 7-bit ASCII
65 3. Any < > & must be converted to &lt; &gt; and &amp;
66 Similar for any other non-7-bit-ASCII but avoid those!
67 4. No leading spaces or linefeeds when replacing the ELTF_* variable
68 5. No trailing spaces or linefeeds when replacing the ELTF_* variable
69 6. Note: Keep existing spaces before/efter ELTF_* in a few cases.
70
71DocBook Format: <programlisting> - rules: ELTF*PL* variables
72 Several strict rules apply for the multiline string in programlisting
73 in addition to the general XML rules above:
74 7. Max line length < 80 char
75 8. Use backslash (\) to break longer lines
76 9. Use spaces (e.g. 4) to indent continuation lines in programlistings
77 10. No trailing spaces on any line
78 11. No spaces or linefeed immediately after leading <programlisting>
79 12. No spaces or linefeed before trailing </programlisting>
80
81DocBook Format: <ulink> - rules: ELTF_*URL* variables
82 13. ELTF_*URL and corresponding ELTF_*TXTURL shall be identical strings
83 14. Only if the URL is extremely long, the TXTURL can be a separate string
84
85Each target has one section with target parameters:
86 <section id="eltf-target-table-ELTF_T_MANIFEST_DIR">
87 <title>MACHINE ELTF_T_MANIFEST_DIR - Information</title>
88 ..... with many ELTF_ variables ....
89 </section>
90
91 15. If there is only one target. ELTF just replaces ELTF parameters
92
93 16. It there are multiple targets. ELTF copies the section and appends the
94 section the required number of times.
95 Each section ID will become unique: eltf-target-table-ELTF_T_MANIFEST_DIR
96 Each section title will become unique
97
98Tables with target parameters in each target section:
99 17. It is possible for ELTF to append more rows with one parameter each
100 to these tables, because the entire tables are included in the book
101
102Special - NOT YET READY DEFINED how to handle the optionally included
103 Eclipse and its version, but this is a first suggestion:
104 18. Just now ELTF can define ELFT_ECLIPSE_VERSION as a full string
105 with both version number and name,
106 19. MANUALLY if Eclipse is NOT included in the release,
107 the release manager should manually set condition="hidden" on
108 the entire section in the book XML about Eclipse
109
110
111
112BELOW WE TRY TO EXPLAIN EACH ELTF_* variable, but always check with make eltf
113if there are more new variables, missing in this description file.
114
115_____________________________________________________________________________
116ELTF_PL_HOST_PREREQ Multiline list of host prerequisites, e.g. commands
117 like sudo apt-get install xxxx or similar.
118 First line = comment with the complete host name!
119 It is possible to include multiple hosts by just
120 adding an empty line, comment with host name, etc.
121 xi:include eltf-prereq-apt-get-commands-host/1
122 This is a <programlisting>...</programlisting>
123 Example:
124# Host Ubuntu 14.04.5 LTS 64bit
125sudo apt-get update
126sudo apt-get install sed wget subversion git-core coreutils unzip texi2html \
127 texinfo libsdl1.2-dev docbook-utils fop gawk python-pysqlite2 diffstat \
128 make gcc build-essential xsltproc g++ desktop-file-utils chrpath \
129 libgl1-mesa-dev libglu1-mesa-dev autoconf automake groff libtool xterm \
130 libxml-parser-perl
131
132_____________________________________________________________________________
133ELTF_PL_GET_REPO Multiline commands to download the repo tool
134 xi:include eltf-getting-repo-install-command/1
135 This is a <programlisting>...</programlisting>
136 Example:
137mkdir -p ~/bin
138curl https://storage.googleapis.com/git-repo-downloads/repo > ~/bin/repo
139chmod a+x ~/bin/repo
140export PATH=~/bin:$PATH
141
142_____________________________________________________________________________
143ELTF_EL_REL_VER General parameter string: The version of this Enea
144 Linux release. Major version and optional .Minor
145 Typically created from MAJOR and MINOR in enea.conf
146 MINOR in enea.conf is empty or contains a dot+minor
147 xi_include EneaLinux_REL_VER/1
148 This is a <phrase>X.x</phrase> used in many places.
149 Examples:
1506
151 or
1526.1
153
154_____________________________________________________________________________
155ELTF_YOCTO_VER General parameter string: Yocto version, created
156 from DISTRO in poky.ent
157 xi:include Yocto_VER/1
158 This is a <phrase>X.x</phrase> used in many places.
159 Example:
1602.5
161
162_____________________________________________________________________________
163ELTF_YOCTO_NAME General parameter string: Yocto name (branch), created
164 from DISTRO_NAME_NO_CAP in poky.ent
165 xi:include Yocto_NAME/1
166 This is a <phrase>X.x</phrase> used in many places.
167 Example:
168sumo
169
170_____________________________________________________________________________
171ELTF_YOCTO_PROJ_DOWNLOAD_TXTURL General parameters. These two are IDENTICAL
172ELTF_YOCTO_PROJ_DOWNLOAD_URL strings with correct Yocto version string
173 at the end, typically without "dot".
174 xi:include ULINK_YOCTO_PROJECT_DOWNLOAD/1
175 This is an <ulink url="...">...</ulink>
176 Example:
177http://www.yoctoproject.org/downloads
178
179_____________________________________________________________________________
180ELTF_EL_DOWNLOAD_TXTURL General parameters. These two are IDENTICAL strings
181ELTF_EL_DOWNLOAD_URL and shall be the http:/..... address where
182 Enea Linux can be downloaded
183 Often containing same version as in ELTF_EL_REL_VER
184 xi:include ULINK_ENEA_LINUX_URL/1
185 This is an <ulink url="...">...</ulink>
186 Example:
187http://linux.enea.com/8
188
189_____________________________________________________________________________
190ELTF_PL_CLONE_W_REPO Multiline commands to run repo to clone everything.
191 Use the variable $MACHINE/default.xml (the text in
192 the book will list the avaiable values of MACHINE,
193 taken from the manifest repository)
194 xi:include eltf-repo-cloning-enea-linux/1
195 This is a <programlisting>...</programlisting>
196 Example:
197mkdir enea-linux
198cd enea-linux
199repo init -u git@git.enea.com:linux/manifests/el_manifests-rt.git \
200 -b refs/tags/EL8 -m $MACHINE/default.xml
201repo sync
202
203_____________________________________________________________________________
204ELTF_ECLIPSE_VERSION Optional general parameter string.
205 NOT YET READY DEFINED
206 Just now a release manage must manually set
207 condition="hidden" on the Eclipse section,
208 if Eclipse is not included in the release.
209 ELTF just replaces ELTF_ECLIPSE_VERSION with a full
210 string with "X.Y (name)"
211 It includes the ID and can only be ONCE in the book.
212 xi:include eltf-eclipse-version-row
213 Example.
2144.5 (Mars)
215
216
217_____________________________________________________________________________
218ELTF_T_* All these are in each target (MACHINE) and ELTF
219 must separately replace them with strings for
220 each target
221 NOTE: All (except the MANIFEST_DIR) are in rows
222 in a table and ELTF can select to append
223 more parameters by adding more rows
224
225_____________________________________________________________________________
226ELTF_T_MANIFEST_DIR This happens to be in two places. Must be exactly
227ELTF_T_MANIFEST_DIR the directory name in the manifest, e.g. same
228 as the MACHINE names in $MACHINE/default.xml.
229 In book: a) Part of section ID
230 b) Part of section title
231 Examples:
232p2041rgb
233 or
234ls1021aiot
235 or
236qemuarm
237
238_____________________________________________________________________________
239ELTF_T_NAME Target specific: "Target Official Name"
240 NOT same as the target directory name in most cases.
241 In book: An <entry> element in a row
242 Examples:
243P2041RGB
244 or
245LS1021a-IoT
246 or
247qemuarm
248
249_____________________________________________________________________________
250ELTF_T_ARC_DESC Target specific: "Architecture and Description"
251 It can be a short identification string or
252 it can be a longer descriptive sentence.
253 In book: An <entry> element in a row
254 Examples:
255Power, e500mc
256 or
257ARM Cortex-A7
258
259_____________________________________________________________________________
260ELTF_T_DS_TXTURL Target specific: "Link to target datasheet. These
261ELTF_T_DS_URL two usually are IDENTICAL strings with correct
262 hyperlink to the target's official datasheet.
263 In book: an <ulink url="...">...</ulink>
264 Only if the link is VERY LONG, the text part shall
265 instead be a descriptive string (see 2:nd example).
266 NOTE: Also here no spaces or line-feeds!
267 Examples:
268url="http://wiki.qemu.org">http://wiki.qemu.org
269or
270url="http://www.nxp.com/products/microcontrollers-and-processors/arm-processors/qoriq-arm-processors/qoriq-ls1021a-iot-gateway-reference-design:LS1021A-IoT">link to NXP's datasheet
271
272_____________________________________________________________________________
273ELTF_T_POKY_VER Target specific: "Poky version" created either
274 from POKYVERSION in poky.ent
275 or using a hashvalue with a leading string, in
276 which case it may be different per target.
277 In book: An <entry> in a row
278 Examples:
27915.0.0
280or
281Git commit id: 75ca53211488a3e268037a44ee2a7ac5c7181bd2
282
283_____________________________________________________________________________
284ELTF_T_GCC_VER Target specific: "GCC Version". Should be in poky
285 but not easy to find among various parameters.
286 ELTF would extract it from build logs building SDK
287 and it is possibly different per target.
288 In book: An <entry> in a row
289 Example:
2905.3
291
292_____________________________________________________________________________
293ELTF_T_KERN_VER Target specific: "Linux Kernel Version". Often
294 different per target.
295 In book: An <entry> in a row
296 Example:
2973.12
298
299_____________________________________________________________________________
300ELTF_T_DRIVERS Target specific: "Supported Drivers". This is a
301 comma-separated list of driver names.
302 ELTF should create the list in same order for each
303 target, e.g. alphabetic migth be OK.
304 In book: An <entry> in a row
305 Example:
306Ethernet, I2C, SPI, PCI, USB, SD/SDHC/SDXC
307
308
309_____________________________________________________________________________
310ELTF_T_EL_RPM_TXTURL Target specific: "Enea rpm folder for downloading
311ELTF_T_EL_RPM_URL RPM packages for this target". These two are
312 INDENTICAL strings with hyperlink to the web site
313 at Enea where the customer can download RPMs
314 Note: Often the ELFT_EL_REL_VER value and
315 the ELTF_T_MANIFEST_DIR are used in the link.
316 In book: an <ulink url="...">...</ulink>
317 Example:
318url="https://linux.enea.com/6/ls1021aiot/rpm">https://linux.enea.com/6/ls1021aiot/rpm
319
320_____________________________________________________________________________
diff --git a/doc/book-enea-linux-release-info/doc/getting_enea_linux.xml b/doc/book-enea-linux-release-info/doc/getting_enea_linux.xml
new file mode 100644
index 0000000..76487ef
--- /dev/null
+++ b/doc/book-enea-linux-release-info/doc/getting_enea_linux.xml
@@ -0,0 +1,185 @@
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-getting-enea-linux">
5 <title>Getting Enea Linux</title>
6
7 <para>Enea Linux is available as both pre-built binary images and source
8 code. Both serve a specific purpose and each have their advantages. However,
9 using the pre-built binary images allows for getting up and running faster.
10 Please refer to the sections below for details on how to get Enea Linux as
11 pre-built binary images or source code.</para>
12
13 <section id="relinfo-getting-pre-built-images">
14 <title>Getting Pre-built Binaries</title>
15
16 <para>Enea Linux pre-built binaries are available for download on <ulink
17 url="https://portal.enea.com/login/?redirect_to=https%3A%2F%2Fportal.enea.com%2F">portal.enea.com</ulink>.
18 Log in using the credentials provided by Enea for your user account. Using
19 the menu, browse to the Linux section where you will now have access to
20 the <emphasis role="bold">Files</emphasis> and <emphasis
21 role="bold">Online Documentation</emphasis> sections.</para>
22
23 <para>The Files section lists each Enea Linux distribution, one for each
24 version and profile, as a separate download package. Clicking on the name
25 of the distribution will open a new page, which presents further details
26 about the content of the release and a list of downloadable archives, one
27 for each hardware target included in the release. Each archive provides
28 the following content:</para>
29
30 <itemizedlist>
31 <listitem>
32 <para><emphasis>images</emphasis> directory &ndash; this directory
33 includes the binary image files needed to boot the target with Enea
34 Linux. This includes the kernel, the root file system, device tree,
35 etc.</para>
36 </listitem>
37
38 <listitem>
39 <para><emphasis>sdk</emphasis> directory &ndash; this directory
40 includes the installer for the SDK.</para>
41 </listitem>
42
43 <listitem>
44 <para><emphasis>deb</emphasis> directory &ndash; this directory
45 contains all the packages included in the distribution in deb format,
46 which can be installed using the package manager.</para>
47 </listitem>
48 </itemizedlist>
49
50 <para>For faster downloads, each archive is mirrored in several places,
51 geographically. Choose the archive in the region closest to you.</para>
52
53 <para>The Documentation section lists all the documents delivered with the
54 release:</para>
55
56 <itemizedlist>
57 <listitem>
58 <para><emphasis role="bold">Enea Linux User&rsquo;s Guide</emphasis> -
59 intended for Enea Linux platform developers, who want to configure and
60 build customized Linux kernel images for embedded system targets,
61 using the Yocto configuration and build system.</para>
62 </listitem>
63
64 <listitem>
65 <para><emphasis role="bold">Enea Linux Open Source Report</emphasis> -
66 contains the open source and license information pertaining to
67 packages provided with this release of Enea Linux.</para>
68 </listitem>
69
70 <listitem>
71 <para><emphasis role="bold">Enea Linux Release Info</emphasis> -
72 provides information about the current released distribution for a
73 selected set of targets, along with installation requirements and
74 procedures.</para>
75 </listitem>
76 </itemizedlist>
77 </section>
78
79 <section id="relinfo-getting-source">
80 <title>Getting the Sources</title>
81
82 <para>Enea Linux sources are available for cloning from a set of Git
83 repositories on <ulink url="https://git.enea.com">git.enea.com</ulink>.
84 Since Enea Linux requires multiple repositories, Google Repo tool is used
85 in order to manage configurations and make the cloning step simpler. The
86 Google Repo tool uses files, known as manifests, which store a list of
87 tuples (repository URL, version). The Repo tool is then used to traverse
88 the list of tuples in the manifest file and clone the specified versions
89 of each repository. See <ulink
90 url="https://code.google.com/p/git-repo/">Google Code Archive for
91 git-repo</ulink>, for more info.</para>
92
93 <section id="getting-source-code-step-one">
94 <title>Get access to git.enea.com</title>
95
96 <para>In order to get access to git.enea.com, a ssh key is required for
97 Git authentication. If you don't already have such a key, follow the
98 steps below to generate one:</para>
99
100 <orderedlist>
101 <listitem>
102 <para>Generate the ssh key pair:</para>
103
104 <programlisting>$ ssh-keygen -t rsa</programlisting>
105
106 <para>When asked for a password, just press
107 <command>Enter</command>. This will create two files in the
108 <literal>.ssh</literal> directory in your home directory.</para>
109
110 <programlisting>id_rsa
111id_rsa.pub</programlisting>
112 </listitem>
113
114 <listitem>
115 <para>Copy the public key into an authorized_keys file:</para>
116
117 <programlisting>$ cat id_rsa.pub &gt;&gt; authorized_keys</programlisting>
118 </listitem>
119 </orderedlist>
120
121 <para>Once these steps are done and you have a valid ssh key pair, send
122 the public key,
123 <emphasis><emphasis><filename>id_rsa.pub</filename></emphasis></emphasis>,
124 via email to <email>mailto:git_support@list.enea.se</email> in order to
125 get access to <ulink
126 url="https://git.enea.com">git.enea.com</ulink>.</para>
127 </section>
128
129 <section id="getting-source-code-step-two">
130 <title>Get Sources</title>
131
132 <para>To use the Repo tool to download the sources for Enea Linux, do
133 the following:</para>
134
135 <orderedlist>
136 <listitem condition="hidden">
137 <para>Make sure that the repo tool is installed. If not, do the
138 following: <remark>Below is include of ID
139 "eltf-getting-repo-install-command" from
140 eltf_params_updated.xml</remark></para>
141
142 <xi:include href="eltf_params_updated.xml"
143 xmlns:xi="http://www.w3.org/2001/XInclude"
144 xpointer="element(eltf-getting-repo-install-command/1)" />
145 </listitem>
146
147 <listitem>
148 <para>Define the MACHINE to the following target listed
149 here:<remark>Below is the "machine_list" programlisting in
150 machine_list_generated.xml created by the make system by extracting
151 from the manifest</remark></para>
152
153 <xi:include href="machine_list_generated.xml"
154 xmlns:xi="http://www.w3.org/2001/XInclude"
155 xpointer="element(machine-list/1)" />
156 </listitem>
157
158 <listitem>
159 <para>Then use the repo command below:</para>
160
161 <xi:include href="eltf_params_updated.xml"
162 xmlns:xi="http://www.w3.org/2001/XInclude"
163 xpointer="element(eltf-repo-cloning-enea-linux/1)" />
164 </listitem>
165 </orderedlist>
166
167 <para>Once the source code is downloaded, the current directory will
168 contain a README file with instructions on how to build the distro and
169 boot the raspberry pi machine. For ease of use, these instructions are
170 also copied into this document, see <xref
171 linkend="relinfo-build-boot" />.</para>
172
173 <para>It is not necessary to explicitly clone the manifest repository
174 since that is done automatically by the repo tool. To see the current
175 manifest, use the following command:</para>
176
177 <programlisting>$ repo manifest</programlisting>
178
179 <remark>The UG should be updated with instructions on how to add
180 customizations. That section should also contain more info about the
181 manifest: the manifest templates, using a branch instead of the tag EL6,
182 etc. When this is done a reference from here should be added.</remark>
183 </section>
184 </section>
185</chapter> \ No newline at end of file
diff --git a/doc/book-enea-linux-release-info/doc/jiraissues_override.xml b/doc/book-enea-linux-release-info/doc/jiraissues_override.xml
new file mode 100644
index 0000000..331a5ae
--- /dev/null
+++ b/doc/book-enea-linux-release-info/doc/jiraissues_override.xml
@@ -0,0 +1,32 @@
1<?xml version="1.0" encoding="ISO-8859-1"?>
2<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
3"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
4<section id="relinfo_extracted_from_jira">
5 <title>Extracted from Jira</title>
6
7 <para>In the table below are the issue(s) that currently affect this specific release. Use the ticket reference provided for each issue, to look up further information if needed.</para>
8
9 <informaltable>
10 <tgroup cols="2">
11 <colspec colname="c1" colwidth="6*" />
12
13 <colspec align="center" colname="c2" colwidth="1*" />
14
15 <thead>
16 <row>
17 <entry align="center">Summary</entry>
18
19 <entry>Enea Ref</entry>
20 </row>
21 </thead>
22
23 <tbody>
24 <row>
25 <entry></entry>
26
27 <entry></entry>
28 </row>
29 </tbody>
30 </tgroup>
31 </informaltable>
32</section> \ No newline at end of file
diff --git a/doc/book-enea-linux-release-info/doc/known_bugs_and_limitations.xml b/doc/book-enea-linux-release-info/doc/known_bugs_and_limitations.xml
new file mode 100644
index 0000000..6fafb8d
--- /dev/null
+++ b/doc/book-enea-linux-release-info/doc/known_bugs_and_limitations.xml
@@ -0,0 +1,377 @@
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="bugs-limitations">
5 <title>Known Problems in this Release</title>
6
7 <para>Open source projects are continuously working on correcting reported
8 problems. Fixes and workarounds to bugs detected by Enea are submitted
9 upstream, and included in Enea Linux regardless of when they will be
10 included by the open source project. Issues that still affect the current
11 release are listed below.<remark>INFO: The <emphasis
12 role="bold">Release-Specific Problems</emphasis> section further down is
13 generated from JIRA with gen_known_issues.py, but that script is HARDCODED
14 with affectedversion "Enea Linux 6" and needs to be adapted when a release
15 info for another EL version changes.</remark></para>
16
17 <section id="bugs-limitations-yocto">
18 <title>Yocto Project</title>
19
20 <para>The Yocto Project community uses a <ulink
21 url="https://bugzilla.yoctoproject.org">Bugzilla database</ulink> to track
22 information on reported bugs and other issues.</para>
23 </section>
24
25 <section condition="hidden" id="bugs-limitations-sdk">
26 <title>Toolchain / SDK</title>
27
28 <itemizedlist spacing="compact">
29 <listitem>
30 <para>Building the kernel might fail if GNU Make of version 3.82 has
31 been installed on the host. The mandatory recovery action is to revert
32 to version 3.81.<remark>INFO It is possible to hide this entire
33 subsection by setting condition hidden on the section
34 element</remark></para>
35 </listitem>
36
37 <listitem>
38 <para>Installing a second toolchain in the same directory as a
39 previous one will break the $PATH variable of the first
40 one.<remark>LXCR-3624</remark></para>
41 </listitem>
42 </itemizedlist>
43 </section>
44
45 <section condition="hidden" id="bugs-limitations-eclipse">
46 <title>Eclipse Tools</title>
47
48 <para>The Eclipse tools provided together with Enea Linux are part of the
49 Yocto Project Application Development Toolkit (ADT) and are maintained by
50 different open source projects. The list below outlines current problems
51 with the plug-ins as such, as well as kernel limitations when using a tool
52 towards the mentioned target:<remark>INFO It is possible to hide this
53 setting condition hidden on the section element</remark></para>
54
55 <itemizedlist spacing="compact">
56 <listitem>
57 <para><emphasis role="bold">HOB</emphasis> is currently not supported
58 on Red Hat.<remark>LXCR-2994, LXCR-3222</remark></para>
59 </listitem>
60
61 <listitem>
62 <para><emphasis role="bold">SystemTap</emphasis> is currently not
63 supported on Red Hat.<remark>LXCR-3274</remark></para>
64 </listitem>
65
66 <listitem>
67 <para>When running <emphasis role="bold">SystemTap</emphasis> for the
68 first time on a target, you may need to manually ssh into the target
69 beforehand, in order to add the RSA key of the host to the file
70 known_hosts. Failing to do so will result in Eclipse freezing with the
71 progress window displayed, and a terminal message <literal>The
72 authenticity of host &lt;target_ip&gt; can't be
73 established</literal>.</para>
74 </listitem>
75
76 <listitem>
77 <para><emphasis role="bold">SystemTap</emphasis> scripts sometimes
78 result crosstap error messages about inaccessible variables. This is
79 not an issue with the tool itself, but stems from the compiler
80 optimizing away some of the variables. See workaround in the User's
81 Guide.<remark>LXCR-2204</remark></para>
82 </listitem>
83
84 <listitem>
85 <para>Currently <emphasis role="bold">BitBake Commander</emphasis>
86 projects can only be created for a local connection. Due to an
87 upstream bug, selecting a remote connection causes the Eclipse GUI to
88 freeze such that it must be killed.<remark>LXCR-2801</remark></para>
89 </listitem>
90
91 <listitem>
92 <para>A limitation currently makes <emphasis
93 role="bold">Eclipse</emphasis> non-responding when running a streaming
94 script, i.e. a script that runs continuously.</para>
95 </listitem>
96
97 <listitem>
98 <para>The <emphasis role="bold">LatencyTop</emphasis> plug-in for the
99 P2041 target reports some errors due to the permissions configuration
100 on the target, but it works correctly if the
101 <literal>latencytop</literal> command is issued from the Eclipse
102 console.<remark>LXCR-6303</remark></para>
103 </listitem>
104
105 <listitem>
106 <para>Currently <emphasis role="bold">LatencyTOP</emphasis> is not
107 available for ARM kernels built with SMP support due to an ARM
108 specific limitation in the Linux kernel.</para>
109 </listitem>
110
111 <listitem>
112 <para><emphasis role="bold">PowerTOP</emphasis> sometimes freezes
113 Eclipse after displaying a progress bar with message
114 <literal>Gathering powertop data file
115 remotely</literal>.<remark>LXCR-3143</remark></para>
116 </listitem>
117
118 <listitem>
119 <para>When running <emphasis role="bold">powertop</emphasis> from the
120 Eclipse terminal towards p2020rdb targets it is necessary to specify
121 the full path in order to find the
122 command.<remark>LXCR-2265</remark></para>
123 </listitem>
124
125 <listitem>
126 <para>When running <emphasis role="bold">powertop</emphasis> from the
127 Eclipse terminal towards zynq ZC702 targets it is necessary to specify
128 the full path in order to find the
129 command.<remark>LXCR-2265</remark></para>
130 </listitem>
131
132 <listitem>
133 <para>The <emphasis role="bold">PowerTOP</emphasis> console in Eclipse
134 might display messages like <literal>Cannot load
135 /var/cache/powertop/&lt;filename&gt;</literal>. As a workaround, run
136 <emphasis role="bold">powertop --calibrate</emphasis> for a while to
137 generate the missing files. See <ulink
138 url="https://bugzilla.redhat.com/show_bug.cgi?id=698020">Bugzilla
139 #698020</ulink>.<remark>LXCR-3575</remark></para>
140 </listitem>
141
142 <listitem>
143 <para><emphasis role="bold">ssh-only</emphasis> is currently the only
144 supported connection type when running Eclipse tools towards a
145 target.<remark>LXCR-2799</remark></para>
146 </listitem>
147
148 <listitem>
149 <para>Hyphen character '-' in the name of the <emphasis
150 role="bold">Yocto Project ADT AutoTools project</emphasis> can cause
151 configuration errors.<remark>LXCR-2290</remark></para>
152 </listitem>
153
154 <listitem>
155 <para>The <emphasis role="bold">LTTng</emphasis> tool does not work on
156 <emphasis role="bold">ARM</emphasis> targets, neither from within
157 Eclipse nor when run directly on target, due to a problem with
158 lttng-modules and gcc-4.8.x. See <ulink
159 url="https://bugzilla.yoctoproject.org/show_bug.cgi?id=6015">Bugzilla
160 #6015</ulink>.<remark>LXCR-2653, LXCR-3053</remark></para>
161 </listitem>
162
163 <listitem>
164 <para>When running <emphasis role="bold">LTTng</emphasis> from
165 Eclipse, it sometimes happens that a new session created in the
166 Control View does not immediately appear under Sessions for that
167 target. However, the session is created and will appear after
168 right-clicking "Sessions" and selecting "Refresh".</para>
169 </listitem>
170
171 <listitem>
172 <para>The<emphasis role="bold"> yocto-bsp</emphasis> properties page
173 has some problems in the graphical user interface. Occasionally it is
174 not possible to resize and scroll which makes it impossible to see the
175 lower part of the properties window.<remark>LXCR-3128</remark></para>
176 </listitem>
177
178 <listitem>
179 <para>When connecting an Eclipse project configured for <emphasis
180 role="bold">KGDB</emphasis> (GDB Hardware Debugging) to a 64-bit
181 PowerPC target, GDB fails to connect unless the architecture is
182 specified in <filename>.gdbinit</filename>. See <ulink
183 url="https://bugs.eclipse.org/bugs/show_bug.cgi?id=457697">Bugzilla
184 #457697</ulink>.<remark>LXCR-3984</remark></para>
185 </listitem>
186 </itemizedlist>
187 </section>
188
189 <section condition="hidden" id="bugs-limitations-target-side-tools">
190 <title>Target-Side Tools</title>
191
192 <para>The target-side tools can be run stand-alone on target or from
193 Eclipse on host. The issues below are only observed when running the tools
194 directly on target:<remark>INFO It is possible to hide this setting
195 condition hidden on the section element</remark></para>
196
197 <itemizedlist spacing="compact">
198 <listitem>
199 <para>The <emphasis role="bold">perf report</emphasis> command hangs
200 or crashes due to segmentation fault on ARM
201 targets.<remark>LXCR-2708</remark></para>
202 </listitem>
203
204 <listitem>
205 <para>The <emphasis role="bold">perf report</emphasis> does not show
206 any output for the PandaBoard target.<remark>LXCR-2710</remark></para>
207 </listitem>
208
209 <listitem>
210 <para><emphasis role="bold">perf top</emphasis> displays for a few
211 seconds the error message <literal>Failed to open
212 /tmp/perf-388.map</literal>. Any attempt to exit the subsequent window
213 causes the system to hang.<remark>LXCR-3113</remark></para>
214 </listitem>
215
216 <listitem>
217 <para>When running the <command>perf top</command> command on the i.MX
218 6Quad SABRE Lite target, the console text may become red after running
219 for some time (~ 1 minute).<remark>LXCR-3631</remark></para>
220 </listitem>
221
222 <listitem>
223 <para>The <emphasis role="bold">LTTng</emphasis> tool does not work on
224 <emphasis role="bold">ARM</emphasis> targets, neither from within
225 Eclipse nor when run directly on target, due to a problem with
226 lttng-modules and gcc-4.8.x. See <ulink
227 url="https://bugzilla.yoctoproject.org/show_bug.cgi?id=6015">Bugzilla
228 #6015</ulink>.<remark>LXCR-2653, LXCR-3053</remark></para>
229 </listitem>
230
231 <listitem>
232 <para>The <emphasis role="bold">powertop --calibrate</emphasis>
233 command does not work on the Keystone k2hk-evm
234 target.<remark>LXCR-2660</remark></para>
235 </listitem>
236
237 <listitem>
238 <para>The <emphasis role="bold">powertop</emphasis> command run with
239 <emphasis role="bold">--calibrate</emphasis> or -<emphasis
240 role="bold">-time</emphasis> arguments may show some warnings on
241 PowerPC targets.</para>
242 </listitem>
243
244 <listitem>
245 <para>When running <emphasis role="bold">powertop</emphasis> on
246 <emphasis role="bold">ARM</emphasis> targets, the following
247 warning/error is repeated: <literal>clk_set_rate: failed to set
248 i2c0_aper rate</literal> . Then powertop stops and the statistics are
249 no longer updated. What probably happens here is that the cpufreq
250 governor tries to scale the CPU frequency, but since the I2C clock is
251 derived from the CPU frequency, the I2C driver implements some policy
252 to stay within legal frequency limits and rejects the frequency
253 changes, ending up with the warning message. A <ulink
254 url="https://github.com/Xilinx/linux-xlnx/commit/0fdd34575efae5c8eced09b6b0a1b723bff4d225">fix</ulink>
255 has been merged in the linux-xlnx kernel but is not yet propagated
256 into meta-xilinx.<remark>LXCR-3205, LXCR-3106,
257 LXCR-2660</remark></para>
258 </listitem>
259
260 <listitem>
261 <para>If you get an error message like <literal>Cannot load from file
262 /var/cache/powertop/saved_results.powertop</literal> when running
263 <emphasis role="bold">powertop</emphasis>, there is most likely not
264 enough measurement data collected yet. All you have to do is to keep
265 powertop running for a certain time.<remark>LXCR-2176, LXCR-2660,
266 LXCR-3106</remark></para>
267 </listitem>
268
269 <listitem>
270 <para>The message <literal>Model-specific registers (MSR) not found
271 (try enabling CONFIG_X86_MSR)</literal> appears when you run <emphasis
272 role="bold">powertop</emphasis> on <emphasis
273 role="bold">non-x86</emphasis> targets. powertop is mainly an x86n
274 tool, so it expects X*^_MSR config to be enabled in the kernel. For
275 non-x86 targets this config is not available in the kernel, hence,
276 powertop warns about it, but the message can be ignored on those
277 targets.<remark> LXCR-2176, LXCR-2660, LXCR-3106</remark></para>
278 </listitem>
279
280 <listitem>
281 <para><emphasis role="bold">powertop</emphasis> issues a message
282 <literal>sh: /usr/bin/xset: No such file or directory</literal> when
283 it tries to use xset to configure X display preferences but cannot
284 find the binary since the image by default contains no X system. The
285 message can simply be ignored.<remark>LXCR-2176</remark></para>
286 </listitem>
287 </itemizedlist>
288 </section>
289
290 <section condition="hidden" id="bugs-limitations-virtualization">
291 <title>Virtualization</title>
292
293 <itemizedlist spacing="compact">
294 <listitem>
295 <para><emphasis role="bold">virtualization</emphasis>: CONFIG_BRIDGE
296 is not included in the default p2020rdb
297 kernel.<remark>LXVTCR-273</remark></para>
298 </listitem>
299
300 <listitem>
301 <para><emphasis role="bold">lxc</emphasis>:</para>
302
303 <itemizedlist spacing="compact">
304 <listitem>
305 <para>User namespace is not available on PowerPC targets as it is
306 an experimental feature in the 3.8 kernel.</para>
307 </listitem>
308
309 <listitem>
310 <para>If multiple Linux containers are started from the same
311 process and share resources, destroying the containers might
312 result in a race condition with error message "Error in
313 `./lxc-test-concurrent': double free or corruption (fasttop)"
314 followed by an application
315 crash."<remark>LXVTCR-365</remark></para>
316 </listitem>
317 </itemizedlist>
318 </listitem>
319
320 <listitem>
321 <para><emphasis role="bold">libvirt</emphasis>: Default network does
322 not start.<remark>LXVTCR-240</remark></para>
323 </listitem>
324 </itemizedlist>
325 </section>
326
327 <section condition="hidden" id="bugs-limitations-doc">
328 <title>Documentation</title>
329
330 <itemizedlist spacing="compact">
331 <listitem>
332 <para><emphasis role="bold">PDF navigation</emphasis>: When using
333 links to open other PDFs, or jump to another place in the same PDF,
334 jumping back sometimes fails. This has been observed when opening a
335 PDF in Adobe Reader, inside a browser with PDF add-on, as well as when
336 the browser is configured to open PDF files in an external PDF reader.
337 As a workaround, open the HTML version of the
338 document.<remark>LXCR-3283</remark></para>
339 </listitem>
340
341 <listitem>
342 <para><emphasis role="bold">Internet Explorer (IE) cannot display some
343 web pages</emphasis>: It is recommended to use Firefox or another
344 non-IE browser for opening external links. If you prefer reading the
345 documentation in PDF format in Adobe Reader (not in an Adobe plug-in
346 in a browser), remember to configure a non-IE browser as default
347 browser to be able to follow all links from within Adobe Reader.
348 Example of a link that does not work in IE: <ulink
349 url="https://rt.wiki.kernel.org/">https://rt.wiki.kernel.org/</ulink>.
350 <remark>LXCR-3281</remark></para>
351 </listitem>
352 </itemizedlist>
353 </section>
354
355 <section condition="hidden" id="bugs-limitations-other">
356 <title>Miscellaneous</title>
357
358 <itemizedlist spacing="compact">
359 <listitem>
360 <para>Running <emphasis role="bold">QEMU from an exported
361 rootfs</emphasis> requires sudo privileges on the host.</para>
362 </listitem>
363
364 <listitem>
365 <para><emphasis role="bold">menuconfig</emphasis> requires <emphasis
366 role="bold">Ncurses</emphasis>. If the terminal that pops up
367 immediately closes instead of showing the menuconfig interface, check
368 that the Ncurses development library is installed.</para>
369 </listitem>
370 </itemizedlist>
371 </section>
372
373 <!-- The file with a section below is autocreated by make init -->
374
375 <!-- <xi:include href="jiraissues_generated.xml"
376 xmlns:xi="http://www.w3.org/2001/XInclude" /> -->
377</chapter> \ No newline at end of file
diff --git a/doc/book-enea-linux-release-info/doc/main_changes.xml b/doc/book-enea-linux-release-info/doc/main_changes.xml
new file mode 100644
index 0000000..c2279ee
--- /dev/null
+++ b/doc/book-enea-linux-release-info/doc/main_changes.xml
@@ -0,0 +1,54 @@
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-changes">
5 <title>Main Changes</title>
6
7 <para>This chapter describes the major changes and additions made to this
8 release of Enea Linux.<remark>INFO Just now Hardcoded previous release
9 string in this paragraph.</remark><remark>The list of changed packages
10 further down is created from the open source book licenses.xml by the script
11 gen_pkgdiff.py by comparing with an older open source licenses.xml,
12 depending on the parameter "prev_baseline" in pardoc-distro.xml, e.g. a tag
13 like "EL5". This parameter needs to be changed to a new TAG when a release
14 info for another EL version is created. It must correspond to the release
15 string above.</remark></para>
16
17 <section id="relinfo-changes-other">
18 <title>New Functionality/Enhancements</title>
19
20 <itemizedlist spacing="compact">
21 <listitem>
22 <para><ulink
23 url="http://www.yoctoproject.org/downloads">New Yocto
24 Project version</ulink> (<xi:include href="eltf_params_updated.xml"
25 xmlns:xi="http://www.w3.org/2001/XInclude"
26 xpointer="element(Yocto_VER/1)" />)<remark>INFO Yocto_VER and
27 ULINK_YOCTO_PROJECT_DOWNLOAD in
28 eltf_params_updated.xml</remark></para>
29 </listitem>
30
31 <listitem>
32 <para>New targets: Intel Xeon D, Intel Atom C3000 and Intel NUC Kaby
33 Lake.</para>
34 </listitem>
35 </itemizedlist>
36 </section>
37
38 <section condition="hidden" id="relinfo-fixed">
39 <title>Problems Fixed in this Release</title>
40
41 <para>TBD <remark>FIXME or set condition hidden on the section
42 element</remark></para>
43 </section>
44
45 <section condition="hidden" id="relinfo-added-drivers">
46 <title>Added Drivers</title>
47
48 <para>TBD <remark>FIXME or set condition hidden on the section
49 element</remark></para>
50 </section>
51
52 <xi:include href="pkgdiff_generated.xml"
53 xmlns:xi="http://www.w3.org/2001/XInclude" />
54</chapter>
diff --git a/doc/book-enea-linux-release-info/doc/prerequisites.xml b/doc/book-enea-linux-release-info/doc/prerequisites.xml
new file mode 100644
index 0000000..324bb57
--- /dev/null
+++ b/doc/book-enea-linux-release-info/doc/prerequisites.xml
@@ -0,0 +1,34 @@
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="prerequisites">
5 <title>Prerequisites</title>
6
7 <para>Building Enea Linux or compiling applications requires that your git
8 environment be setup properly and for certain packages to be installed on
9 your Linux development host.</para>
10
11 <para>Please refer to <ulink
12 url="https://git-scm.com/book/en/v2/Getting-Started-First-Time-Git-Setup">Getting
13 Started - First-Time Git Setup</ulink>, for more details on how to set up
14 your git environment correctly, including how to set your identity using the
15 following commands:</para>
16
17 <programlisting>$ git config --global user.name "John Doe"
18$ git config --global user.email johndoe@example.com</programlisting>
19
20 <para>First ensure the system is up-to-date, then for the supported
21 distribution(s), you need the following packages:<remark>INFO: The
22 programlisting below is a parameters in eltf_params_updated.xml with ID:
23 "eltf-prereq-apt-get-command-host". If multiple hosts are supported, store
24 the commands for each host in the same programlisting with empty lines
25 between each - the comment with the FULL HOST name and version is
26 essential.</remark></para>
27
28 <xi:include href="eltf_params_updated.xml"
29 xmlns:xi="http://www.w3.org/2001/XInclude"
30 xpointer="element(eltf-prereq-apt-get-commands-host/1)" />
31
32 <xi:include href="../../s_doceneacommon/doc/system_requirements.xml"
33 xmlns:xi="http://www.w3.org/2001/XInclude" />
34</chapter> \ No newline at end of file
diff --git a/doc/book-enea-linux-release-info/doc/system_requirements.xml b/doc/book-enea-linux-release-info/doc/system_requirements.xml
new file mode 100644
index 0000000..cc1248e
--- /dev/null
+++ b/doc/book-enea-linux-release-info/doc/system_requirements.xml
@@ -0,0 +1,159 @@
1<?xml version="1.0" encoding="ISO-8859-1"?>
2<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
3"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
4<section id="enea-linux-sysreq">
5 <title>System Requirements</title>
6
7 <para>The host requirements listed below are extensive to allow for the
8 building of Linux images via the Yocto system, and not just
9 applications.</para>
10
11 <para>Please also see the system requirements in the Yocto 2.3 documents:
12 <ulink
13 url="http://www.yoctoproject.org/docs/2.3/yocto-project-qs/yocto-project-qs.html#yp-resources">Yocto
14 Project Start</ulink> and the <ulink
15 url="http://www.yoctoproject.org/docs/2.3/ref-manual/ref-manual.html#intro-requirements">Yocto
16 Project Reference Manual</ulink>. If needed, replace the Yocto version in
17 the links provided with a more recent version.</para>
18
19 <informaltable>
20 <tgroup cols="2">
21 <colspec align="left" colname="1" colwidth="1*" />
22
23 <colspec align="left" colname="2" colwidth="3*" />
24
25 <spanspec nameend="2" namest="1" spanname="onetwo" />
26
27 <tbody>
28 <row>
29 <entry spanname="onetwo"><emphasis role="bold"> Build host
30 requirements<indexterm>
31 <primary>system requirements</primary>
32 </indexterm></emphasis></entry>
33 </row>
34
35 <row>
36 <entry>Linux distribution</entry>
37
38 <entry>The downloaded code shall be built on a Linux host to
39 generate images for your target or for emulation in QEMU. For
40 information about the supported hosts and targets, see the <emphasis
41 role="bold">Enea Linux Release Information</emphasis> in your Enea
42 Linux distribution.</entry>
43 </row>
44
45 <row>
46 <entry>Internet access</entry>
47
48 <entry>Internet access must be available when building an image,
49 since bitbake downloads source files from various servers during the
50 build.</entry>
51 </row>
52
53 <row>
54 <entry>Packages</entry>
55
56 <entry>Depending on the Linux distribution and version on host, some
57 packages may be required, by bitbake for example. You will install
58 any required packages while following the installation
59 instructions.</entry>
60 </row>
61
62 <row>
63 <entry>Targets</entry>
64
65 <entry>Images can be built or downloaded for any of the targets
66 supported in this release.</entry>
67 </row>
68
69 <row>
70 <entry>Disk space</entry>
71
72 <entry><para>Your system should have at least 50 GB of free disk
73 space when bitbaking the basic enea-image-name kernel image.</para>
74 <para>For larger images and to allow for future package extensions
75 and variations in the build process, a minimum of 100 GB free disk
76 space is recommended.</para></entry>
77 </row>
78
79 <row>
80 <entry>Recommended RAM</entry>
81
82 <entry><para>Your system must have at least 4 GB available
83 RAM.</para> <para>It is recommended to have 8 GB RAM available for
84 parallel build jobs.</para></entry>
85 </row>
86
87 <row>
88 <entry>Java</entry>
89
90 <entry>Java <indexterm>
91 <primary>java</primary>
92 </indexterm>is required to run Eclipse. Currently, Eclipse
93 generally recommends at least Java 6 JRE/JDK. More information
94 regarding operating environments for Eclipse is provided in the
95 <ulink
96 url="http://www.eclipse.org/eclipse/development/readme_eclipse_version">Eclipse
97 Project Release Notes</ulink> for the Eclipse version used in this
98 release. See the <emphasis role="bold">Enea Linux Release
99 Information </emphasis>for the Eclipse Version.</entry>
100 </row>
101 </tbody>
102 </tgroup>
103 </informaltable>
104
105 <para>The build time depends on the capacity of the processor and other
106 hardware, available resources, speed of internet connection, load situation,
107 etc. E.g: on a fast 16 core machine with 16 GB RAM and SSD disks, a complete
108 build from source could take about two hours.</para>
109
110 <informaltable>
111 <tgroup cols="2">
112 <colspec align="left" colname="1" colwidth="1*" />
113
114 <colspec align="left" colname="2" colwidth="3*" />
115
116 <spanspec nameend="2" namest="1" spanname="onetwo" />
117
118 <tbody>
119 <row>
120 <entry spanname="onetwo"><emphasis role="bold">Target
121 Requirements</emphasis></entry>
122 </row>
123
124 <row>
125 <entry>External memory</entry>
126
127 <entry>To boot a CGL<indexterm>
128 <primary>CGL</primary>
129 </indexterm> image, you need at least 16 GB on a hard-disk
130 drive<indexterm>
131 <primary>HDD</primary>
132 </indexterm> on an eSATA, USB drive, or SD card.<remark>INFO:
133 (packed rootfs 4.5 GB + unpacked rootfs 1.5 GB + good
134 margins)</remark><remark>INFO: NFS does not support SELinux. In
135 order to have a security-enhanced Linux, one must take off from an
136 NFS-booted system and proceed with boot from external
137 memory.</remark></entry>
138 </row>
139 </tbody>
140 </tgroup>
141 </informaltable>
142
143 <section id="ensure-bash">
144 <title>System Shell Configuration</title>
145
146 <para>Before installing Enea Linux, ensure that bash is the default
147 shell.</para>
148
149 <para>If your system runs Ubuntu, you can use ls -l to ensure
150 <filename>/usr/bin</filename> is a symbolic link to bash. In case the link
151 points to dash, which is default in some Ubuntu versions, change it to
152 bash by running <emphasis role="bold">sudo dpkg-reconfigure
153 dash</emphasis> and answer <emphasis role="bold">No</emphasis> to the
154 question "Use dash as the default system shell (/bin/sh)?":</para>
155
156 <programlisting># ls -l /bin/sh
157 lrwxrwxrwx 1 root root 4 2012-03-02 11:53 /bin/sh -&gt; bash</programlisting>
158 </section>
159</section> \ No newline at end of file