diff options
author | Thomas Lundström <thomas.lundstrom@enea.com> | 2016-06-22 19:24:31 +0200 |
---|---|---|
committer | Thomas Lundström <thomas.lundstrom@enea.com> | 2016-06-22 19:24:31 +0200 |
commit | b26854f76b2fa8d44937bdae0664b1a24b2c7e78 (patch) | |
tree | 0d46962f5a06c6a9bf484d3778eeb7959e1385d7 /doc/book-enea-linux-release-info/doc | |
download | el_releases-networking-b26854f76b2fa8d44937bdae0664b1a24b2c7e78.tar.gz |
Initial commit
Diffstat (limited to 'doc/book-enea-linux-release-info/doc')
7 files changed, 1168 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..15d676c --- /dev/null +++ b/doc/book-enea-linux-release-info/doc/about_release.xml | |||
@@ -0,0 +1,469 @@ | |||
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 | ||
8 | href="../../s_docsrc_common/pardoc-distro.xml" | ||
9 | xmlns:xi="http://www.w3.org/2001/XInclude" | ||
10 | xpointer="element(EneaLinux_REL_VER/1)" /> provides a publicly available | ||
11 | Enea Linux distribution for a selected set of targets. This release is | ||
12 | generated from the yocto distribution using the branch <xi:include | ||
13 | href="../../s_docsrc_common/pardoc-distro.xml" | ||
14 | xmlns:xi="http://www.w3.org/2001/XInclude" | ||
15 | xpointer="element(Yocto_NAME/1)" />.<remark>INFO Yocto distro autopicked | ||
16 | from poky.ent as DISTRO_NAME_NO_CAP</remark></para> | ||
17 | |||
18 | <section id="relinfo-provided-contents"> | ||
19 | <title>Provided Contents</title> | ||
20 | |||
21 | <informaltable> | ||
22 | <tgroup cols="1"> | ||
23 | <thead> | ||
24 | <row> | ||
25 | <entry>Item</entry> | ||
26 | </row> | ||
27 | </thead> | ||
28 | |||
29 | <tbody> | ||
30 | <row> | ||
31 | <entry><para>Source code, recipes, scripts, etc for building the | ||
32 | distro and SDKs. See <xref | ||
33 | linkend="relinfo-getting-enea-linux" />.</para></entry> | ||
34 | </row> | ||
35 | |||
36 | <row> | ||
37 | <entry><para>Documentation. See <xref | ||
38 | linkend="relinfo-documentation" />.</para></entry> | ||
39 | </row> | ||
40 | |||
41 | <row> | ||
42 | <entry>Pre-built binaries (kernel image, dtb & rootfs)</entry> | ||
43 | </row> | ||
44 | |||
45 | <row> | ||
46 | <entry>Pre-built packages (RPM)</entry> | ||
47 | </row> | ||
48 | |||
49 | <row> | ||
50 | <entry>Eclipse executable plus development tools for command line | ||
51 | and Eclipse</entry> | ||
52 | </row> | ||
53 | </tbody> | ||
54 | </tgroup> | ||
55 | </informaltable> | ||
56 | </section> | ||
57 | |||
58 | <section id="relinfo-supported-targets"> | ||
59 | <title>Supported Targets</title> | ||
60 | |||
61 | <informaltable> | ||
62 | <tgroup cols="3"> | ||
63 | <colspec align="left" colname="c1" colwidth="1*" /> | ||
64 | |||
65 | <colspec align="left" colname="c2" colwidth="1*" /> | ||
66 | |||
67 | <colspec align="left" colname="c3" colwidth="1*" /> | ||
68 | |||
69 | <thead valign="bottom"> | ||
70 | <row> | ||
71 | <entry>Target</entry> | ||
72 | |||
73 | <entry>Architecture</entry> | ||
74 | |||
75 | <entry>Specification</entry> | ||
76 | </row> | ||
77 | </thead> | ||
78 | |||
79 | <tbody> | ||
80 | <row> | ||
81 | <entry>P2041RDB</entry> | ||
82 | |||
83 | <entry><para>Power, e500mc</para></entry> | ||
84 | |||
85 | <entry>See <ulink | ||
86 | url="http://www.nxp.com/products/microcontrollers-and-processors/power-architecture-processors/qoriq-power-architecture-processors/p2041-qoriq-reference-design-board:RDP2041BOARD">link | ||
87 | to NXP's datasheet</ulink></entry> | ||
88 | </row> | ||
89 | </tbody> | ||
90 | </tgroup> | ||
91 | </informaltable> | ||
92 | |||
93 | <para><remark>FIXME should autocreate a list of targets, hopefully from | ||
94 | the generated README file, by using MAKEFILE to update pardoc-distro | ||
95 | AND/OR also auto-create an XML file to include here with description text | ||
96 | for each target etc..</remark></para> | ||
97 | </section> | ||
98 | |||
99 | <section id="relinfo-supported-host-environment"> | ||
100 | <title>Supported Host Environment</title> | ||
101 | |||
102 | <itemizedlist> | ||
103 | <listitem> | ||
104 | <para>Ubuntu 14.04 LTS, 64-bit<remark>was | ||
105 | EneaLinux_HOST_VER</remark></para> | ||
106 | </listitem> | ||
107 | </itemizedlist> | ||
108 | </section> | ||
109 | |||
110 | <section id="relinfo-supported-versions"> | ||
111 | <title>Supported Versions</title> | ||
112 | |||
113 | <informaltable> | ||
114 | <tgroup cols="2"> | ||
115 | <thead valign="bottom"> | ||
116 | <row> | ||
117 | <entry>Item</entry> | ||
118 | |||
119 | <entry>Version</entry> | ||
120 | </row> | ||
121 | </thead> | ||
122 | |||
123 | <tbody> | ||
124 | <row> | ||
125 | <entry><para>Yocto</para></entry> | ||
126 | |||
127 | <entry><xi:include href="../../s_docsrc_common/pardoc-distro.xml" | ||
128 | xmlns:xi="http://www.w3.org/2001/XInclude" | ||
129 | xpointer="element(Yocto_VER/1)" /> (<xi:include | ||
130 | href="../../s_docsrc_common/pardoc-distro.xml" | ||
131 | xmlns:xi="http://www.w3.org/2001/XInclude" | ||
132 | xpointer="element(Yocto_NAME/1)" />)<remark>INFO: Auto-fetched | ||
133 | from poky.ent via pardoc-distro.xml</remark></entry> | ||
134 | </row> | ||
135 | |||
136 | <row> | ||
137 | <entry>Poky source</entry> | ||
138 | |||
139 | <entry><xi:include href="../../s_docsrc_common/pardoc-distro.xml" | ||
140 | xmlns:xi="http://www.w3.org/2001/XInclude" | ||
141 | xpointer="element(Poky_VER/1)" /><remark>INFO: Auto-fetched from | ||
142 | poky.ent via pardoc-distro.xml</remark></entry> | ||
143 | </row> | ||
144 | |||
145 | <row> | ||
146 | <entry>GCC version</entry> | ||
147 | |||
148 | <entry>5.3<remark>was EneaLinux_GCC_VER Not in poky.ent | ||
149 | </remark></entry> | ||
150 | </row> | ||
151 | |||
152 | <row> | ||
153 | <entry>Linux kernel version<remark>was EneaLinux_KERNEL_VER Not in | ||
154 | poky.ent</remark></entry> | ||
155 | |||
156 | <entry><para>3.12 (P2041RDB & LS1021a-IoT)</para><para>4.4 | ||
157 | (QEmu targets)</para></entry> | ||
158 | </row> | ||
159 | |||
160 | <row> | ||
161 | <entry>Eclipse</entry> | ||
162 | |||
163 | <entry>4.5 (Mars)<remark>was Eclipse_VER and was Eclipse_NAME Not | ||
164 | in poky.ent</remark></entry> | ||
165 | </row> | ||
166 | |||
167 | <row> | ||
168 | <entry>Packages</entry> | ||
169 | |||
170 | <entry>See <xref linkend="relinfo-packages" /></entry> | ||
171 | </row> | ||
172 | </tbody> | ||
173 | </tgroup> | ||
174 | </informaltable> | ||
175 | </section> | ||
176 | |||
177 | <section id="relinfo-packages"> | ||
178 | <title>Provided Packages</title> | ||
179 | |||
180 | <para><informaltable> | ||
181 | <tgroup cols="2"> | ||
182 | <colspec align="left" colname="c1" colwidth="3*" /> | ||
183 | |||
184 | <colspec align="left" colname="c2" colwidth="6*" /> | ||
185 | |||
186 | <thead valign="bottom"> | ||
187 | <row> | ||
188 | <entry>Type of Packages and Provider</entry> | ||
189 | |||
190 | <entry>Reference</entry> | ||
191 | </row> | ||
192 | </thead> | ||
193 | |||
194 | <tbody> | ||
195 | <row> | ||
196 | <entry>Packages in Enea Linux images</entry> | ||
197 | |||
198 | <entry><para>See the <olink | ||
199 | targetdoc="book_enea_linux_open_source" | ||
200 | targetptr="book_enea_linux_open_source"><trademark | ||
201 | class="registered">Enea</trademark> Linux Open Source | ||
202 | Report</olink></para></entry> | ||
203 | </row> | ||
204 | |||
205 | <row> | ||
206 | <entry>Tools in the Eclipse tarball provided with Enea | ||
207 | Linux</entry> | ||
208 | |||
209 | <entry><para>See the <olink | ||
210 | targetdoc="book_enea_linux_eclipse_open_source" | ||
211 | targetptr="book_enea_linux_eclipse_open_source"><trademark | ||
212 | class="registered">Enea</trademark> Linux Eclipse Open Source | ||
213 | Report</olink></para></entry> | ||
214 | </row> | ||
215 | |||
216 | <row> | ||
217 | <entry>Packages provided by Yocto</entry> | ||
218 | |||
219 | <entry><para>See the Yocto "Release Notes" <xi:include | ||
220 | href="../../docsrc_common/pardoc-distro.xml" | ||
221 | xmlns:xi="http://www.w3.org/2001/XInclude" | ||
222 | xpointer="element(ULINK_YOCTO_RELEASE_NOTES/1)" /></para></entry> | ||
223 | </row> | ||
224 | </tbody> | ||
225 | </tgroup> | ||
226 | </informaltable></para> | ||
227 | </section> | ||
228 | |||
229 | <section id="relinfo-provided-sdk"> | ||
230 | <title>Provided Toolchain/s (SDK)</title> | ||
231 | |||
232 | <para>The SDK contains toolchains supporting cross-compilation of | ||
233 | applications for the targets on an x86_64 host. See the <olink | ||
234 | targetdoc="book_enea_linux_app_dev_guide" | ||
235 | targetptr="book_enea_linux_app_dev_guide"><trademark | ||
236 | class="registered">Enea</trademark> Linux Application Development | ||
237 | Guide</olink> for information on how to build and install a | ||
238 | toolchain.</para> | ||
239 | </section> | ||
240 | |||
241 | <section id="relinfo-provided-drivers"> | ||
242 | <title>Supported Drivers</title> | ||
243 | |||
244 | <informaltable> | ||
245 | <tgroup cols="2"> | ||
246 | <colspec align="left" colwidth="3*" /> | ||
247 | |||
248 | <colspec align="center" colwidth="2*" /> | ||
249 | |||
250 | <thead> | ||
251 | <row> | ||
252 | <entry>Driver</entry> | ||
253 | |||
254 | <entry>P2041RDB</entry> | ||
255 | </row> | ||
256 | </thead> | ||
257 | |||
258 | <tbody> | ||
259 | <row> | ||
260 | <entry>Ethernet</entry> | ||
261 | |||
262 | <entry>X</entry> | ||
263 | </row> | ||
264 | |||
265 | <row> | ||
266 | <entry>I2C</entry> | ||
267 | |||
268 | <entry>X</entry> | ||
269 | </row> | ||
270 | |||
271 | <row> | ||
272 | <entry>SPI</entry> | ||
273 | |||
274 | <entry>X</entry> | ||
275 | </row> | ||
276 | |||
277 | <row> | ||
278 | <entry>PCI Express</entry> | ||
279 | |||
280 | <entry>X</entry> | ||
281 | </row> | ||
282 | |||
283 | <row> | ||
284 | <entry>USB</entry> | ||
285 | |||
286 | <entry>X</entry> | ||
287 | </row> | ||
288 | |||
289 | <row> | ||
290 | <entry>Flash</entry> | ||
291 | |||
292 | <entry>X</entry> | ||
293 | </row> | ||
294 | |||
295 | <row> | ||
296 | <entry>SD/SDHC/SDXC</entry> | ||
297 | |||
298 | <entry>X</entry> | ||
299 | </row> | ||
300 | |||
301 | <row> | ||
302 | <entry>RTC</entry> | ||
303 | |||
304 | <entry>X</entry> | ||
305 | </row> | ||
306 | </tbody> | ||
307 | </tgroup> | ||
308 | </informaltable> | ||
309 | </section> | ||
310 | |||
311 | <section id="relinfo-documentation"> | ||
312 | <title>Provided Documentation</title> | ||
313 | |||
314 | <para>The following Enea Linux manuals are available:</para> | ||
315 | |||
316 | <itemizedlist spacing="compact"> | ||
317 | <listitem> | ||
318 | <para>README.htm - top page of the documentation<remark>FIXME Needs to | ||
319 | be fixed (= created and added to make dist). OR remove this | ||
320 | line?</remark></para> | ||
321 | </listitem> | ||
322 | |||
323 | <listitem> | ||
324 | <para>README - text files describing various details like build- and | ||
325 | boot-commands - the commands are also seen in <xref | ||
326 | linkend="relinfo-build-boot" />.</para> | ||
327 | </listitem> | ||
328 | |||
329 | <listitem> | ||
330 | <para><trademark class="registered">Enea</trademark> Linux Release | ||
331 | Information (this document)</para> | ||
332 | </listitem> | ||
333 | |||
334 | <listitem> | ||
335 | <para><olink targetdoc="book_enea_linux_open_source" | ||
336 | targetptr="book_enea_linux_open_source"><trademark | ||
337 | class="registered">Enea</trademark> Linux Open Source | ||
338 | Report</olink></para> | ||
339 | </listitem> | ||
340 | |||
341 | <listitem> | ||
342 | <para><olink targetdoc="book_enea_linux_eclipse_open_source" | ||
343 | targetptr="book_enea_linux_eclipse_open_source"><trademark | ||
344 | class="registered">Enea</trademark> Linux Eclipse Open Source | ||
345 | Report</olink></para> | ||
346 | </listitem> | ||
347 | |||
348 | <listitem> | ||
349 | <para><olink targetdoc="book_enea_linux_platforms_dev_guide" | ||
350 | targetptr="book_enea_linux_platforms_dev_guide"><trademark | ||
351 | class="registered">Enea</trademark> Linux Platforms Development | ||
352 | Guide</olink> - Generic version included in this distribution</para> | ||
353 | </listitem> | ||
354 | |||
355 | <listitem> | ||
356 | <para><olink targetdoc="book_enea_linux_app_dev_guide" | ||
357 | targetptr="book_enea_linux_app_dev_guide"><trademark | ||
358 | class="registered">Enea</trademark> Linux Application Development | ||
359 | Guide</olink> - Generic version included in this distribution</para> | ||
360 | </listitem> | ||
361 | |||
362 | <listitem> | ||
363 | <para><emphasis role="bold"><trademark | ||
364 | class="registered">Enea</trademark> Linux Real-Time Guide</emphasis> | ||
365 | can be read at <ulink | ||
366 | url="http://linuxrealtime.org">http://linuxrealtime.org</ulink>.</para> | ||
367 | </listitem> | ||
368 | </itemizedlist> | ||
369 | |||
370 | <para>In addition to the local versions of the generic guides reached via | ||
371 | the above links, you can also read the latest versions via the direct | ||
372 | online links below. When accessing them via the links below, you need to | ||
373 | logon to the portal.enea.com. These online versions may be | ||
374 | updated/improved asynchronously with the releases.<remark>INFO: Should be | ||
375 | accessable to all customer's with Enea Linux 6 or later</remark> | ||
376 | <remark>INFO: On portal, generic guides can NOT link TO the distro | ||
377 | specific guides, but the distro specific guides can link to the generic - | ||
378 | HOWEVER these links (found above) will go to the versions inside the | ||
379 | delivery, instead of to the latest versions.</remark></para> | ||
380 | |||
381 | <itemizedlist spacing="compact"> | ||
382 | <listitem> | ||
383 | <para><ulink | ||
384 | url="https://portal.enea.com/wp-content/uploads/_mediavault/book-enea-linux-application-dev-guide.pdf">Enea | ||
385 | Linux Application Development Guide</ulink> - Latest generic version | ||
386 | online</para> | ||
387 | </listitem> | ||
388 | |||
389 | <listitem> | ||
390 | <para><ulink | ||
391 | url="https://portal.enea.com/wp-content/uploads/_mediavault/book-enea-linux-platforms-dev-guide.pdf">Enea | ||
392 | Linux Platforms Development Guide</ulink> - Latest generic version | ||
393 | online</para> | ||
394 | </listitem> | ||
395 | </itemizedlist> | ||
396 | |||
397 | <para>How to use Eclipse is described inside the Enea Linux user's guides. | ||
398 | Eclipse's own documentation is available in directory | ||
399 | <filename>eclipse/readme</filename>.</para> | ||
400 | </section> | ||
401 | |||
402 | <section id="relinfo-provided-other"> | ||
403 | <title>Other Provided Functionality</title> | ||
404 | |||
405 | <para>The functionality in a distribution depends on included packages in | ||
406 | the default image. In addition to the supported features, the following | ||
407 | functionality is also available, among other:</para> | ||
408 | |||
409 | <itemizedlist spacing="compact"> | ||
410 | <listitem> | ||
411 | <para>On target T4240RDB:</para> | ||
412 | |||
413 | <itemizedlist spacing="compact"> | ||
414 | <listitem> | ||
415 | <para>SRIO support in user space (NWRITE, NREAD, msg, | ||
416 | doorbell)</para> | ||
417 | </listitem> | ||
418 | |||
419 | <listitem> | ||
420 | <para>USDPAA</para> | ||
421 | </listitem> | ||
422 | </itemizedlist> | ||
423 | </listitem> | ||
424 | |||
425 | <listitem> | ||
426 | <para>Smart Package Management</para> | ||
427 | </listitem> | ||
428 | |||
429 | <listitem> | ||
430 | <para>Eclipse ADT (excl. QEMU) and plug-ins for application | ||
431 | development: LTTng, Perf, LatencyTOP, PowerTOP, SystemTap</para> | ||
432 | </listitem> | ||
433 | </itemizedlist> | ||
434 | </section> | ||
435 | |||
436 | <section id="relinfo-security-fixes"> | ||
437 | <title>Security Fixes</title> | ||
438 | |||
439 | <para>See <ulink | ||
440 | url="http://www.enea.com/solutions/Enea-Linux/Security/CVEs-list">List of | ||
441 | CVEs addressed in Enea Linux</ulink> and <ulink | ||
442 | url="http://www.enea.com/solutions/Enea-Linux/Security#how-to-get-security-updates">How | ||
443 | to Get Security Updates</ulink>.</para> | ||
444 | </section> | ||
445 | |||
446 | <section id="relinfo-excluded"> | ||
447 | <title>Intentional Limitations</title> | ||
448 | |||
449 | <para>The following functionality supported in other Enea Linux releases | ||
450 | has been excluded in this release:<itemizedlist spacing="compact"> | ||
451 | <listitem> | ||
452 | <para>Eclipse plug-ins for image creation (HOB)</para> | ||
453 | </listitem> | ||
454 | |||
455 | <listitem> | ||
456 | <para>Networking features: DPDK vSwitch, DPDK</para> | ||
457 | </listitem> | ||
458 | |||
459 | <listitem> | ||
460 | <para>Real-time features: Fully Preemptible Kernel (FPK) from the | ||
461 | PREEMPT_RT patch</para> | ||
462 | </listitem> | ||
463 | |||
464 | <listitem> | ||
465 | <para>Memory features: NUMA</para> | ||
466 | </listitem> | ||
467 | </itemizedlist></para> | ||
468 | </section> | ||
469 | </chapter> \ No newline at end of file | ||
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..d1226b9 --- /dev/null +++ b/doc/book-enea-linux-release-info/doc/book.xml | |||
@@ -0,0 +1,18 @@ | |||
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 | ]> | ||
5 | <book id="book_enea_linux_release_info"> | ||
6 | <title><trademark class="registered">Enea</trademark> Linux Release Information</title> | ||
7 | <subtitle>Release Version | ||
8 | <xi:include href="../../s_docsrc_common/pardoc-distro.xml" xpointer="element(EneaLinux_REL_VER/1)" | ||
9 | xmlns:xi="http://www.w3.org/2001/XInclude" /></subtitle> | ||
10 | <xi:include href="../../s_docbuild/template/docsrc_common/bookinfo_userdoc.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> | ||
11 | <xi:include href="about_release.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> | ||
12 | <xi:include href="prerequisites.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> | ||
13 | <xi:include href="getting_enea_linux.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> | ||
14 | <xi:include href="build_boot_generated.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> | ||
15 | <xi:include href="main_changes.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> | ||
16 | <xi:include href="known_bugs_and_limitations.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> | ||
17 | <xi:include href="../../s_docbuild/template/docsrc_common/contacting_enea_enea_linux.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> | ||
18 | </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..653f943 --- /dev/null +++ b/doc/book-enea-linux-release-info/doc/build_boot_template.xml | |||
@@ -0,0 +1,26 @@ | |||
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 these build/boot instruction have been extracted | ||
11 | into the following sections.</para> | ||
12 | |||
13 | <para><remark>NOTE: Only EDIT THE TEMPLATE FILE! A new build_boot.xml file | ||
14 | is created from the template and sections are added below automatically from | ||
15 | the README files for each target when building the book! Only in the | ||
16 | template file you see a line below with SCRIPT_...._HERE and the text | ||
17 | telling that this is a template file.</remark></para> | ||
18 | |||
19 | <para>SCRIPT_INCLUDES_BUILD_BOOT_SECTIONS_HERE</para> | ||
20 | |||
21 | <para><emphasis role="bold">This is a template file which you can edit. When | ||
22 | the book is built, a new XML chapter file is created where the above part of | ||
23 | this file is copied to the new XML file and all from the line above is | ||
24 | replaced automatically by build and boot sections from the README | ||
25 | files!</emphasis></para> | ||
26 | </chapter> \ No newline at end of file | ||
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..f25c1a5 --- /dev/null +++ b/doc/book-enea-linux-release-info/doc/getting_enea_linux.xml | |||
@@ -0,0 +1,103 @@ | |||
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 | <section id="relinfo-getting-pre-built-images"> | ||
8 | <title>Getting Pre-built Binaries</title> | ||
9 | |||
10 | <para>Application developers will download pre-complied images from the | ||
11 | Enea Portal or will receive prebuilt images from the platform developers. | ||
12 | For further information on this see <olink | ||
13 | targetdoc="book_enea_linux_app_dev_guide" | ||
14 | targetptr="book_enea_linux_app_dev_guide">Enea Linux Application | ||
15 | Development Guide</olink>.</para> | ||
16 | </section> | ||
17 | |||
18 | <section id="relinfo-getting-source"> | ||
19 | <title>Getting the Source</title> | ||
20 | |||
21 | <para>The source for this Enea Linux release is available for cloning from | ||
22 | a set of Git repositories. To manage the different repositories, Google's | ||
23 | repo tool is used. The basic idea is to store a list with (repo-URL, | ||
24 | version) tuples in a separate file, known as the manifest. The repo tool | ||
25 | is then used to traverse the list and clone the specified versions of the | ||
26 | repositories. See <ulink | ||
27 | url="https://code.google.com/p/git-repo/">https://code.google.com/p/git-repo/</ulink> | ||
28 | for more info.</para> | ||
29 | |||
30 | <para>To use repo tool to download the source for Enea Linux, follow the | ||
31 | steps below:</para> | ||
32 | |||
33 | <orderedlist> | ||
34 | <listitem> | ||
35 | <para>Make sure that the repo tool is installed. If not, follow the | ||
36 | instructions below:</para> | ||
37 | |||
38 | <para><programlisting>$ curl https://storage.googleapis.com/git-repo-downloads/repo > ~/bin/repo | ||
39 | $ chmod a+x ~/bin/repo</programlisting>The instruction assumes that ~/bin | ||
40 | exists and is included in the PATH variable.</para> | ||
41 | </listitem> | ||
42 | |||
43 | <listitem> | ||
44 | <para>Use the repo tool to download the source:<remark>FIXME: Before | ||
45 | final release the tag for the manifest must be set in Makefile as | ||
46 | MANIFESTHASH, typically something like refs/tags/EL6. Before that, a | ||
47 | generic branch name is used instead, e.g. krogoth in | ||
48 | Makefile</remark></para> | ||
49 | |||
50 | <para><programlisting>$ mkdir enea-linux | ||
51 | $ cd enea-linux | ||
52 | $ repo init -u <xi:include href="../../s_docsrc_common/pardoc-distro.xml" | ||
53 | xmlns:xi="http://www.w3.org/2001/XInclude" | ||
54 | xpointer="element(EneaLinux_MANIFESTURL/1)" /> \ | ||
55 | -b <xi:include href="../../s_docsrc_common/pardoc-distro.xml" | ||
56 | xmlns:xi="http://www.w3.org/2001/XInclude" | ||
57 | xpointer="element(EneaLinux_MANIFESTHASH/1)" /> \ | ||
58 | -m <manifest file> | ||
59 | $ repo sync</programlisting></para> | ||
60 | |||
61 | <para>The parameter <manifest file> depends on the target. See | ||
62 | the following table:</para> | ||
63 | |||
64 | <informaltable> | ||
65 | <tgroup cols="2"> | ||
66 | <thead> | ||
67 | <row> | ||
68 | <entry align="center">Target</entry> | ||
69 | |||
70 | <entry align="center">Manifest file</entry> | ||
71 | </row> | ||
72 | </thead> | ||
73 | |||
74 | <tbody> | ||
75 | <row> | ||
76 | <entry>P2041RDB</entry> | ||
77 | |||
78 | <entry><para>p2041rdb/default.xml</para></entry> | ||
79 | </row> | ||
80 | </tbody> | ||
81 | </tgroup> | ||
82 | </informaltable> | ||
83 | </listitem> | ||
84 | </orderedlist> | ||
85 | |||
86 | <para>The source code is now downloaded. Current directory will contain a | ||
87 | README file with instructions on how to build the distro and boot the | ||
88 | target. For convenience, these instructions are also copied into this | ||
89 | document. See <xref linkend="relinfo-build-boot" />.</para> | ||
90 | |||
91 | <para>It is not necessary to explicitly clone the manifest repository | ||
92 | since that is done automatically by the repo tool. To see the current | ||
93 | manifest, e.g. to get a list of the repositories, use the following | ||
94 | command:</para> | ||
95 | |||
96 | <programlisting>$ repo manifest</programlisting> | ||
97 | |||
98 | <remark>The UG should be updated with instructions on how to add | ||
99 | customisations. That section should also contain some more info about the | ||
100 | manifest: The manifest templates, using a branch instead of the tag EL6, | ||
101 | ... When this is done a reference from here should be added.</remark> | ||
102 | </section> | ||
103 | </chapter> \ 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..5058404 --- /dev/null +++ b/doc/book-enea-linux-release-info/doc/known_bugs_and_limitations.xml | |||
@@ -0,0 +1,453 @@ | |||
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>The open source projects are continuously working on correcting | ||
8 | reported problems. Corrections to bugs detected by Enea have been | ||
9 | upstreamed, and the corrections been included in Enea Linux regardless of | ||
10 | when they will be included by the open source project. Remaining issues are | ||
11 | listed below, and workarounds to some of the problems are described in | ||
12 | chapter <emphasis>Troubleshooting</emphasis> in the <olink | ||
13 | targetdoc="book_enea_linux_users_guide" | ||
14 | targetptr="book_enea_linux_users_guide"><trademark | ||
15 | class="registered">Enea</trademark> Linux User's Guide</olink>.</para> | ||
16 | |||
17 | <section id="bugs-limitations-yocto"> | ||
18 | <title>Yocto</title> | ||
19 | |||
20 | <para>Open source projects often use bug databases for much more than | ||
21 | tracking bugs. The Yocto Project's Bugzilla database also functions as a | ||
22 | feature tracking program, both for the current release and for future | ||
23 | releases, and a way to track non-software issues, like documentation | ||
24 | changes.</para> | ||
25 | |||
26 | <para>The following page shows a sampling of the database: <ulink | ||
27 | url="https://www.yoctoproject.org/tools-resources/bugs">https://www.yoctoproject.org/tools-resources/bugs</ulink>.</para> | ||
28 | |||
29 | <para>For the full database, visit <ulink | ||
30 | url="https://bugzilla.yoctoproject.org">https://bugzilla.yoctoproject.org</ulink>.</para> | ||
31 | </section> | ||
32 | |||
33 | <section id="bugs-limitations-sdk"> | ||
34 | <title>Toolchain / SDK</title> | ||
35 | |||
36 | <itemizedlist spacing="compact"> | ||
37 | <listitem> | ||
38 | <para>Building the kernel might fail if GNU Make of version 3.82 has | ||
39 | been installed on the host. The mandatory recovery action is to revert | ||
40 | to version 3.81.</para> | ||
41 | </listitem> | ||
42 | |||
43 | <listitem> | ||
44 | <para>Installing a second toolchain in the same directory as a | ||
45 | previous one will break the $PATH variable of the first | ||
46 | one.<remark>LXCR-3624</remark></para> | ||
47 | </listitem> | ||
48 | </itemizedlist> | ||
49 | </section> | ||
50 | |||
51 | <section id="bugs-package-manager"> | ||
52 | <title>Smart Package Manager</title> | ||
53 | |||
54 | <para>Installation of some packages might currently fail when installing | ||
55 | using the Smart Package Manager. An example is the qemu package. Errors | ||
56 | can e.g. be reported by smart about conflicts with files from other | ||
57 | packages.</para> | ||
58 | |||
59 | <para>The recommended solution to this problem is to install the failing | ||
60 | package using rpm, already available in enea-image-base. In order to | ||
61 | install it using rpm, first install rpm using the command <command>smart | ||
62 | install rpm</command>, then download the package to the target, and | ||
63 | finally on the target use <command>rpm -i | ||
64 | <packagename>.rpm</command>. If not installed, several dependencies | ||
65 | can be reported as "Failed dependencies" with lines "x is needed by y". In | ||
66 | that case, install the required packages "x" found by dependencies by | ||
67 | using the smart package manager. Add a channel to an accessible directory | ||
68 | containing all missing rpm packages. Add packages detected to be missing, | ||
69 | until all dependencies are resolved.<remark>FIXME It would be nice to add | ||
70 | also a PowerPC example with qemu failing, the example below is for | ||
71 | ARM.</remark></para> | ||
72 | |||
73 | <section> | ||
74 | <title>Example with Failing QEMU Package</title> | ||
75 | |||
76 | <para>As an example, the qemu installation can show the following | ||
77 | error.</para> | ||
78 | |||
79 | <note> | ||
80 | <para>The example below is for ARM, including the RPM names. For | ||
81 | PowerPC similar errors can occur and other packages are needed.</para> | ||
82 | </note> | ||
83 | |||
84 | <para><emphasis role="bold">error: file /var/run from install of | ||
85 | qemu-2.1.0+git0+541bbb07eb-r0.0.aarch64 conflicts with file from package | ||
86 | base-files-3.0.14-r89.0.hierofalcon</emphasis></para> | ||
87 | |||
88 | <para>A solution to this problem is to install the above qemu package | ||
89 | using rpm, already available in enea-image-base. In order to install it | ||
90 | using rpm, first install rpm using the command <command>smart install | ||
91 | rpm</command>, then download the above package from | ||
92 | <build_dir>/tmp/deploy/rpm/aarch64. On target, use <command>rpm -i | ||
93 | qemu-2.1.0+git0+541bbb07eb-r0.0.aarch64.rpm</command>. If not installed, | ||
94 | several dependencies can be seen, e.g.:</para> | ||
95 | |||
96 | <programlisting>error: Failed dependencies: | ||
97 | libpixman-1-0 >= 0.32.6 is needed by qemu-2.1.0+git0+541bbb07eb-r0.0.aarch64 | ||
98 | libpixman-1.so.0()(64bit) is needed by qemu-2.1.0+git0+541bbb07eb-r0.0.aarch64 | ||
99 | libglib-2.0.so.0()(64bit) is needed by qemu-2.1.0+git0+541bbb07eb-r0.0.aarch64 | ||
100 | libcap2 >= 2.22 is needed by qemu-2.1.0+git0+541bbb07eb-r0.0.aarch64 | ||
101 | libglib-2.0-0 >= 2.40.0 is needed by qemu-2.1.0+git0+541bbb07eb-r0.0.aarch64 | ||
102 | bluez4 >= 4.101 is needed by qemu-2.1.0+git0+541bbb07eb-r0.0.aarch64 | ||
103 | libbluetooth.so.3()(64bit) is needed by qemu-2.1.0+git0+541bbb07eb-r0.0.aarch64 | ||
104 | libcap.so.2()(64bit) is needed by qemu-2.1.0+git0+541bbb07eb-r0.0.aarch64</programlisting> | ||
105 | |||
106 | <para>Install the required packages found by dependencies by using the | ||
107 | smart package manager, as specified in the User's Guide, by adding a | ||
108 | channel to an accessible directory containing all of the above rpm | ||
109 | packages. Suggestion for installing required packages, as in the | ||
110 | following example for qemu and ARM:</para> | ||
111 | |||
112 | <programlisting>smart install bash | ||
113 | smart install libcap | ||
114 | smart install bluez4 | ||
115 | smart install libpixman-1-0 | ||
116 | rpm -i qemu-2.1.0+git0+541bbb07eb-r0.0.aarch64.rpm</programlisting> | ||
117 | |||
118 | <para>Add packages detected to be missing until all dependencies are | ||
119 | resolved.</para> | ||
120 | </section> | ||
121 | </section> | ||
122 | |||
123 | <section id="bugs-limitations-eclipse"> | ||
124 | <title>Eclipse Tools</title> | ||
125 | |||
126 | <para>The Eclipse tools provided together with Enea Linux are part of the | ||
127 | Yocto Application Development Toolkit (ADT) and are maintained by | ||
128 | different open source projects. The list below outlines current problems | ||
129 | with the plug-ins as such, as well as kernel limitations when using a tool | ||
130 | towards the mentioned target:</para> | ||
131 | |||
132 | <itemizedlist spacing="compact"> | ||
133 | <listitem> | ||
134 | <para><emphasis role="bold">HOB</emphasis> is currently not supported | ||
135 | on Red Hat.<remark>LXCR-2994, LXCR-3222</remark></para> | ||
136 | </listitem> | ||
137 | |||
138 | <listitem> | ||
139 | <para><emphasis role="bold">SystemTap</emphasis> is currently not | ||
140 | supported on Red Hat.<remark>LXCR-3274</remark></para> | ||
141 | </listitem> | ||
142 | |||
143 | <listitem> | ||
144 | <para>When running <emphasis role="bold">SystemTap</emphasis> for the | ||
145 | first time on a target, you may need to manually ssh into the target | ||
146 | beforehand, in order to add the RSA key of the host to the file | ||
147 | known_hosts. Failing to do so will result in Eclipse freezing with the | ||
148 | progress window displayed, and a terminal message <literal>The | ||
149 | authenticity of host <target_ip> can't be | ||
150 | established</literal>.</para> | ||
151 | </listitem> | ||
152 | |||
153 | <listitem> | ||
154 | <para><emphasis role="bold">SystemTap</emphasis> scripts sometimes | ||
155 | result crosstap error messages about inaccessible variables. This is | ||
156 | not an issue with the tool itself, but stems from the compiler | ||
157 | optimizing away some of the variables. See workaround in the User's | ||
158 | Guide.<remark>LXCR-2204</remark></para> | ||
159 | </listitem> | ||
160 | |||
161 | <listitem> | ||
162 | <para>Currently <emphasis role="bold">BitBake Commander</emphasis> | ||
163 | projects can only be created for a local connection. Due to an | ||
164 | upstream bug, selecting a remote connection causes the Eclipse GUI to | ||
165 | freeze such that it must be killed.<remark>LXCR-2801</remark></para> | ||
166 | </listitem> | ||
167 | |||
168 | <listitem> | ||
169 | <para>A limitation currently makes <emphasis | ||
170 | role="bold">Eclipse</emphasis> non-responding when running a streaming | ||
171 | script, i.e. a script that runs continuously.</para> | ||
172 | </listitem> | ||
173 | |||
174 | <listitem> | ||
175 | <para>The <emphasis role="bold">LatencyTop</emphasis> plug-in for the | ||
176 | P2041 target reports some errors due to the permissions configuration | ||
177 | on the target, but it works correctly if the | ||
178 | <literal>latencytop</literal> command is issued from the Eclipse | ||
179 | console.<remark>LXCR-6303</remark></para> | ||
180 | </listitem> | ||
181 | |||
182 | <listitem> | ||
183 | <para>Currently <emphasis role="bold">LatencyTOP</emphasis> is not | ||
184 | available for ARM kernels built with SMP support due to an ARM | ||
185 | specific limitation in the Linux kernel.</para> | ||
186 | </listitem> | ||
187 | |||
188 | <listitem> | ||
189 | <para><emphasis role="bold">PowerTOP</emphasis> sometimes freezes | ||
190 | Eclipse after displaying a progress bar with message | ||
191 | <literal>Gathering powertop data file | ||
192 | remotely</literal>.<remark>LXCR-3143</remark></para> | ||
193 | </listitem> | ||
194 | |||
195 | <listitem> | ||
196 | <para>When running <emphasis role="bold">powertop</emphasis> from the | ||
197 | Eclipse terminal towards p2020rdb targets it is necessary to specify | ||
198 | the full path in order to find the | ||
199 | command.<remark>LXCR-2265</remark></para> | ||
200 | </listitem> | ||
201 | |||
202 | <listitem> | ||
203 | <para>When running <emphasis role="bold">powertop</emphasis> from the | ||
204 | Eclipse terminal towards zynq ZC702 targets it is necessary to specify | ||
205 | the full path in order to find the | ||
206 | command.<remark>LXCR-2265</remark></para> | ||
207 | </listitem> | ||
208 | |||
209 | <listitem> | ||
210 | <para>The <emphasis role="bold">PowerTOP</emphasis> console in Eclipse | ||
211 | might display messages like <literal>Cannot load | ||
212 | /var/cache/powertop/<filename></literal>. As a workaround, run | ||
213 | <emphasis role="bold">powertop --calibrate</emphasis> for a while to | ||
214 | generate the missing files. See <ulink | ||
215 | url="https://bugzilla.redhat.com/show_bug.cgi?id=698020">Bugzilla | ||
216 | #698020</ulink>.<remark>LXCR-3575</remark></para> | ||
217 | </listitem> | ||
218 | |||
219 | <listitem> | ||
220 | <para><emphasis role="bold">ssh-only</emphasis> is currently the only | ||
221 | supported connection type when running Eclipse tools towards a | ||
222 | target.<remark>LXCR-2799</remark></para> | ||
223 | </listitem> | ||
224 | |||
225 | <listitem> | ||
226 | <para>Hyphen character '-' in the name of the <emphasis | ||
227 | role="bold">Yocto ADT AutoTools project</emphasis> can cause | ||
228 | configuration errors.<remark>LXCR-2290</remark></para> | ||
229 | </listitem> | ||
230 | |||
231 | <listitem> | ||
232 | <para>The <emphasis role="bold">LTTng</emphasis> tool does not work on | ||
233 | <emphasis role="bold">ARM</emphasis> targets, neither from within | ||
234 | Eclipse nor when run directly on target, due to a problem with | ||
235 | lttng-modules and gcc-4.8.x. See <ulink | ||
236 | url="https://bugzilla.yoctoproject.org/show_bug.cgi?id=6015">Bugzilla | ||
237 | #6015</ulink>.<remark>LXCR-2653, LXCR-3053</remark></para> | ||
238 | </listitem> | ||
239 | |||
240 | <listitem> | ||
241 | <para>When running <emphasis role="bold">LTTng</emphasis> from | ||
242 | Eclipse, it sometimes happens that a new session created in the | ||
243 | Control View does not immediately appear under Sessions for that | ||
244 | target. However, the session is created and will appear after | ||
245 | right-clicking "Sessions" and selecting "Refresh".</para> | ||
246 | </listitem> | ||
247 | |||
248 | <listitem> | ||
249 | <para>The<emphasis role="bold"> yocto-bsp</emphasis> properties page | ||
250 | has some problems in the graphical user interface. Occasionally it is | ||
251 | not possible to resize and scroll which makes it impossible to see the | ||
252 | lower part of the properties window.<remark>LXCR-3128</remark></para> | ||
253 | </listitem> | ||
254 | |||
255 | <listitem> | ||
256 | <para>When connecting an Eclipse project configured for <emphasis | ||
257 | role="bold">KGDB</emphasis> (GDB Hardware Debugging) to a 64-bit | ||
258 | PowerPC target, GDB fails to connect unless the architecture is | ||
259 | specified in <filename>.gdbinit</filename>. See <ulink | ||
260 | url="https://bugs.eclipse.org/bugs/show_bug.cgi?id=457697">Bugzilla | ||
261 | #457697</ulink>.<remark>LXCR-3984</remark></para> | ||
262 | </listitem> | ||
263 | </itemizedlist> | ||
264 | </section> | ||
265 | |||
266 | <section id="bugs-limitations-target-side-tools"> | ||
267 | <title>Target-Side Tools</title> | ||
268 | |||
269 | <para>The target-side tools can be run stand-alone on target or from | ||
270 | Eclipse on host. The issues below are only observed when running the tools | ||
271 | directly on target:</para> | ||
272 | |||
273 | <itemizedlist spacing="compact"> | ||
274 | <listitem> | ||
275 | <para>The <emphasis role="bold">perf report</emphasis> command hangs | ||
276 | or crashes due to segmentation fault on ARM | ||
277 | targets.<remark>LXCR-2708</remark></para> | ||
278 | </listitem> | ||
279 | |||
280 | <listitem> | ||
281 | <para>The <emphasis role="bold">perf report</emphasis> does not show | ||
282 | any output for the PandaBoard target.<remark>LXCR-2710</remark></para> | ||
283 | </listitem> | ||
284 | |||
285 | <listitem> | ||
286 | <para><emphasis role="bold">perf top</emphasis> displays for a few | ||
287 | seconds the error message <literal>Failed to open | ||
288 | /tmp/perf-388.map</literal>. Any attempt to exit the subsequent window | ||
289 | causes the system to hang.<remark>LXCR-3113</remark></para> | ||
290 | </listitem> | ||
291 | |||
292 | <listitem> | ||
293 | <para>When running the <command>perf top</command> command on the i.MX | ||
294 | 6Quad SABRE Lite target, the console text may become red after running | ||
295 | for some time (~ 1 minute).<remark>LXCR-3631</remark></para> | ||
296 | </listitem> | ||
297 | |||
298 | <listitem> | ||
299 | <para>The <emphasis role="bold">LTTng</emphasis> tool does not work on | ||
300 | <emphasis role="bold">ARM</emphasis> targets, neither from within | ||
301 | Eclipse nor when run directly on target, due to a problem with | ||
302 | lttng-modules and gcc-4.8.x. See <ulink | ||
303 | url="https://bugzilla.yoctoproject.org/show_bug.cgi?id=6015">Bugzilla | ||
304 | #6015</ulink>.<remark>LXCR-2653, LXCR-3053</remark></para> | ||
305 | </listitem> | ||
306 | |||
307 | <listitem> | ||
308 | <para>The <emphasis role="bold">powertop --calibrate</emphasis> | ||
309 | command does not work on the Keystone k2hk-evm | ||
310 | target.<remark>LXCR-2660</remark></para> | ||
311 | </listitem> | ||
312 | |||
313 | <listitem> | ||
314 | <para>The <emphasis role="bold">powertop</emphasis> command run with | ||
315 | <emphasis role="bold">--calibrate</emphasis> or -<emphasis | ||
316 | role="bold">-time</emphasis> arguments may show some warnings on | ||
317 | PowerPC targets.</para> | ||
318 | </listitem> | ||
319 | |||
320 | <listitem> | ||
321 | <para>When running <emphasis role="bold">powertop</emphasis> on | ||
322 | <emphasis role="bold">ARM</emphasis> targets, the following | ||
323 | warning/error is repeated: <literal>clk_set_rate: failed to set | ||
324 | i2c0_aper rate</literal> . Then powertop stops and the statistics are | ||
325 | no longer updated. What probably happens here is that the cpufreq | ||
326 | governor tries to scale the CPU frequency, but since the I2C clock is | ||
327 | derived from the CPU frequency, the I2C driver implements some policy | ||
328 | to stay within legal frequency limits and rejects the frequency | ||
329 | changes, ending up with the warning message. A <ulink | ||
330 | url="https://github.com/Xilinx/linux-xlnx/commit/0fdd34575efae5c8eced09b6b0a1b723bff4d225">fix</ulink> | ||
331 | has been merged in the linux-xlnx kernel but is not yet propagated | ||
332 | into meta-xilinx.<remark>LXCR-3205, LXCR-3106, | ||
333 | LXCR-2660</remark></para> | ||
334 | </listitem> | ||
335 | |||
336 | <listitem> | ||
337 | <para>If you get an error message like <literal>Cannot load from file | ||
338 | /var/cache/powertop/saved_results.powertop</literal> when running | ||
339 | <emphasis role="bold">powertop</emphasis>, there is most likely not | ||
340 | enough measurement data collected yet. All you have to do is to keep | ||
341 | powertop running for a certain time.<remark>LXCR-2176, LXCR-2660, | ||
342 | LXCR-3106</remark></para> | ||
343 | </listitem> | ||
344 | |||
345 | <listitem> | ||
346 | <para>The message <literal>Model-specific registers (MSR) not found | ||
347 | (try enabling CONFIG_X86_MSR)</literal> appears when you run <emphasis | ||
348 | role="bold">powertop</emphasis> on <emphasis | ||
349 | role="bold">non-x86</emphasis> targets. powertop is mainly an x86n | ||
350 | tool, so it expects X*^_MSR config to be enabled in the kernel. For | ||
351 | non-x86 targets this config is not available in the kernel, hence, | ||
352 | powertop warns about it, but the message can be ignored on those | ||
353 | targets.<remark> LXCR-2176, LXCR-2660, LXCR-3106</remark></para> | ||
354 | </listitem> | ||
355 | |||
356 | <listitem> | ||
357 | <para><emphasis role="bold">powertop</emphasis> issues a message | ||
358 | <literal>sh: /usr/bin/xset: No such file or directory</literal> when | ||
359 | it tries to use xset to configure X display preferences but cannot | ||
360 | find the binary since the image by default contains no X system. The | ||
361 | message can simply be ignored.<remark>LXCR-2176</remark></para> | ||
362 | </listitem> | ||
363 | </itemizedlist> | ||
364 | </section> | ||
365 | |||
366 | <section id="bugs-limitations-virtualization"> | ||
367 | <title>Virtualization</title> | ||
368 | |||
369 | <itemizedlist spacing="compact"> | ||
370 | <listitem> | ||
371 | <para><emphasis role="bold">virtualization</emphasis>: CONFIG_BRIDGE | ||
372 | is not included in the default p2020rdb | ||
373 | kernel.<remark>LXVTCR-273</remark></para> | ||
374 | </listitem> | ||
375 | |||
376 | <listitem> | ||
377 | <para><emphasis role="bold">lxc</emphasis>:</para> | ||
378 | |||
379 | <itemizedlist spacing="compact"> | ||
380 | <listitem> | ||
381 | <para>User namespace is not available on PowerPC targets as it is | ||
382 | an experimental feature in the 3.8 kernel.</para> | ||
383 | </listitem> | ||
384 | |||
385 | <listitem> | ||
386 | <para>If multiple Linux containers are started from the same | ||
387 | process and share resources, destroying the containers might | ||
388 | result in a race condition with error message "Error in | ||
389 | `./lxc-test-concurrent': double free or corruption (fasttop)" | ||
390 | followed by an application | ||
391 | crash."<remark>LXVTCR-365</remark></para> | ||
392 | </listitem> | ||
393 | </itemizedlist> | ||
394 | </listitem> | ||
395 | |||
396 | <listitem> | ||
397 | <para><emphasis role="bold">libvirt</emphasis>: Default network does | ||
398 | not start.<remark>LXVTCR-240</remark></para> | ||
399 | </listitem> | ||
400 | </itemizedlist> | ||
401 | </section> | ||
402 | |||
403 | <section id="bugs-limitations-doc"> | ||
404 | <title>Documentation</title> | ||
405 | |||
406 | <itemizedlist spacing="compact"> | ||
407 | <listitem> | ||
408 | <para><emphasis role="bold">PDF navigation</emphasis>: When using | ||
409 | links to open other PDFs, or jump to another place in the same PDF, | ||
410 | jumping back sometimes fails. This has been observed when opening a | ||
411 | PDF in Adobe Reader, inside a browser with PDF add-on, as well as when | ||
412 | the browser is configured to open PDF files in an external PDF reader. | ||
413 | As a workaround, open the HTML version of the | ||
414 | document.<remark>LXCR-3283</remark></para> | ||
415 | </listitem> | ||
416 | |||
417 | <listitem> | ||
418 | <para><emphasis role="bold">Internet Explorer (IE) cannot display some | ||
419 | web pages</emphasis>: It is recommended to use Firefox or another | ||
420 | non-IE browser for opening external links. If you prefer reading the | ||
421 | documentation in PDF format in Adobe Reader (not in an Adobe plug-in | ||
422 | in a browser), remember to configure a non-IE browser as default | ||
423 | browser to be able to follow all links from within Adobe Reader. | ||
424 | Example of a link that does not work in IE: <ulink | ||
425 | url="https://rt.wiki.kernel.org/">https://rt.wiki.kernel.org/</ulink>. | ||
426 | <remark>LXCR-3281</remark></para> | ||
427 | </listitem> | ||
428 | </itemizedlist> | ||
429 | </section> | ||
430 | |||
431 | <section id="bugs-limitations-other"> | ||
432 | <title>Miscellaneous</title> | ||
433 | |||
434 | <itemizedlist spacing="compact"> | ||
435 | <listitem> | ||
436 | <para>Running <emphasis role="bold">QEMU from an exported | ||
437 | rootfs</emphasis> requires sudo privileges on the host.</para> | ||
438 | </listitem> | ||
439 | |||
440 | <listitem> | ||
441 | <para><emphasis role="bold">menuconfig</emphasis> requires <emphasis | ||
442 | role="bold">Ncurses</emphasis>. If the terminal that pops up | ||
443 | immediately closes instead of showing the menuconfig interface, check | ||
444 | that the Ncurses development library is installed.</para> | ||
445 | </listitem> | ||
446 | </itemizedlist> | ||
447 | </section> | ||
448 | |||
449 | <!-- The file with a section below is autocreated by make init --> | ||
450 | |||
451 | <xi:include href="jiraissues_generated.xml" | ||
452 | xmlns:xi="http://www.w3.org/2001/XInclude" /> | ||
453 | </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..da302c1 --- /dev/null +++ b/doc/book-enea-linux-release-info/doc/main_changes.xml | |||
@@ -0,0 +1,50 @@ | |||
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 in the Enea | ||
8 | Linux release compared to the previous release (Enea Linux 5.0-ppc).</para> | ||
9 | |||
10 | <section id="relinfo-changes-other"> | ||
11 | <title>New Functionality/Enhancements</title> | ||
12 | |||
13 | <remark>Based in the Jira query: 'project = CPDX and fixVersion = "Enea | ||
14 | Linux 6"'</remark> | ||
15 | |||
16 | <itemizedlist spacing="compact"> | ||
17 | <listitem> | ||
18 | <para>New Yocto version (<xi:include | ||
19 | href="../../s_docsrc_common/pardoc-distro.xml" | ||
20 | xmlns:xi="http://www.w3.org/2001/XInclude" | ||
21 | xpointer="element(Yocto_VER/1)" />). See <ulink | ||
22 | url="https://www.yoctoproject.org/downloads/core/krogoth21">https://www.yoctoproject.org/downloads/core/krogoth21</ulink>.</para> | ||
23 | </listitem> | ||
24 | |||
25 | <listitem> | ||
26 | <para>Introduction of the repo tool to manage the Git | ||
27 | repositories.</para> | ||
28 | </listitem> | ||
29 | </itemizedlist> | ||
30 | |||
31 | <para>For details, see the Git logs for the repositories specified in the | ||
32 | manifest files. See <xref linkend="relinfo-getting-source" /> for more inf | ||
33 | on repos and the manifest.</para> | ||
34 | </section> | ||
35 | |||
36 | <section id="relinfo-fixed"> | ||
37 | <title>Problems Fixed in this Release</title> | ||
38 | |||
39 | <para>TBD <remark>FIXME or set condition hidden</remark></para> | ||
40 | </section> | ||
41 | |||
42 | <section id="relinfo-added-drivers"> | ||
43 | <title>Added Drivers</title> | ||
44 | |||
45 | <para>TBD <remark>FIXME or set condition hidden</remark></para> | ||
46 | </section> | ||
47 | |||
48 | <xi:include href="pkgdiff_generated.xml" | ||
49 | xmlns:xi="http://www.w3.org/2001/XInclude" /> | ||
50 | </chapter> \ No newline at end of file | ||
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..587b812 --- /dev/null +++ b/doc/book-enea-linux-release-info/doc/prerequisites.xml | |||
@@ -0,0 +1,49 @@ | |||
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 some packages | ||
8 | to be installed on your Linux development host. See the list of Required | ||
9 | Packages for Host Development System, found in the Yocto 2.1 document: | ||
10 | <ulink | ||
11 | url="https://www.yoctoproject.org/docs/2.1/ref-manual/ref-manual.html#required-packages-for-the-host-development-system">https://www.yoctoproject.org/docs/2.1/ref-manual/ref-manual.html#required-packages-for-the-host-development-system</ulink>. | ||
12 | If needed, replace 2.1 with the actual Yocto version in your Enea Linux | ||
13 | distribution.<remark>Sorry by the list in the Yocto document do not seem to | ||
14 | be enough at all at least for platform building! Therefore we need to add a | ||
15 | complete list here, and we actually have a bigger list than we needed, but | ||
16 | it's better to have more and not be needed than to lack | ||
17 | information.</remark></para> | ||
18 | |||
19 | <para>Install Host Packages</para> | ||
20 | |||
21 | <note> | ||
22 | <para>The list below is generic and might contain packages that are not | ||
23 | necessary. Additional packages might be required to build for some | ||
24 | targets. See the Enea Linux Release Information if more packages are | ||
25 | needed and which hosts have been tested by Enea for this Enea Linux | ||
26 | release.<remark>QUEST: Are the lists below ok? The lists below try to | ||
27 | cover ALL normal use cases for both ApplGuide and PlatfGuide, incl. | ||
28 | Eclipse, instead of limiting to some use case. Easier to keep | ||
29 | updated.</remark></para> | ||
30 | </note> | ||
31 | |||
32 | <section id="inst-host-packages-ubuntu-debian"> | ||
33 | <title>Ubuntu 14.04 LTS, 64-bit</title> | ||
34 | |||
35 | <para>Ensure the system is up-to-date:</para> | ||
36 | |||
37 | <programlisting>$ sudo apt-get update</programlisting> | ||
38 | |||
39 | <para>For a supported <emphasis role="bold">Ubuntu</emphasis><indexterm> | ||
40 | <primary>Ubuntu</primary> | ||
41 | </indexterm> distribution you need the following packages:</para> | ||
42 | |||
43 | <programlisting># sudo apt-get install sed wget subversion git-core | ||
44 | coreutils unzip texi2html texinfo libsdl1.2-dev docbook-utils fop gawk | ||
45 | python-pysqlite2 diffstat make gcc build-essential xsltproc g++ | ||
46 | desktop-file-utils chrpath libgl1-mesa-dev libglu1-mesa-dev autoconf automake | ||
47 | groff libtool xterm libxml-parser-perl</programlisting> | ||
48 | </section> | ||
49 | </chapter> \ No newline at end of file | ||