diff options
author | Miruna Paun <Miruna.Paun@enea.com> | 2017-07-13 18:20:00 +0200 |
---|---|---|
committer | Miruna Paun <Miruna.Paun@enea.com> | 2017-07-13 18:20:00 +0200 |
commit | c35c9680404dd523f5077505e461def00ae1688b (patch) | |
tree | 267b4ab1e8d184750efc4439803d852885e5f2cf /doc/book-enea-nfv-access-release-info/doc | |
parent | e4dba5e0e5bbacb26034009964a15a4dd0c160f2 (diff) | |
download | el_releases-virtualization-c35c9680404dd523f5077505e461def00ae1688b.tar.gz |
Removed all mentioned of the word "Platform"
LXCR-7891 Where it didn't do more harm then good to do so.
Signed-off-by: Miruna Paun <Miruna.Paun@enea.com>
Diffstat (limited to 'doc/book-enea-nfv-access-release-info/doc')
12 files changed, 1739 insertions, 0 deletions
diff --git a/doc/book-enea-nfv-access-release-info/doc/about_release.xml b/doc/book-enea-nfv-access-release-info/doc/about_release.xml new file mode 100644 index 0000000..01679f8 --- /dev/null +++ b/doc/book-enea-nfv-access-release-info/doc/about_release.xml | |||
@@ -0,0 +1,294 @@ | |||
1 | <?xml version="1.0" encoding="ISO-8859-1"?> | ||
2 | <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" | ||
3 | "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> | ||
4 | <chapter id="relinfo-about-release"> | ||
5 | <title>About This Release</title> | ||
6 | |||
7 | <para>This release of Enea Linux <xi:include href="eltf_params_updated.xml" | ||
8 | xmlns:xi="http://www.w3.org/2001/XInclude" | ||
9 | xpointer="element(EneaLinux_REL_VER/1)" /> provides a publicly available | ||
10 | Enea Linux distribution for a selected set of targets. This release is | ||
11 | generated from the yocto <xi:include href="eltf_params_updated.xml" | ||
12 | xmlns:xi="http://www.w3.org/2001/XInclude" | ||
13 | xpointer="element(Yocto_VER/1)" /> distribution using the branch <xi:include | ||
14 | href="eltf_params_updated.xml" xmlns:xi="http://www.w3.org/2001/XInclude" | ||
15 | xpointer="element(Yocto_NAME/1)" />.<remark>INFO <emphasis | ||
16 | role="bold">eltf_params_updated.xml</emphasis> contains many parameters in | ||
17 | the book, also in the open source books, and MUST be created FROM <emphasis | ||
18 | role="bold">eltf_params_template.xml</emphasis>. The parameters are | ||
19 | automatically used in the books, via xi:include statements, similar to how | ||
20 | parameters from pardoc-distro.xml are included in the book. Read the file | ||
21 | <emphasis role="bold">eltf_params_updated_template_how_to_use.txt</emphasis> | ||
22 | for important details about formats and how to do! The idea is that ELTF | ||
23 | will auto-create/update it.</remark></para> | ||
24 | |||
25 | <section id="relinfo-provided-contents"> | ||
26 | <title>Provided Contents</title> | ||
27 | |||
28 | <informaltable> | ||
29 | <tgroup cols="1"> | ||
30 | <thead> | ||
31 | <row> | ||
32 | <entry>Item</entry> | ||
33 | </row> | ||
34 | </thead> | ||
35 | |||
36 | <tbody> | ||
37 | <row> | ||
38 | <entry><para>Source code, recipes and scripts for building the | ||
39 | distribution and SDKs. See <xref | ||
40 | linkend="relinfo-getting-enea-linux" />.</para></entry> | ||
41 | </row> | ||
42 | |||
43 | <row> | ||
44 | <entry><para>Documentation. See <xref | ||
45 | linkend="relinfo-documentation" />.</para></entry> | ||
46 | </row> | ||
47 | |||
48 | <row> | ||
49 | <entry>Pre-built binaries (kernel image, dtb & rootfs)</entry> | ||
50 | </row> | ||
51 | |||
52 | <row> | ||
53 | <entry>Pre-built packages (RPM). See links for each | ||
54 | target.<remark>INFO Below is an Eclipse row from | ||
55 | eltf_params_updated.xml. MANUALLY if eclipse is not included, set | ||
56 | condition hidden on the row element BOTH in template.xml and in | ||
57 | updated.xml.</remark></entry> | ||
58 | </row> | ||
59 | |||
60 | <xi:include href="eltf_params_updated.xml" | ||
61 | xmlns:xi="http://www.w3.org/2001/XInclude" | ||
62 | xpointer="element(eltf-eclipse-version-row)" /> | ||
63 | </tbody> | ||
64 | </tgroup> | ||
65 | </informaltable> | ||
66 | </section> | ||
67 | |||
68 | <section id="relinfo-supported-targets"> | ||
69 | <title>Supported Targets</title> | ||
70 | |||
71 | <informaltable> | ||
72 | <tgroup cols="3"> | ||
73 | <colspec align="left" colname="c1" colwidth="1*" /> | ||
74 | |||
75 | <colspec align="left" colname="c2" colwidth="1*" /> | ||
76 | |||
77 | <colspec align="left" colname="c3" colwidth="1*" /> | ||
78 | |||
79 | <thead valign="bottom"> | ||
80 | <row> | ||
81 | <entry>Target</entry> | ||
82 | |||
83 | <entry>Architecture</entry> | ||
84 | |||
85 | <entry>Specification</entry> | ||
86 | </row> | ||
87 | </thead> | ||
88 | |||
89 | <tbody> | ||
90 | <row> | ||
91 | <entry>P2041RDB</entry> | ||
92 | |||
93 | <entry><para>Power, e500mc</para></entry> | ||
94 | |||
95 | <entry>See <ulink | ||
96 | url="http://www.nxp.com/products/microcontrollers-and-processors/power-architecture-processors/qoriq-power-architecture-processors/p2041-qoriq-reference-design-board:RDP2041BOARD">link | ||
97 | to NXP's datasheet</ulink></entry> | ||
98 | </row> | ||
99 | </tbody> | ||
100 | </tgroup> | ||
101 | </informaltable> | ||
102 | |||
103 | <para><remark>FIXME should autocreate a list of targets, hopefully from | ||
104 | the generated README file, by using MAKEFILE to update pardoc-distro | ||
105 | AND/OR also auto-create an XML file to include here with description text | ||
106 | for each target etc..</remark></para> | ||
107 | </section> | ||
108 | |||
109 | <section id="relinfo-supported-host-environment"> | ||
110 | <title>Supported Host Environment</title> | ||
111 | |||
112 | <itemizedlist> | ||
113 | <listitem> | ||
114 | <para>Ubuntu 14.04 LTS, 64-bit<remark>Hardcoded now in this XML file. | ||
115 | Might be moved to the parameter file later.</remark><remark>INFO Below | ||
116 | is a complete section with ID "eltf-target-tables-section" included | ||
117 | from elft_params_updated.xml. It contains a variable number of target | ||
118 | tables and the section title should be "Supported Targets with | ||
119 | Parameters". It has have a short sentence about what it is in the | ||
120 | beginning. The subtitles shall have the directory name of the target | ||
121 | in the manifest.</remark></para> | ||
122 | </listitem> | ||
123 | </itemizedlist> | ||
124 | </section> | ||
125 | |||
126 | <xi:include href="eltf_params_updated.xml" | ||
127 | xmlns:xi="http://www.w3.org/2001/XInclude" | ||
128 | xpointer="element(eltf-target-tables-section)" /> | ||
129 | |||
130 | <section id="relinfo-packages"> | ||
131 | <title>Provided Packages</title> | ||
132 | |||
133 | <para><informaltable> | ||
134 | <tgroup cols="2"> | ||
135 | <colspec align="left" colname="c1" colwidth="3*" /> | ||
136 | |||
137 | <colspec align="left" colname="c2" colwidth="6*" /> | ||
138 | |||
139 | <thead valign="bottom"> | ||
140 | <row> | ||
141 | <entry>Type of Packages</entry> | ||
142 | |||
143 | <entry>Reference</entry> | ||
144 | </row> | ||
145 | </thead> | ||
146 | |||
147 | <tbody> | ||
148 | <row> | ||
149 | <entry>Packages in Enea Linux</entry> | ||
150 | |||
151 | <entry><para>See the <olink | ||
152 | targetdoc="book_enea_linux_open_source" | ||
153 | targetptr="book_enea_linux_open_source"><trademark | ||
154 | class="registered">Enea</trademark> Linux Open Source | ||
155 | Report</olink></para></entry> | ||
156 | </row> | ||
157 | |||
158 | </tbody> | ||
159 | </tgroup> | ||
160 | </informaltable></para> | ||
161 | </section> | ||
162 | |||
163 | <section id="relinfo-provided-sdk"> | ||
164 | <title>Provided Toolchain/s (SDK)</title> | ||
165 | |||
166 | <para>The SDK contains toolchains supporting cross-compilation of | ||
167 | applications for the targets on an x86_64 host. See the <olink | ||
168 | targetdoc="book_enea_linux_app_dev_guide" | ||
169 | targetptr="book_enea_linux_app_dev_guide"><trademark | ||
170 | class="registered">Enea</trademark> Linux Application Development | ||
171 | Guide</olink> for information on how to build and install a | ||
172 | toolchain.</para> | ||
173 | </section> | ||
174 | |||
175 | <section id="relinfo-documentation"> | ||
176 | <title>Provided Documentation</title> | ||
177 | |||
178 | <para>The following Enea Linux manuals are available:</para> | ||
179 | |||
180 | <itemizedlist spacing="compact"> | ||
181 | <listitem> | ||
182 | <para><trademark class="registered">Enea</trademark> Linux Release | ||
183 | Information (this document)</para> | ||
184 | </listitem> | ||
185 | |||
186 | <listitem> | ||
187 | <para><olink targetdoc="book_enea_linux_platforms_dev_guide" | ||
188 | targetptr="book_enea_linux_platforms_dev_guide"><trademark | ||
189 | class="registered">Enea</trademark> Linux Platforms Development | ||
190 | Guide</olink></para> | ||
191 | </listitem> | ||
192 | |||
193 | <listitem> | ||
194 | <para><olink targetdoc="book_enea_linux_app_dev_guide" | ||
195 | targetptr="book_enea_linux_app_dev_guide"><trademark | ||
196 | class="registered">Enea</trademark> Linux Application Development | ||
197 | Guide</olink></para> | ||
198 | </listitem> | ||
199 | |||
200 | <listitem> | ||
201 | <para><trademark class="registered">Enea</trademark> Linux Networking | ||
202 | Profile Guide</para> | ||
203 | </listitem> | ||
204 | |||
205 | <listitem> | ||
206 | <para><olink targetdoc="book_enea_linux_open_source" | ||
207 | targetptr="book_enea_linux_open_source"><trademark | ||
208 | class="registered">Enea</trademark> Linux Open Source | ||
209 | Report</olink></para> | ||
210 | </listitem> | ||
211 | |||
212 | <listitem> | ||
213 | <para><olink targetdoc="book_enea_linux_eclipse_open_source" | ||
214 | targetptr="book_enea_linux_eclipse_open_source"><trademark | ||
215 | class="registered">Enea</trademark> Linux Eclipse Open Source | ||
216 | Report</olink></para> | ||
217 | </listitem> | ||
218 | |||
219 | <listitem> | ||
220 | <para><trademark class="registered">Enea</trademark> Linux Test | ||
221 | Report</para> | ||
222 | </listitem> | ||
223 | |||
224 | <listitem> | ||
225 | <para><trademark class="registered">Enea</trademark> Linux Real-Time | ||
226 | Guide can be read at <ulink | ||
227 | url="http://linuxrealtime.org">http://linuxrealtime.org</ulink>.</para> | ||
228 | </listitem> | ||
229 | </itemizedlist> | ||
230 | </section> | ||
231 | |||
232 | <section condition="hidden" id="relinfo-provided-other"> | ||
233 | <title>Other Provided Functionality</title> | ||
234 | |||
235 | <para>The functionality in a distribution depends on included packages in | ||
236 | the default image. In addition to the supported features, the following | ||
237 | functionality is also available, among other:<remark>INFO: This section | ||
238 | might be hidden by setting condition hidden on the section, MANUALLY in | ||
239 | this file.</remark></para> | ||
240 | |||
241 | <itemizedlist spacing="compact"> | ||
242 | <listitem> | ||
243 | <para>On target T4240RDB:</para> | ||
244 | |||
245 | <itemizedlist spacing="compact"> | ||
246 | <listitem> | ||
247 | <para>SRIO support in user space (NWRITE, NREAD, msg, | ||
248 | doorbell)</para> | ||
249 | </listitem> | ||
250 | |||
251 | <listitem> | ||
252 | <para>USDPAA</para> | ||
253 | </listitem> | ||
254 | </itemizedlist> | ||
255 | </listitem> | ||
256 | |||
257 | <listitem> | ||
258 | <para>Smart Package Management</para> | ||
259 | </listitem> | ||
260 | </itemizedlist> | ||
261 | </section> | ||
262 | |||
263 | <section id="relinfo-security-fixes"> | ||
264 | <title>Security Fixes</title> | ||
265 | |||
266 | <para>See <ulink | ||
267 | url="http://www.enea.com/solutions/Enea-Linux/Security/CVEs-list">List of | ||
268 | CVEs addressed in Enea Linux</ulink> and <ulink | ||
269 | url="http://www.enea.com/solutions/Enea-Linux/Security#how-to-get-security-updates">How | ||
270 | to Get Security Updates</ulink>.</para> | ||
271 | </section> | ||
272 | |||
273 | <section condition="hidden" id="relinfo-excluded"> | ||
274 | <title>Intentional Limitations</title> | ||
275 | |||
276 | <para>The following functionality supported in other Enea Linux releases | ||
277 | has been excluded in this release:<remark>INFO: This section might be | ||
278 | hidden by setting condition hidden on the section, MANUALLY in this | ||
279 | file.</remark><itemizedlist spacing="compact"> | ||
280 | <listitem> | ||
281 | <para>Networking features: DPDK vSwitch, DPDK</para> | ||
282 | </listitem> | ||
283 | |||
284 | <listitem> | ||
285 | <para>Real-time features: Fully Preemptible Kernel (FPK) from the | ||
286 | PREEMPT_RT patch</para> | ||
287 | </listitem> | ||
288 | |||
289 | <listitem> | ||
290 | <para>Memory features: NUMA</para> | ||
291 | </listitem> | ||
292 | </itemizedlist></para> | ||
293 | </section> | ||
294 | </chapter> \ No newline at end of file | ||
diff --git a/doc/book-enea-nfv-access-release-info/doc/book.xml b/doc/book-enea-nfv-access-release-info/doc/book.xml new file mode 100644 index 0000000..a0adf73 --- /dev/null +++ b/doc/book-enea-nfv-access-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_nfv_access_platform_release_info"> | ||
6 | <title><trademark class="registered">Enea</trademark> NFV Access Platform Release Information</title> | ||
7 | <subtitle>Release Version | ||
8 | <xi:include href="eltf_params_updated.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-nfv-access-release-info/doc/build_boot_template.xml b/doc/book-enea-nfv-access-release-info/doc/build_boot_template.xml new file mode 100644 index 0000000..e39dd81 --- /dev/null +++ b/doc/book-enea-nfv-access-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-nfv-access-release-info/doc/eltf_params_template.xml b/doc/book-enea-nfv-access-release-info/doc/eltf_params_template.xml new file mode 100644 index 0000000..278ad71 --- /dev/null +++ b/doc/book-enea-nfv-access-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 | <row>, 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-nfv-access-release-info/doc/eltf_params_updated.xml b/doc/book-enea-nfv-access-release-info/doc/eltf_params_updated.xml new file mode 100644 index 0000000..40507bb --- /dev/null +++ b/doc/book-enea-nfv-access-release-info/doc/eltf_params_updated.xml | |||
@@ -0,0 +1,165 @@ | |||
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 14.04.5 LTS 64bit | ||
26 | sudo apt-get -y update | ||
27 | sudo 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 | ||
37 | curl https://storage.googleapis.com/git-repo-downloads/repo > ~/bin/repo | ||
38 | chmod a+x ~/bin/repo | ||
39 | export 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>1.0</phrase></para> | ||
46 | |||
47 | <para id="Yocto_VER"><phrase>2.1</phrase></para> | ||
48 | |||
49 | <para id="Yocto_NAME"><phrase>krogoth</phrase></para> | ||
50 | |||
51 | <para id="ULINK_YOCTO_PROJECT_DOWNLOAD"><ulink | ||
52 | url="http://www.yoctoproject.org/downloads/core/krogoth/21">http://www.yoctoproject.org/downloads/core/krogoth/21</ulink></para> | ||
53 | |||
54 | <para id="ULINK_ENEA_LINUX_URL"><ulink | ||
55 | url="https://linux.enea.com/6">https://linux.enea.com/6</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 | ||
62 | cd enea-linux | ||
63 | repo init -u git@git.enea.com:linux/manifests/el_manifests-virtualization.git \ | ||
64 | -b refs/tags/EL6 -m $MACHINE/default.xml | ||
65 | repo 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. Do this both in | ||
70 | template.xml and updated.xml.</bridgehead> | ||
71 | |||
72 | <informaltable> | ||
73 | <tgroup cols="1"> | ||
74 | <tbody> | ||
75 | <row condition="hidden" id="eltf-eclipse-version-row"> | ||
76 | <entry>Eclipse version 4.3 (Mars) plus command line development | ||
77 | tools are included in this Enea Linux release.</entry> | ||
78 | </row> | ||
79 | </tbody> | ||
80 | </tgroup> | ||
81 | </informaltable> | ||
82 | |||
83 | <bridgehead>Below is one big section with title "Supported Targets with | ||
84 | Parameters". The entire section is included completely in the book via ID | ||
85 | "eltf-target-tables-section" and shall be LAST in the template. The | ||
86 | template contains ONE target subsection. COPY/APPEND it, if multiple | ||
87 | targets exist in the release and optionally add rows with additional | ||
88 | target parameters in each target subsection table.</bridgehead> | ||
89 | </section> | ||
90 | |||
91 | <section id="eltf-target-tables-section"> | ||
92 | <title>Supported Targets with Parameters</title> | ||
93 | |||
94 | <para>The tables below describes the target(s) supported in this Enea | ||
95 | Linux release.</para> | ||
96 | |||
97 | <section id="eltf-target-table-p2041rdb"> | ||
98 | <title>MACHINE p2041rdb - Information</title> | ||
99 | |||
100 | <para><informaltable> | ||
101 | <tgroup cols="2"> | ||
102 | <colspec colwidth="6*" /> | ||
103 | |||
104 | <colspec colwidth="9*" /> | ||
105 | |||
106 | <tbody> | ||
107 | <row> | ||
108 | <entry>Target official name</entry> | ||
109 | |||
110 | <entry>P2041RDB</entry> | ||
111 | </row> | ||
112 | |||
113 | <row> | ||
114 | <entry>Architecture and Description</entry> | ||
115 | |||
116 | <entry>Power, e500mc</entry> | ||
117 | </row> | ||
118 | |||
119 | <row> | ||
120 | <entry>Link to target datasheet</entry> | ||
121 | |||
122 | <entry>See <ulink | ||
123 | url="http://www.nxp.com/products/microcontrollers-and-processors/power-architecture-processors/qoriq-power-architecture-processors/p2041-qoriq-reference-design-board:RDP2041BOARD">link | ||
124 | to NXP's datasheet</ulink></entry> | ||
125 | </row> | ||
126 | |||
127 | <row> | ||
128 | <entry>Poky version</entry> | ||
129 | |||
130 | <entry>Git-commit-id: | ||
131 | 75ca53211488a3e268037a44ee2a7ac5c7181bd2</entry> | ||
132 | </row> | ||
133 | |||
134 | <row> | ||
135 | <entry>GCC version</entry> | ||
136 | |||
137 | <entry>5.3</entry> | ||
138 | </row> | ||
139 | |||
140 | <row> | ||
141 | <entry>Linux Kernel Version</entry> | ||
142 | |||
143 | <entry>3.12</entry> | ||
144 | </row> | ||
145 | |||
146 | <row> | ||
147 | <entry>Supported Drivers</entry> | ||
148 | |||
149 | <entry>Ethernet, I2C, SPI, PCI Express, USB, Flash, | ||
150 | SD/SDHC/SDXC, RTC</entry> | ||
151 | </row> | ||
152 | |||
153 | <row> | ||
154 | <entry>Enea rpm folder for downloading RPM packages for this | ||
155 | target</entry> | ||
156 | |||
157 | <entry><ulink | ||
158 | url="https://linux.enea.com/6/p2041rgb/rpm">https://linux.enea.com/6/p2041rgb/rpm</ulink></entry> | ||
159 | </row> | ||
160 | </tbody> | ||
161 | </tgroup> | ||
162 | </informaltable></para> | ||
163 | </section> | ||
164 | </section> | ||
165 | </section> \ No newline at end of file | ||
diff --git a/doc/book-enea-nfv-access-release-info/doc/eltf_params_updated_template_how_to_use.txt b/doc/book-enea-nfv-access-release-info/doc/eltf_params_updated_template_how_to_use.txt new file mode 100644 index 0000000..a75acfc --- /dev/null +++ b/doc/book-enea-nfv-access-release-info/doc/eltf_params_updated_template_how_to_use.txt | |||
@@ -0,0 +1,320 @@ | |||
1 | eltf_params_template_updated_howto_use.txt | ||
2 | |||
3 | This is a way to collect all parameters for an Enea Linux release | ||
4 | in one parameter file, easy to automatically update by ELTF regularly. | ||
5 | |||
6 | NOTE: 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 | |||
9 | NOTE: 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 | |||
17 | The ordinary book XML files use xi:include statements to include elements | ||
18 | from this parameter file. The book XML files can thus be manually edited. | ||
19 | Before editing, you must run "make init". | ||
20 | Any other text in the template or updated.xml file, outside the parts that | ||
21 | are included in the book, are not used but still all must be correct | ||
22 | DocBook XML files. | ||
23 | |||
24 | ELTF work: | ||
25 | template => ELTF replaces ALL ELTF_xxx variables => updated XML file | ||
26 | => push to git only if changed | ||
27 | |||
28 | |||
29 | eltf_params_template.xml (in git) | ||
30 | File used by ELTF to autocreate/update the real parameter | ||
31 | file eltf_params_updated.xml. | ||
32 | |||
33 | eltf_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 | |||
39 | xi: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 | |||
48 | DocBook XML: All XML files must be correct DocBook XML files. | ||
49 | |||
50 | Do 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 | |||
54 | ELTF should autocreate a temporary "real" file but only replace | ||
55 | and push the eltf_params_updated.xml if it is changed. | ||
56 | |||
57 | |||
58 | make eltf | ||
59 | This lists all ELTF_xxx variables and some rules how to treat them | ||
60 | |||
61 | DocBook 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 < > and & | ||
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 | |||
71 | DocBook 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 | |||
81 | DocBook 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 | |||
85 | Each 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 | |||
98 | Tables 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 | |||
102 | Special - 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 | |||
112 | BELOW WE TRY TO EXPLAIN EACH ELTF_* variable, but always check with make eltf | ||
113 | if there are more new variables, missing in this description file. | ||
114 | |||
115 | _____________________________________________________________________________ | ||
116 | ELTF_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 | ||
125 | sudo apt-get update | ||
126 | sudo 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 | _____________________________________________________________________________ | ||
133 | ELTF_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: | ||
137 | mkdir -p ~/bin | ||
138 | curl https://storage.googleapis.com/git-repo-downloads/repo > ~/bin/repo | ||
139 | chmod a+x ~/bin/repo | ||
140 | export PATH=~/bin:$PATH | ||
141 | |||
142 | _____________________________________________________________________________ | ||
143 | ELTF_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: | ||
150 | 6 | ||
151 | or | ||
152 | 6.1 | ||
153 | |||
154 | _____________________________________________________________________________ | ||
155 | ELTF_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: | ||
160 | 2.1 | ||
161 | |||
162 | _____________________________________________________________________________ | ||
163 | ELTF_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: | ||
168 | krogoth | ||
169 | |||
170 | _____________________________________________________________________________ | ||
171 | ELTF_YOCTO_PROJ_DOWNLOAD_TXTURL General parameters. These two are IDENTICAL | ||
172 | ELTF_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: | ||
177 | http://www.yoctoproject.org/downloads/core/krogoth/21 | ||
178 | |||
179 | _____________________________________________________________________________ | ||
180 | ELTF_EL_DOWNLOAD_TXTURL General parameters. These two are IDENTICAL strings | ||
181 | ELTF_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: | ||
187 | http://linux.enea.com/6 | ||
188 | |||
189 | _____________________________________________________________________________ | ||
190 | ELTF_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: | ||
197 | mkdir enea-linux | ||
198 | cd enea-linux | ||
199 | repo init -u git@git.enea.com:linux/manifests/el_manifests-virtualization.git \ | ||
200 | -b refs/tags/EL6 -m $MACHINE/default.xml | ||
201 | repo sync | ||
202 | |||
203 | _____________________________________________________________________________ | ||
204 | ELTF_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. | ||
214 | 4.5 (Mars) | ||
215 | |||
216 | |||
217 | _____________________________________________________________________________ | ||
218 | ELTF_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 | _____________________________________________________________________________ | ||
226 | ELTF_T_MANIFEST_DIR This happens to be in two places. Must be exactly | ||
227 | ELTF_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: | ||
232 | p2041rgb | ||
233 | or | ||
234 | ls1021aiot | ||
235 | or | ||
236 | qemuarm | ||
237 | |||
238 | _____________________________________________________________________________ | ||
239 | ELTF_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: | ||
243 | P2041RGB | ||
244 | or | ||
245 | LS1021a-IoT | ||
246 | or | ||
247 | qemuarm | ||
248 | |||
249 | _____________________________________________________________________________ | ||
250 | ELTF_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: | ||
255 | Power, e500mc | ||
256 | or | ||
257 | ARM Cortex-A7 | ||
258 | |||
259 | _____________________________________________________________________________ | ||
260 | ELTF_T_DS_TXTURL Target specific: "Link to target datasheet. These | ||
261 | ELTF_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: | ||
268 | url="http://wiki.qemu.org">http://wiki.qemu.org | ||
269 | or | ||
270 | url="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 | _____________________________________________________________________________ | ||
273 | ELTF_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: | ||
279 | 15.0.0 | ||
280 | or | ||
281 | Git commit id: 75ca53211488a3e268037a44ee2a7ac5c7181bd2 | ||
282 | |||
283 | _____________________________________________________________________________ | ||
284 | ELTF_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: | ||
290 | 5.3 | ||
291 | |||
292 | _____________________________________________________________________________ | ||
293 | ELTF_T_KERN_VER Target specific: "Linux Kernel Version". Often | ||
294 | different per target. | ||
295 | In book: An <entry> in a row | ||
296 | Example: | ||
297 | 3.12 | ||
298 | |||
299 | _____________________________________________________________________________ | ||
300 | ELTF_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: | ||
306 | Ethernet, I2C, SPI, PCI, USB, SD/SDHC/SDXC | ||
307 | |||
308 | |||
309 | _____________________________________________________________________________ | ||
310 | ELTF_T_EL_RPM_TXTURL Target specific: "Enea rpm folder for downloading | ||
311 | ELTF_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: | ||
318 | url="https://linux.enea.com/6/ls1021aiot/rpm">https://linux.enea.com/6/ls1021aiot/rpm | ||
319 | |||
320 | _____________________________________________________________________________ | ||
diff --git a/doc/book-enea-nfv-access-release-info/doc/getting_enea_linux.xml b/doc/book-enea-nfv-access-release-info/doc/getting_enea_linux.xml new file mode 100644 index 0000000..075ade5 --- /dev/null +++ b/doc/book-enea-nfv-access-release-info/doc/getting_enea_linux.xml | |||
@@ -0,0 +1,205 @@ | |||
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">Enea | ||
18 | Download Portal</ulink>. Log in using the credentials provided. Using the | ||
19 | menu, browse to the <emphasis role="bold">Linux</emphasis> section. You | ||
20 | will now have access to the <emphasis role="bold">Files</emphasis> section | ||
21 | and the <emphasis role="bold">Online Documentation</emphasis> | ||
22 | section.</para> | ||
23 | |||
24 | <para>The Files section lists each Enea Linux distribution, one for each | ||
25 | version and profile, as a separate download package. Clicking on the name | ||
26 | of the distribution will open a new page, which presents further details | ||
27 | about the content of the release and a list of downloadable archives, one | ||
28 | for each hardware target included in the release. Each archive provides | ||
29 | the following content:</para> | ||
30 | |||
31 | <itemizedlist> | ||
32 | <listitem> | ||
33 | <para><emphasis>images</emphasis> directory – this directory | ||
34 | includes the binary image files needed to boot the target with Enea | ||
35 | Linux. This includes the kernel, the root file system, device tree, | ||
36 | etc.</para> | ||
37 | </listitem> | ||
38 | |||
39 | <listitem> | ||
40 | <para><emphasis>sdk</emphasis> directory – this directory | ||
41 | includes the installer for the SDK.</para> | ||
42 | </listitem> | ||
43 | |||
44 | <listitem> | ||
45 | <para><emphasis>rpm</emphasis> directory – this directory | ||
46 | contains all the packages included in the distribution in rpm format, | ||
47 | which can be installed using the package manager.</para> | ||
48 | </listitem> | ||
49 | </itemizedlist> | ||
50 | |||
51 | <para>For faster downloads, each archive is mirrored in several places, | ||
52 | geographically. Choose the archive in the region closest to you.</para> | ||
53 | |||
54 | <para>The Documentation section lists all the documents delivered with the | ||
55 | release:</para> | ||
56 | |||
57 | <itemizedlist> | ||
58 | <listitem> | ||
59 | <para><emphasis role="bold">Enea Linux Platform Developer’s | ||
60 | Guide</emphasis> -intended for Enea Linux platform developers, who | ||
61 | want to configure and build customized Linux kernel images for | ||
62 | embedded system targets, using the Yocto configuration and build | ||
63 | system.</para> | ||
64 | </listitem> | ||
65 | |||
66 | <listitem> | ||
67 | <para><emphasis role="bold">Enea Linux Application Developer's | ||
68 | Guide</emphasis> - dedicated to Enea Linux application developers, who | ||
69 | want to build and run applications.</para> | ||
70 | </listitem> | ||
71 | |||
72 | <listitem> | ||
73 | <para><emphasis role="bold">Enea Linux Virtualization Guide</emphasis> | ||
74 | - provides further information meant to get the most out of the | ||
75 | virtualization features.</para> | ||
76 | </listitem> | ||
77 | |||
78 | <listitem> | ||
79 | <para><emphasis role="bold">Enea Linux Open Source Report</emphasis> - | ||
80 | contains the open source and license information pertaining to | ||
81 | packages provided with this release of Enea Linux.</para> | ||
82 | </listitem> | ||
83 | |||
84 | <listitem> | ||
85 | <para><emphasis role="bold">Enea Linux Eclipse Open Source | ||
86 | Report</emphasis> - contains the open source and license information | ||
87 | pertaining to the Eclipse package provided with this release of Enea | ||
88 | Linux.</para> | ||
89 | </listitem> | ||
90 | |||
91 | <listitem> | ||
92 | <para><emphasis role="bold">Enea Linux Release Info</emphasis> - | ||
93 | provides information about the current released distribution for a | ||
94 | selected set of targets, along with installation requirements and | ||
95 | procedures.</para> | ||
96 | </listitem> | ||
97 | </itemizedlist> | ||
98 | </section> | ||
99 | |||
100 | <section id="relinfo-getting-source"> | ||
101 | <title>Getting the Sources</title> | ||
102 | |||
103 | <para>Enea Linux sources are available for cloning from a set of Git | ||
104 | repositories on <ulink url="https://git.enea.com">git.enea.com</ulink>. | ||
105 | Since Enea Linux requires multiple repositories, Google Repo tool is used | ||
106 | in order to manage configurations and make the cloning step simpler. | ||
107 | Google Repo tool uses files, known as manifests, which store a list of | ||
108 | tuples (repository URL, version). The Repo tool is then used to traverse | ||
109 | the list of tuples in the manifest file and clone the specified versions | ||
110 | of each repository. See <ulink | ||
111 | url="https://code.google.com/p/git-repo/">https://code.google.com/p/git-repo/</ulink> | ||
112 | for more info.</para> | ||
113 | |||
114 | <section id="getting-source-code-step-one"> | ||
115 | <title>Get access to git.enea.com</title> | ||
116 | |||
117 | <para>In order to get access to git.enea.com, a ssh key is required for | ||
118 | Git authentication. If you don't already have such a key, follow the | ||
119 | steps below to generate one:</para> | ||
120 | |||
121 | <orderedlist> | ||
122 | <listitem> | ||
123 | <para>Generate the ssh key pair:</para> | ||
124 | |||
125 | <programlisting>$ ssh-keygen -t rsa</programlisting> | ||
126 | |||
127 | <para>When asked for a password, just press Enter. This will create | ||
128 | two files in the .ssh directory in your home directory.</para> | ||
129 | |||
130 | <programlisting>id_rsa | ||
131 | id_rsa.pub</programlisting> | ||
132 | </listitem> | ||
133 | |||
134 | <listitem> | ||
135 | <para>Copy the public key into an authorized_keys file:</para> | ||
136 | |||
137 | <programlisting>$ cat id_rsa.pub >> authorized_keys</programlisting> | ||
138 | </listitem> | ||
139 | </orderedlist> | ||
140 | |||
141 | <para>Once these steps are done and you have a valid ssh key pair, send | ||
142 | the public key, <emphasis>id_rsa.pub</emphasis>, via email to | ||
143 | <email>mailto:git_support@list.enea.se</email> in order to get access to | ||
144 | <ulink url="https://git.enea.com">git.enea.com</ulink>.</para> | ||
145 | </section> | ||
146 | |||
147 | <section id="getting-source-code-step-two"> | ||
148 | <title>Get Sources</title> | ||
149 | |||
150 | <para>To use the Repo tool to download the sources for Enea Linux, do | ||
151 | the following:</para> | ||
152 | |||
153 | <orderedlist> | ||
154 | <listitem condition="hidden"> | ||
155 | <para>Make sure that the repo tool is installed. If not, do the | ||
156 | following: <remark>Below is include of ID | ||
157 | "eltf-getting-repo-install-command" from | ||
158 | eltf_params_updated.xml</remark></para> | ||
159 | |||
160 | <xi:include href="eltf_params_updated.xml" | ||
161 | xmlns:xi="http://www.w3.org/2001/XInclude" | ||
162 | xpointer="element(eltf-getting-repo-install-command/1)" /> | ||
163 | </listitem> | ||
164 | |||
165 | <listitem> | ||
166 | <para>Define the MACHINE from one of the targets listed | ||
167 | here,<remark>Below is the "machine_list" programlisting in | ||
168 | machine_list_generated.xml created by the make system by extracting | ||
169 | from the manifest</remark></para> | ||
170 | |||
171 | <xi:include href="machine_list_generated.xml" | ||
172 | xmlns:xi="http://www.w3.org/2001/XInclude" | ||
173 | xpointer="element(machine-list/1)" /> | ||
174 | </listitem> | ||
175 | |||
176 | <listitem> | ||
177 | <para>Then use the repo command below:<remark> Below is include of | ||
178 | ID "eltf-repo-cloning-enea-linux" from eltf_params_updated.xml. Here | ||
179 | the $MACHINE shall be given!</remark></para> | ||
180 | |||
181 | <xi:include href="eltf_params_updated.xml" | ||
182 | xmlns:xi="http://www.w3.org/2001/XInclude" | ||
183 | xpointer="element(eltf-repo-cloning-enea-linux/1)" /> | ||
184 | </listitem> | ||
185 | </orderedlist> | ||
186 | |||
187 | <para>Once the source code is downloaded, the current directory will | ||
188 | contain a README file with instructions on how to build the distro and | ||
189 | boot the machine you choose. For ease of use, these instructions are | ||
190 | also copied into this document, see <xref | ||
191 | linkend="relinfo-build-boot" />.</para> | ||
192 | |||
193 | <para>It's not necessary to explicitly clone the manifest repository | ||
194 | since that is done automatically by the repo tool. To see the current | ||
195 | manifest, use the following command:</para> | ||
196 | |||
197 | <programlisting>$ repo manifest</programlisting> | ||
198 | |||
199 | <remark>The UG should be updated with instructions on how to add | ||
200 | customizations. That section should also contain more info about the | ||
201 | manifest: the manifest templates, using a branch instead of the tag EL6, | ||
202 | etc. When this is done a reference from here should be added.</remark> | ||
203 | </section> | ||
204 | </section> | ||
205 | </chapter> \ No newline at end of file | ||
diff --git a/doc/book-enea-nfv-access-release-info/doc/jiraissues_override.xml b/doc/book-enea-nfv-access-release-info/doc/jiraissues_override.xml new file mode 100644 index 0000000..7282d0f --- /dev/null +++ b/doc/book-enea-nfv-access-release-info/doc/jiraissues_override.xml | |||
@@ -0,0 +1,36 @@ | |||
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>Release-Specific Problems</title> | ||
6 | |||
7 | <informaltable> | ||
8 | <tgroup cols="2"> | ||
9 | <colspec colwidth="6*" colname="c1"/> | ||
10 | |||
11 | <colspec align="center" colwidth="1*" colname="c2"/> | ||
12 | |||
13 | <thead> | ||
14 | <row> | ||
15 | <entry align="center">Summary</entry> | ||
16 | |||
17 | <entry>Enea Ref</entry> | ||
18 | </row> | ||
19 | </thead> | ||
20 | |||
21 | <tbody> | ||
22 | <row> | ||
23 | <entry>Eclipse Plug-Ins for Perf and Latencytop are not functioning properly on P2041RDB target.</entry> | ||
24 | |||
25 | <entry>LXCR-6936</entry> | ||
26 | </row> | ||
27 | |||
28 | <row> | ||
29 | <entry><para>LTTng kernel tracing from Eclipse does not work due to RSE connectivity problems.</para><para>As a workaround, traces can be collected on target and visualized on Eclipse, after copying the files on the host system.</para></entry> | ||
30 | |||
31 | <entry>LXCR-7166</entry> | ||
32 | </row> | ||
33 | </tbody> | ||
34 | </tgroup> | ||
35 | </informaltable> | ||
36 | </section> | ||
diff --git a/doc/book-enea-nfv-access-release-info/doc/known_bugs_and_limitations.xml b/doc/book-enea-nfv-access-release-info/doc/known_bugs_and_limitations.xml new file mode 100644 index 0000000..173046b --- /dev/null +++ b/doc/book-enea-nfv-access-release-info/doc/known_bugs_and_limitations.xml | |||
@@ -0,0 +1,267 @@ | |||
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 are submitted | ||
9 | upstream, and the corrections are included in Enea Linux regardless of when | ||
10 | they will be included by the open source project. Remaining issues are | ||
11 | listed below.<remark>INFO: The <emphasis role="bold">Release-Specific | ||
12 | Problems</emphasis> section further down is generated from JIRA with | ||
13 | gen_known_issues.py, but that script is HARDCODED with affectedversion "Enea | ||
14 | Linux 6" and needs to be adapted when a release info for another EL version | ||
15 | changes.</remark></para> | ||
16 | |||
17 | <section id="bugs-limitations-yocto"> | ||
18 | <title>Yocto</title> | ||
19 | |||
20 | <para>The Yocto Project community uses a Bugzilla database to track | ||
21 | information on reported bugs and other issues: <ulink | ||
22 | url="https://bugzilla.yoctoproject.org"> | ||
23 | https://bugzilla.yoctoproject.org</ulink>.</para> | ||
24 | </section> | ||
25 | |||
26 | <section condition="hidden" id="bugs-limitations-sdk"> | ||
27 | <title>Toolchain / SDK</title> | ||
28 | |||
29 | <itemizedlist spacing="compact"> | ||
30 | <listitem> | ||
31 | <para>Building the kernel might fail if GNU Make of version 3.82 has | ||
32 | been installed on the host. The mandatory recovery action is to revert | ||
33 | to version 3.81.<remark>INFO It is possible to hide this entire | ||
34 | subsection by setting condition hidden on the section | ||
35 | element</remark></para> | ||
36 | </listitem> | ||
37 | |||
38 | <listitem> | ||
39 | <para>Installing a second toolchain in the same directory as a | ||
40 | previous one will break the $PATH variable of the first | ||
41 | one.<remark>LXCR-3624</remark></para> | ||
42 | </listitem> | ||
43 | </itemizedlist> | ||
44 | </section> | ||
45 | |||
46 | <section condition="hidden" id="bugs-package-manager"> | ||
47 | <title>Smart Package Manager</title> | ||
48 | |||
49 | <para>Installation of some packages might currently fail when installing | ||
50 | using the Smart Package Manager. An example is the qemu package. Errors | ||
51 | can e.g. be reported by smart about conflicts with files from other | ||
52 | packages.<remark>INFO It is possible to hide this setting condition hidden | ||
53 | on the section element</remark></para> | ||
54 | |||
55 | <para>The recommended solution to this problem is to install the failing | ||
56 | package using rpm, already available in enea-image-base. In order to | ||
57 | install it using rpm, first install rpm using the command <command>smart | ||
58 | install rpm</command>, then download the package to the target, and | ||
59 | finally on the target use <command>rpm -i | ||
60 | <packagename>.rpm</command>. If not installed, several dependencies | ||
61 | can be reported as "Failed dependencies" with lines "x is needed by y". In | ||
62 | that case, install the required packages "x" found by dependencies by | ||
63 | using the smart package manager. Add a channel to an accessible directory | ||
64 | containing all missing rpm packages. Add packages detected to be missing, | ||
65 | until all dependencies are resolved.<remark>FIXME It would be nice to add | ||
66 | also a PowerPC example with qemu failing, the example below is for | ||
67 | ARM.</remark></para> | ||
68 | |||
69 | <section> | ||
70 | <title>Example with Failing QEMU Package</title> | ||
71 | |||
72 | <para>As an example, the qemu installation can show the following | ||
73 | error.<remark>INFO It is possible to hide this setting condition hidden | ||
74 | on the section element</remark></para> | ||
75 | |||
76 | <note> | ||
77 | <para>The example below is for ARM, including the RPM names. For | ||
78 | PowerPC similar errors can occur and other packages are needed.</para> | ||
79 | </note> | ||
80 | |||
81 | <para><emphasis role="bold">error: file /var/run from install of | ||
82 | qemu-2.1.0+git0+541bbb07eb-r0.0.aarch64 conflicts with file from package | ||
83 | base-files-3.0.14-r89.0.hierofalcon</emphasis></para> | ||
84 | |||
85 | <para>A solution to this problem is to install the above qemu package | ||
86 | using rpm, already available in enea-image-base. In order to install it | ||
87 | using rpm, first install rpm using the command <command>smart install | ||
88 | rpm</command>, then download the above package from | ||
89 | <build_dir>/tmp/deploy/rpm/aarch64. On target, use <command>rpm -i | ||
90 | qemu-2.1.0+git0+541bbb07eb-r0.0.aarch64.rpm</command>. If not installed, | ||
91 | several dependencies can be seen, e.g.:</para> | ||
92 | |||
93 | <programlisting>error: Failed dependencies: | ||
94 | libpixman-1-0 >= 0.32.6 is needed by qemu-2.1.0+git0+541bbb07eb-r0.0.aarch64 | ||
95 | libpixman-1.so.0()(64bit) is needed by qemu-2.1.0+git0+541bbb07eb-r0.0.aarch64 | ||
96 | libglib-2.0.so.0()(64bit) is needed by qemu-2.1.0+git0+541bbb07eb-r0.0.aarch64 | ||
97 | libcap2 >= 2.22 is needed by qemu-2.1.0+git0+541bbb07eb-r0.0.aarch64 | ||
98 | libglib-2.0-0 >= 2.40.0 is needed by qemu-2.1.0+git0+541bbb07eb-r0.0.aarch64 | ||
99 | bluez4 >= 4.101 is needed by qemu-2.1.0+git0+541bbb07eb-r0.0.aarch64 | ||
100 | libbluetooth.so.3()(64bit) is needed by qemu-2.1.0+git0+541bbb07eb-r0.0.aarch64 | ||
101 | libcap.so.2()(64bit) is needed by qemu-2.1.0+git0+541bbb07eb-r0.0.aarch64</programlisting> | ||
102 | |||
103 | <para>Install the required packages found by dependencies by using the | ||
104 | smart package manager, as specified in the User's Guide, by adding a | ||
105 | channel to an accessible directory containing all of the above rpm | ||
106 | packages. Suggestion for installing required packages, as in the | ||
107 | following example for qemu and ARM:</para> | ||
108 | |||
109 | <programlisting>smart install bash | ||
110 | smart install libcap | ||
111 | smart install bluez4 | ||
112 | smart install libpixman-1-0 | ||
113 | rpm -i qemu-2.1.0+git0+541bbb07eb-r0.0.aarch64.rpm</programlisting> | ||
114 | |||
115 | <para>Add packages detected to be missing until all dependencies are | ||
116 | resolved.</para> | ||
117 | </section> | ||
118 | </section> | ||
119 | |||
120 | <section condition="hidden" id="bugs-limitations-target-side-tools"> | ||
121 | <title>Target-Side Tools</title> | ||
122 | |||
123 | <itemizedlist spacing="compact"> | ||
124 | <listitem> | ||
125 | <para>The <emphasis role="bold">perf report</emphasis> does not show | ||
126 | any output for the PandaBoard target.<remark>LXCR-2710</remark></para> | ||
127 | </listitem> | ||
128 | |||
129 | <listitem> | ||
130 | <para><emphasis role="bold">perf top</emphasis> displays for a few | ||
131 | seconds the error message <literal>Failed to open | ||
132 | /tmp/perf-388.map</literal>. Any attempt to exit the subsequent window | ||
133 | causes the system to hang.<remark>LXCR-3113</remark></para> | ||
134 | </listitem> | ||
135 | |||
136 | <listitem> | ||
137 | <para>When running the <command>perf top</command> command on the i.MX | ||
138 | 6Quad SABRE Lite target, the console text may become red after running | ||
139 | for some time (~ 1 minute).<remark>LXCR-3631</remark></para> | ||
140 | </listitem> | ||
141 | |||
142 | <listitem> | ||
143 | <para>The <emphasis role="bold">powertop --calibrate</emphasis> | ||
144 | command does not work on the Keystone k2hk-evm | ||
145 | target.<remark>LXCR-2660</remark></para> | ||
146 | </listitem> | ||
147 | |||
148 | <listitem> | ||
149 | <para>The <emphasis role="bold">powertop</emphasis> command run with | ||
150 | <emphasis role="bold">--calibrate</emphasis> or -<emphasis | ||
151 | role="bold">-time</emphasis> arguments may show some warnings on | ||
152 | PowerPC targets.</para> | ||
153 | </listitem> | ||
154 | |||
155 | <listitem> | ||
156 | <para>If you get an error message like <literal>Cannot load from file | ||
157 | /var/cache/powertop/saved_results.powertop</literal> when running | ||
158 | <emphasis role="bold">powertop</emphasis>, there is most likely not | ||
159 | enough measurement data collected yet. All you have to do is to keep | ||
160 | powertop running for a certain time.<remark>LXCR-2176, LXCR-2660, | ||
161 | LXCR-3106</remark></para> | ||
162 | </listitem> | ||
163 | |||
164 | <listitem> | ||
165 | <para>The message <literal>Model-specific registers (MSR) not found | ||
166 | (try enabling CONFIG_X86_MSR)</literal> appears when you run <emphasis | ||
167 | role="bold">powertop</emphasis> on <emphasis | ||
168 | role="bold">non-x86</emphasis> targets. powertop is mainly an x86n | ||
169 | tool, so it expects X*^_MSR config to be enabled in the kernel. For | ||
170 | non-x86 targets this config is not available in the kernel, hence, | ||
171 | powertop warns about it, but the message can be ignored on those | ||
172 | targets.<remark> LXCR-2176, LXCR-2660, LXCR-3106</remark></para> | ||
173 | </listitem> | ||
174 | |||
175 | <listitem> | ||
176 | <para><emphasis role="bold">powertop</emphasis> issues a message | ||
177 | <literal>sh: /usr/bin/xset: No such file or directory</literal> when | ||
178 | it tries to use xset to configure X display preferences but cannot | ||
179 | find the binary since the image by default contains no X system. The | ||
180 | message can simply be ignored.<remark>LXCR-2176</remark></para> | ||
181 | </listitem> | ||
182 | </itemizedlist> | ||
183 | </section> | ||
184 | |||
185 | <section condition="hidden" id="bugs-limitations-virtualization"> | ||
186 | <title>Virtualization</title> | ||
187 | |||
188 | <itemizedlist spacing="compact"> | ||
189 | <listitem> | ||
190 | <para><emphasis role="bold">virtualization</emphasis>: CONFIG_BRIDGE | ||
191 | is not included in the default p2020rdb | ||
192 | kernel.<remark>LXVTCR-273</remark></para> | ||
193 | </listitem> | ||
194 | |||
195 | <listitem> | ||
196 | <para><emphasis role="bold">lxc</emphasis>:</para> | ||
197 | |||
198 | <itemizedlist spacing="compact"> | ||
199 | <listitem> | ||
200 | <para>User namespace is not available on PowerPC targets as it is | ||
201 | an experimental feature in the 3.8 kernel.</para> | ||
202 | </listitem> | ||
203 | |||
204 | <listitem> | ||
205 | <para>If multiple Linux containers are started from the same | ||
206 | process and share resources, destroying the containers might | ||
207 | result in a race condition with error message "Error in | ||
208 | `./lxc-test-concurrent': double free or corruption (fasttop)" | ||
209 | followed by an application | ||
210 | crash."<remark>LXVTCR-365</remark></para> | ||
211 | </listitem> | ||
212 | </itemizedlist> | ||
213 | </listitem> | ||
214 | |||
215 | <listitem> | ||
216 | <para><emphasis role="bold">libvirt</emphasis>: Default network does | ||
217 | not start.<remark>LXVTCR-240</remark></para> | ||
218 | </listitem> | ||
219 | </itemizedlist> | ||
220 | </section> | ||
221 | |||
222 | <section condition="hidden" id="bugs-limitations-doc"> | ||
223 | <title>Documentation</title> | ||
224 | |||
225 | <itemizedlist spacing="compact"> | ||
226 | <listitem> | ||
227 | <para><emphasis role="bold">PDF navigation</emphasis>: When using | ||
228 | links to open other PDFs, or jump to another place in the same PDF, | ||
229 | jumping back sometimes fails. This has been observed when opening a | ||
230 | PDF in Adobe Reader, inside a browser with PDF add-on, as well as when | ||
231 | the browser is configured to open PDF files in an external PDF reader. | ||
232 | As a workaround, open the HTML version of the | ||
233 | document.<remark>LXCR-3283</remark></para> | ||
234 | </listitem> | ||
235 | |||
236 | <listitem> | ||
237 | <para><emphasis role="bold">Internet Explorer (IE) cannot display some | ||
238 | web pages</emphasis>: It is recommended to use Firefox or another | ||
239 | non-IE browser for opening external links. If you prefer reading the | ||
240 | documentation in PDF format in Adobe Reader (not in an Adobe plug-in | ||
241 | in a browser), remember to configure a non-IE browser as default | ||
242 | browser to be able to follow all links from within Adobe Reader. | ||
243 | Example of a link that does not work in IE: <ulink | ||
244 | url="https://rt.wiki.kernel.org/">https://rt.wiki.kernel.org/</ulink>. | ||
245 | <remark>LXCR-3281</remark></para> | ||
246 | </listitem> | ||
247 | </itemizedlist> | ||
248 | </section> | ||
249 | |||
250 | <section condition="hidden" id="bugs-limitations-other"> | ||
251 | <title>Miscellaneous</title> | ||
252 | |||
253 | <itemizedlist spacing="compact"> | ||
254 | <listitem> | ||
255 | <para><emphasis role="bold">menuconfig</emphasis> requires <emphasis | ||
256 | role="bold">Ncurses</emphasis>. If the terminal that pops up | ||
257 | immediately closes instead of showing the menuconfig interface, check | ||
258 | that the Ncurses development library is installed.</para> | ||
259 | </listitem> | ||
260 | </itemizedlist> | ||
261 | </section> | ||
262 | |||
263 | <!-- The file with a section below is autocreated by make init --> | ||
264 | |||
265 | <xi:include href="jiraissues_generated.xml" | ||
266 | xmlns:xi="http://www.w3.org/2001/XInclude" /> | ||
267 | </chapter> \ No newline at end of file | ||
diff --git a/doc/book-enea-nfv-access-release-info/doc/main_changes.xml b/doc/book-enea-nfv-access-release-info/doc/main_changes.xml new file mode 100644 index 0000000..115acb5 --- /dev/null +++ b/doc/book-enea-nfv-access-release-info/doc/main_changes.xml | |||
@@ -0,0 +1,53 @@ | |||
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>N/A.</para> | ||
8 | |||
9 | <para>This is the first release of Enea Linux, Networking profile.</para> | ||
10 | |||
11 | <section condition="hidden" id="relinfo-changes-other"> | ||
12 | <title>New Functionality/Enhancements</title> | ||
13 | |||
14 | <remark>Based in the Jira query: 'project = CPDX and fixVersion = "Enea | ||
15 | Linux 6"'</remark> | ||
16 | |||
17 | <itemizedlist spacing="compact"> | ||
18 | <listitem> | ||
19 | <para>New Yocto version (<xi:include | ||
20 | href="eltf_params_updated.xml" | ||
21 | xmlns:xi="http://www.w3.org/2001/XInclude" | ||
22 | xpointer="element(Yocto_VER/1)" />). See <ulink | ||
23 | url="https://www.yoctoproject.org/downloads/core/krogoth21">https://www.yoctoproject.org/downloads/core/krogoth21</ulink>.</para> | ||
24 | </listitem> | ||
25 | |||
26 | <listitem> | ||
27 | <para>Introduction of the repo tool to manage the Git | ||
28 | repositories.</para> | ||
29 | </listitem> | ||
30 | </itemizedlist> | ||
31 | |||
32 | <para>For details, see the Git logs for the repositories specified in the | ||
33 | manifest files. See <xref linkend="relinfo-getting-source" /> for more inf | ||
34 | on repos and the manifest.</para> | ||
35 | </section> | ||
36 | |||
37 | <section condition="hidden" id="relinfo-fixed"> | ||
38 | <title>Problems Fixed in this Release</title> | ||
39 | |||
40 | <para>TBD <remark>FIXME or set condition hidden</remark></para> | ||
41 | </section> | ||
42 | |||
43 | <section condition="hidden" id="relinfo-added-drivers"> | ||
44 | <title>Added Drivers</title> | ||
45 | |||
46 | <para>TBD <remark>FIXME or set condition hidden</remark></para> | ||
47 | </section> | ||
48 | |||
49 | <!-- | ||
50 | <xi:include href="pkgdiff_generated.xml" | ||
51 | xmlns:xi="http://www.w3.org/2001/XInclude" /> | ||
52 | --> | ||
53 | </chapter> | ||
diff --git a/doc/book-enea-nfv-access-release-info/doc/prerequisites.xml b/doc/book-enea-nfv-access-release-info/doc/prerequisites.xml new file mode 100644 index 0000000..9c5aa95 --- /dev/null +++ b/doc/book-enea-nfv-access-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="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-nfv-access-release-info/doc/system_requirements.xml b/doc/book-enea-nfv-access-release-info/doc/system_requirements.xml new file mode 100644 index 0000000..e94d012 --- /dev/null +++ b/doc/book-enea-nfv-access-release-info/doc/system_requirements.xml | |||
@@ -0,0 +1,162 @@ | |||
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.1 documents: | ||
12 | Yocto Project Start <ulink | ||
13 | url="http://www.yoctoproject.org/docs/2.1/yocto-project-qs/yocto-project-qs.html#yp-resources"> | ||
14 | http://www.yoctoproject.org/docs/2.1/yocto-project-qs/yocto-project-qs.html#yp-resources</ulink> | ||
15 | and the Yocto Project Reference Manual <ulink | ||
16 | url="http://www.yoctoproject.org/docs/2.1/ref-manual/ref-manual.html#intro-requirements"> | ||
17 | http://www.yoctoproject.org/docs/2.1/ref-manual/ref-manual.html#intro-requirements</ulink>. | ||
18 | If needed, replace the Yocto version in the link(s) provided with a more | ||
19 | recent version.</para> | ||
20 | |||
21 | <informaltable> | ||
22 | <tgroup cols="2"> | ||
23 | <colspec align="left" colname="1" colwidth="1*" /> | ||
24 | |||
25 | <colspec align="left" colname="2" colwidth="3*" /> | ||
26 | |||
27 | <spanspec nameend="2" namest="1" spanname="onetwo" /> | ||
28 | |||
29 | <tbody> | ||
30 | <row> | ||
31 | <entry spanname="onetwo"><emphasis role="bold"> Build host | ||
32 | requirements<indexterm> | ||
33 | <primary>system requirements</primary> | ||
34 | </indexterm></emphasis></entry> | ||
35 | </row> | ||
36 | |||
37 | <row> | ||
38 | <entry>Linux distribution</entry> | ||
39 | |||
40 | <entry>The downloaded code shall be built on a Linux host to | ||
41 | generate images for your target or for emulation in QEMU. For | ||
42 | information about the supported hosts and targets, see the <emphasis | ||
43 | role="bold">Enea Linux Release Information</emphasis> in your Enea | ||
44 | Linux distribution.</entry> | ||
45 | </row> | ||
46 | |||
47 | <row> | ||
48 | <entry>Internet access</entry> | ||
49 | |||
50 | <entry>Internet access must be available when building an image, | ||
51 | since bitbake downloads source files from various servers during the | ||
52 | build.</entry> | ||
53 | </row> | ||
54 | |||
55 | <row> | ||
56 | <entry>Packages</entry> | ||
57 | |||
58 | <entry>Depending on the Linux distribution and version on host, some | ||
59 | packages may be required, by bitbake for example. You will install | ||
60 | any required packages while following the installation | ||
61 | instructions.</entry> | ||
62 | </row> | ||
63 | |||
64 | <row> | ||
65 | <entry>Targets</entry> | ||
66 | |||
67 | <entry>Images can be built or downloaded for any of the targets | ||
68 | supported in this release, as specified in the <emphasis | ||
69 | role="bold">Enea Linux Release Information</emphasis>.</entry> | ||
70 | </row> | ||
71 | |||
72 | <row> | ||
73 | <entry>Disk space</entry> | ||
74 | |||
75 | <entry><para>Your system should have at least 50 GB of free disk | ||
76 | space when bitbaking the basic enea-image-name kernel image.</para> | ||
77 | <para>For larger images and to allow for future package extensions | ||
78 | and variations in the build process, a minimum of 100 GB free disk | ||
79 | space is recommended.</para></entry> | ||
80 | </row> | ||
81 | |||
82 | <row> | ||
83 | <entry>Recommended RAM</entry> | ||
84 | |||
85 | <entry><para>Your system must have at least 4 GB available | ||
86 | RAM.</para> <para>It is recommended to have 8 GB RAM available for | ||
87 | parallel build jobs.</para></entry> | ||
88 | </row> | ||
89 | |||
90 | <row> | ||
91 | <entry>Java</entry> | ||
92 | |||
93 | <entry>Java <indexterm> | ||
94 | <primary>java</primary> | ||
95 | </indexterm>is required to run Eclipse. Currenly, Eclipse | ||
96 | generally recommends at least Java 6 JRE/JDK. More information | ||
97 | regarding operating environments for Eclipse, is provided in the | ||
98 | <emphasis>Eclipse Project Release Notes</emphasis> for the version | ||
99 | used. This can usually be found via | ||
100 | http://www.eclipse.org/eclipse/development/readme_eclipse_version. | ||
101 | See the <emphasis role="bold">Enea Linux Release Information | ||
102 | </emphasis>for the Eclipse Version.</entry> | ||
103 | </row> | ||
104 | </tbody> | ||
105 | </tgroup> | ||
106 | </informaltable> | ||
107 | |||
108 | <para>The build time depends on the capacity of the processor and other | ||
109 | hardware, available resources, speed of internet connection, load situation, | ||
110 | etc. E.g: on a fast 16 core machine with 16 GB RAM and SSD disks, a complete | ||
111 | build from source could take about two hours.</para> | ||
112 | |||
113 | <informaltable> | ||
114 | <tgroup cols="2"> | ||
115 | <colspec align="left" colname="1" colwidth="1*" /> | ||
116 | |||
117 | <colspec align="left" colname="2" colwidth="3*" /> | ||
118 | |||
119 | <spanspec nameend="2" namest="1" spanname="onetwo" /> | ||
120 | |||
121 | <tbody> | ||
122 | <row> | ||
123 | <entry spanname="onetwo"><emphasis role="bold">Target | ||
124 | Requirements</emphasis></entry> | ||
125 | </row> | ||
126 | |||
127 | <row> | ||
128 | <entry>External memory</entry> | ||
129 | |||
130 | <entry>To boot a CGL<indexterm> | ||
131 | <primary>CGL</primary> | ||
132 | </indexterm> image, you need at least 16 GB on a hard-disk | ||
133 | drive<indexterm> | ||
134 | <primary>HDD</primary> | ||
135 | </indexterm> on eSATA, USB drive, or SD card.<remark>INFO: (packed | ||
136 | rootfs 4.5 GB + unpacked rootfs 1.5 GB + good | ||
137 | margins)</remark><remark>INFO: NFS does not support SELinux. In | ||
138 | order to have a security-enhanced Linux, one must take off from an | ||
139 | NFS-booted system and proceed with boot from external | ||
140 | memory.</remark></entry> | ||
141 | </row> | ||
142 | </tbody> | ||
143 | </tgroup> | ||
144 | </informaltable> | ||
145 | |||
146 | <section id="ensure-bash"> | ||
147 | <title>System Shell Configuration</title> | ||
148 | |||
149 | <para>Before installing Enea Linux, ensure that bash is the default | ||
150 | shell.</para> | ||
151 | |||
152 | <para>If your system runs Ubuntu, you can use ls -l to ensure | ||
153 | <filename>/usr/bin</filename> is a symbolic link to bash. In case the link | ||
154 | points to dash, which is default in some Ubuntu versions, change it to | ||
155 | bash by running <emphasis role="bold">sudo dpkg-reconfigure | ||
156 | dash</emphasis> and answer <emphasis role="bold">No</emphasis> to the | ||
157 | question "Use dash as the default system shell (/bin/sh)?":</para> | ||
158 | |||
159 | <programlisting># ls -l /bin/sh | ||
160 | lrwxrwxrwx 1 root root 4 2012-03-02 11:53 /bin/sh -> bash</programlisting> | ||
161 | </section> | ||
162 | </section> \ No newline at end of file | ||