diff options
Diffstat (limited to 'doc/book-enea-linux-release-info/doc')
11 files changed, 737 insertions, 203 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 index 6907507..01679f8 100644 --- a/doc/book-enea-linux-release-info/doc/about_release.xml +++ b/doc/book-enea-linux-release-info/doc/about_release.xml | |||
@@ -4,16 +4,23 @@ | |||
4 | <chapter id="relinfo-about-release"> | 4 | <chapter id="relinfo-about-release"> |
5 | <title>About This Release</title> | 5 | <title>About This Release</title> |
6 | 6 | ||
7 | <para>This release of Enea Linux <xi:include | 7 | <para>This release of Enea Linux <xi:include href="eltf_params_updated.xml" |
8 | href="../../s_docsrc_common/pardoc-distro.xml" | ||
9 | xmlns:xi="http://www.w3.org/2001/XInclude" | 8 | xmlns:xi="http://www.w3.org/2001/XInclude" |
10 | xpointer="element(EneaLinux_REL_VER/1)" /> provides a publicly available | 9 | xpointer="element(EneaLinux_REL_VER/1)" /> provides a publicly available |
11 | Enea Linux distribution for a selected set of targets. This release is | 10 | Enea Linux distribution for a selected set of targets. This release is |
12 | generated from the yocto distribution using the branch <xi:include | 11 | generated from the yocto <xi:include href="eltf_params_updated.xml" |
13 | href="../../s_docsrc_common/pardoc-distro.xml" | ||
14 | xmlns:xi="http://www.w3.org/2001/XInclude" | 12 | xmlns:xi="http://www.w3.org/2001/XInclude" |
15 | xpointer="element(Yocto_NAME/1)" />.<remark>INFO Yocto distro autopicked | 13 | xpointer="element(Yocto_VER/1)" /> distribution using the branch <xi:include |
16 | from poky.ent as DISTRO_NAME_NO_CAP</remark></para> | 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> | ||
17 | 24 | ||
18 | <section id="relinfo-provided-contents"> | 25 | <section id="relinfo-provided-contents"> |
19 | <title>Provided Contents</title> | 26 | <title>Provided Contents</title> |
@@ -43,8 +50,16 @@ | |||
43 | </row> | 50 | </row> |
44 | 51 | ||
45 | <row> | 52 | <row> |
46 | <entry>Pre-built packages (RPM)</entry> | 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> | ||
47 | </row> | 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)" /> | ||
48 | </tbody> | 63 | </tbody> |
49 | </tgroup> | 64 | </tgroup> |
50 | </informaltable> | 65 | </informaltable> |
@@ -96,76 +111,21 @@ | |||
96 | 111 | ||
97 | <itemizedlist> | 112 | <itemizedlist> |
98 | <listitem> | 113 | <listitem> |
99 | <para>Ubuntu 14.04 LTS, 64-bit<remark>was | 114 | <para>Ubuntu 14.04 LTS, 64-bit<remark>Hardcoded now in this XML file. |
100 | EneaLinux_HOST_VER</remark></para> | 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> | ||
101 | </listitem> | 122 | </listitem> |
102 | </itemizedlist> | 123 | </itemizedlist> |
103 | </section> | 124 | </section> |
104 | 125 | ||
105 | <section id="relinfo-supported-versions"> | 126 | <xi:include href="eltf_params_updated.xml" |
106 | <title>Supported Versions</title> | 127 | xmlns:xi="http://www.w3.org/2001/XInclude" |
107 | 128 | xpointer="element(eltf-target-tables-section)" /> | |
108 | <informaltable> | ||
109 | <tgroup cols="2"> | ||
110 | <thead valign="bottom"> | ||
111 | <row> | ||
112 | <entry>Item</entry> | ||
113 | |||
114 | <entry>Version</entry> | ||
115 | </row> | ||
116 | </thead> | ||
117 | |||
118 | <tbody> | ||
119 | <row> | ||
120 | <entry><para>Yocto</para></entry> | ||
121 | |||
122 | <entry><xi:include href="../../s_docsrc_common/pardoc-distro.xml" | ||
123 | xmlns:xi="http://www.w3.org/2001/XInclude" | ||
124 | xpointer="element(Yocto_VER/1)" /> (<xi:include | ||
125 | href="../../s_docsrc_common/pardoc-distro.xml" | ||
126 | xmlns:xi="http://www.w3.org/2001/XInclude" | ||
127 | xpointer="element(Yocto_NAME/1)" />)<remark>INFO: Auto-fetched | ||
128 | from poky.ent via pardoc-distro.xml</remark></entry> | ||
129 | </row> | ||
130 | |||
131 | <row> | ||
132 | <entry>Poky</entry> | ||
133 | |||
134 | <entry><para>Git commit id:</para> | ||
135 | <para>75ca53211488a3e268037a44ee2a7ac5c7181bd2</para><remark>Problem: | ||
136 | Unfortunately the poky version in poky.ent is not correct unless | ||
137 | the EL release would be based on a Yocto release, so we can not | ||
138 | use that here. This is a problem because we don't want to manually | ||
139 | edit the git commit ID in this file? The poky version in poky.ent | ||
140 | is just now <xi:include | ||
141 | href="../../s_docsrc_common/pardoc-distro.xml" | ||
142 | xmlns:xi="http://www.w3.org/2001/XInclude" | ||
143 | xpointer="element(Poky_VER/1)" /></remark></entry> | ||
144 | </row> | ||
145 | |||
146 | <row> | ||
147 | <entry>GCC</entry> | ||
148 | |||
149 | <entry>5.3<remark>was EneaLinux_GCC_VER Not in poky.ent | ||
150 | </remark></entry> | ||
151 | </row> | ||
152 | |||
153 | <row> | ||
154 | <entry>Linux kernel<remark>was EneaLinux_KERNEL_VER Not in | ||
155 | poky.ent</remark></entry> | ||
156 | |||
157 | <entry><para>3.12</para></entry> | ||
158 | </row> | ||
159 | |||
160 | <row> | ||
161 | <entry>Packages</entry> | ||
162 | |||
163 | <entry>See <xref linkend="relinfo-packages" /></entry> | ||
164 | </row> | ||
165 | </tbody> | ||
166 | </tgroup> | ||
167 | </informaltable> | ||
168 | </section> | ||
169 | 129 | ||
170 | <section id="relinfo-packages"> | 130 | <section id="relinfo-packages"> |
171 | <title>Provided Packages</title> | 131 | <title>Provided Packages</title> |
@@ -194,6 +154,7 @@ | |||
194 | class="registered">Enea</trademark> Linux Open Source | 154 | class="registered">Enea</trademark> Linux Open Source |
195 | Report</olink></para></entry> | 155 | Report</olink></para></entry> |
196 | </row> | 156 | </row> |
157 | |||
197 | </tbody> | 158 | </tbody> |
198 | </tgroup> | 159 | </tgroup> |
199 | </informaltable></para> | 160 | </informaltable></para> |
@@ -211,76 +172,6 @@ | |||
211 | toolchain.</para> | 172 | toolchain.</para> |
212 | </section> | 173 | </section> |
213 | 174 | ||
214 | <section id="relinfo-provided-drivers"> | ||
215 | <title>Supported Drivers</title> | ||
216 | |||
217 | <informaltable> | ||
218 | <tgroup cols="2"> | ||
219 | <colspec align="left" colwidth="3*" /> | ||
220 | |||
221 | <colspec align="center" colwidth="2*" /> | ||
222 | |||
223 | <thead> | ||
224 | <row> | ||
225 | <entry>Driver</entry> | ||
226 | |||
227 | <entry>P2041RDB</entry> | ||
228 | </row> | ||
229 | </thead> | ||
230 | |||
231 | <tbody> | ||
232 | <row> | ||
233 | <entry>Ethernet</entry> | ||
234 | |||
235 | <entry>X</entry> | ||
236 | </row> | ||
237 | |||
238 | <row> | ||
239 | <entry>I2C</entry> | ||
240 | |||
241 | <entry>X</entry> | ||
242 | </row> | ||
243 | |||
244 | <row> | ||
245 | <entry>SPI</entry> | ||
246 | |||
247 | <entry>X</entry> | ||
248 | </row> | ||
249 | |||
250 | <row> | ||
251 | <entry>PCI Express</entry> | ||
252 | |||
253 | <entry>X</entry> | ||
254 | </row> | ||
255 | |||
256 | <row> | ||
257 | <entry>USB</entry> | ||
258 | |||
259 | <entry>X</entry> | ||
260 | </row> | ||
261 | |||
262 | <row> | ||
263 | <entry>Flash</entry> | ||
264 | |||
265 | <entry>X</entry> | ||
266 | </row> | ||
267 | |||
268 | <row> | ||
269 | <entry>SD/SDHC/SDXC</entry> | ||
270 | |||
271 | <entry>X</entry> | ||
272 | </row> | ||
273 | |||
274 | <row> | ||
275 | <entry>RTC</entry> | ||
276 | |||
277 | <entry>X</entry> | ||
278 | </row> | ||
279 | </tbody> | ||
280 | </tgroup> | ||
281 | </informaltable> | ||
282 | </section> | ||
283 | |||
284 | <section id="relinfo-documentation"> | 175 | <section id="relinfo-documentation"> |
285 | <title>Provided Documentation</title> | 176 | <title>Provided Documentation</title> |
286 | 177 | ||
@@ -326,7 +217,7 @@ | |||
326 | </listitem> | 217 | </listitem> |
327 | 218 | ||
328 | <listitem> | 219 | <listitem> |
329 | <para><trademark class="registered">Enea</trademark> Linux 6 Test | 220 | <para><trademark class="registered">Enea</trademark> Linux Test |
330 | Report</para> | 221 | Report</para> |
331 | </listitem> | 222 | </listitem> |
332 | 223 | ||
@@ -343,7 +234,9 @@ | |||
343 | 234 | ||
344 | <para>The functionality in a distribution depends on included packages in | 235 | <para>The functionality in a distribution depends on included packages in |
345 | the default image. In addition to the supported features, the following | 236 | the default image. In addition to the supported features, the following |
346 | functionality is also available, among other:</para> | 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> | ||
347 | 240 | ||
348 | <itemizedlist spacing="compact"> | 241 | <itemizedlist spacing="compact"> |
349 | <listitem> | 242 | <listitem> |
@@ -381,7 +274,9 @@ | |||
381 | <title>Intentional Limitations</title> | 274 | <title>Intentional Limitations</title> |
382 | 275 | ||
383 | <para>The following functionality supported in other Enea Linux releases | 276 | <para>The following functionality supported in other Enea Linux releases |
384 | has been excluded in this release:<itemizedlist spacing="compact"> | 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"> | ||
385 | <listitem> | 280 | <listitem> |
386 | <para>Networking features: DPDK vSwitch, DPDK</para> | 281 | <para>Networking features: DPDK vSwitch, DPDK</para> |
387 | </listitem> | 282 | </listitem> |
diff --git a/doc/book-enea-linux-release-info/doc/book.xml b/doc/book-enea-linux-release-info/doc/book.xml index d1226b9..91af443 100644 --- a/doc/book-enea-linux-release-info/doc/book.xml +++ b/doc/book-enea-linux-release-info/doc/book.xml | |||
@@ -5,7 +5,7 @@ | |||
5 | <book id="book_enea_linux_release_info"> | 5 | <book id="book_enea_linux_release_info"> |
6 | <title><trademark class="registered">Enea</trademark> Linux Release Information</title> | 6 | <title><trademark class="registered">Enea</trademark> Linux Release Information</title> |
7 | <subtitle>Release Version | 7 | <subtitle>Release Version |
8 | <xi:include href="../../s_docsrc_common/pardoc-distro.xml" xpointer="element(EneaLinux_REL_VER/1)" | 8 | <xi:include href="eltf_params_updated.xml" xpointer="element(EneaLinux_REL_VER/1)" |
9 | xmlns:xi="http://www.w3.org/2001/XInclude" /></subtitle> | 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" /> | 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" /> | 11 | <xi:include href="about_release.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> |
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 index 653f943..2200997 100644 --- a/doc/book-enea-linux-release-info/doc/build_boot_template.xml +++ b/doc/book-enea-linux-release-info/doc/build_boot_template.xml | |||
@@ -10,11 +10,13 @@ | |||
10 | reader, the contents of these build/boot instruction have been extracted | 10 | reader, the contents of these build/boot instruction have been extracted |
11 | into the following sections.</para> | 11 | into the following sections.</para> |
12 | 12 | ||
13 | <para><remark>NOTE: Only EDIT THE TEMPLATE FILE! A new build_boot.xml file | 13 | <para><remark>NOTE: Only EDIT THE TEMPLATE build_boot_template.xml file here |
14 | is created from the template and sections are added below automatically from | 14 | and also only edit the manifest template ".README" (name starting by a dot)! |
15 | the README files for each target when building the book! Only in the | 15 | A new build_boot_generated.xml file is created from the template and |
16 | template file you see a line below with SCRIPT_...._HERE and the text | 16 | sections are added below automatically from the README files for each target |
17 | telling that this is a template file.</remark></para> | 17 | when building the book! Only in the template file you see a line below with |
18 | SCRIPT_...._HERE and the text telling that this is a template | ||
19 | file.</remark></para> | ||
18 | 20 | ||
19 | <para>SCRIPT_INCLUDES_BUILD_BOOT_SECTIONS_HERE</para> | 21 | <para>SCRIPT_INCLUDES_BUILD_BOOT_SECTIONS_HERE</para> |
20 | 22 | ||
diff --git a/doc/book-enea-linux-release-info/doc/eltf_params_template.xml b/doc/book-enea-linux-release-info/doc/eltf_params_template.xml new file mode 100644 index 0000000..278ad71 --- /dev/null +++ b/doc/book-enea-linux-release-info/doc/eltf_params_template.xml | |||
@@ -0,0 +1,151 @@ | |||
1 | <?xml version="1.0" encoding="ISO-8859-1"?> | ||
2 | <!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" | ||
3 | "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> | ||
4 | <section id="eltf_created_params"> | ||
5 | <title>File with Parameters in the Book Auto-updated by ELFT</title> | ||
6 | |||
7 | <note> | ||
8 | <para>See the <emphasis | ||
9 | role="bold">eltf_params_updated_template_howto_use.txt</emphasis> text | ||
10 | file for description of how to create the final <emphasis | ||
11 | role="bold">eltf_params_updated.xml</emphasis> from this template and for | ||
12 | all <emphasis role="bold">REQUIREMENTS</emphasis>. Use the command | ||
13 | "<emphasis role="bold">make eltf</emphasis>" to extract a full list of all | ||
14 | ELTF variables, which always begins with ELTF_ and don't only rely on the | ||
15 | howto text file list! The plan is that ELTF will auto-update this when | ||
16 | needed.</para> | ||
17 | </note> | ||
18 | |||
19 | <section id="host_prereq"> | ||
20 | <title>Common Parameters</title> | ||
21 | |||
22 | <bridgehead>A programlisting, ID | ||
23 | "eltf-prereq-apt-get-commands-host"</bridgehead> | ||
24 | |||
25 | <para id="eltf-prereq-apt-get-commands-host"><programlisting>ELTF_PL_HOST_PREREQ</programlisting></para> | ||
26 | |||
27 | <bridgehead>A programlisting, ID | ||
28 | "eltf-getting-repo-install-command"</bridgehead> | ||
29 | |||
30 | <para id="eltf-getting-repo-install-command"><programlisting>ELTF_PL_GET_REPO</programlisting></para> | ||
31 | |||
32 | <bridgehead>Several phrase elements, various IDs. Ensure EL_REL_VER is | ||
33 | correct also compared to the "previous" REL VER in pardoc-distro.xml | ||
34 | "prev_baseline".</bridgehead> | ||
35 | |||
36 | <para id="EneaLinux_REL_VER"><phrase>ELTF_EL_REL_VER</phrase></para> | ||
37 | |||
38 | <para id="Yocto_VER"><phrase>ELTF_YOCTO_VER</phrase></para> | ||
39 | |||
40 | <para id="Yocto_NAME"><phrase>ELTF_YOCTO_NAME</phrase></para> | ||
41 | |||
42 | <para id="ULINK_YOCTO_PROJECT_DOWNLOAD"><ulink | ||
43 | url="ELTF_YOCTO_PROJ_DOWNLOAD_URL">ELTF_YOCTO_PROJ_DOWNLOAD_TXTURL</ulink></para> | ||
44 | |||
45 | <para id="ULINK_ENEA_LINUX_URL"><ulink | ||
46 | url="ELTF_EL_DOWNLOAD_URL">ELTF_EL_DOWNLOAD_TXTURL</ulink></para> | ||
47 | |||
48 | <bridgehead>A programlisting, ID "eltf-repo-cloning-enea-linux". Use | ||
49 | $MACHINE/default.xml as parameter, where MACHINE is one of the target | ||
50 | directory names in the manifest.</bridgehead> | ||
51 | |||
52 | <para id="eltf-repo-cloning-enea-linux"><programlisting>ELTF_PL_CLONE_W_REPO</programlisting></para> | ||
53 | |||
54 | <bridgehead>A table with ONE row, only the row with ID | ||
55 | "eltf-eclipse-version-row" is included in the book. MANUALLY BOTH in the | ||
56 | template.xml and in the updated.xml, set condition hidden on the | ||
57 | <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-linux-release-info/doc/eltf_params_updated.xml b/doc/book-enea-linux-release-info/doc/eltf_params_updated.xml new file mode 100644 index 0000000..a55234f --- /dev/null +++ b/doc/book-enea-linux-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>6</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/el_manifests-networking.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-linux-release-info/doc/eltf_params_updated_template_how_to_use.txt b/doc/book-enea-linux-release-info/doc/eltf_params_updated_template_how_to_use.txt new file mode 100644 index 0000000..7f1d3cb --- /dev/null +++ b/doc/book-enea-linux-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/el_manifests-standard.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-linux-release-info/doc/getting_enea_linux.xml b/doc/book-enea-linux-release-info/doc/getting_enea_linux.xml index 93a5c59..055be15 100644 --- a/doc/book-enea-linux-release-info/doc/getting_enea_linux.xml +++ b/doc/book-enea-linux-release-info/doc/getting_enea_linux.xml | |||
@@ -33,38 +33,34 @@ | |||
33 | <orderedlist> | 33 | <orderedlist> |
34 | <listitem> | 34 | <listitem> |
35 | <para>Make sure that the repo tool is installed. If not, follow the | 35 | <para>Make sure that the repo tool is installed. If not, follow the |
36 | instructions below:</para> | 36 | instructions below. The instruction assumes a suitable place in your |
37 | PATH to use. You might change that.<remark>INFO: Below is include of | ||
38 | ID "eltf-getting-repo-install-command" from | ||
39 | eltf_params_updated.xml</remark></para> | ||
37 | 40 | ||
38 | <para><programlisting>$ curl https://storage.googleapis.com/git-repo-downloads/repo > ~/bin/repo | 41 | <xi:include href="eltf_params_updated.xml" |
39 | $ chmod a+x ~/bin/repo</programlisting>The instruction assumes that ~/bin | 42 | xmlns:xi="http://www.w3.org/2001/XInclude" |
40 | exists and is included in the PATH variable.</para> | 43 | xpointer="element(eltf-getting-repo-install-command/1)" /> |
41 | </listitem> | 44 | </listitem> |
42 | 45 | ||
43 | <listitem> | 46 | <listitem> |
44 | <para>Use the repo tool to download the source:<remark>FIXME: At final | 47 | <para>Use the repo tool to download the source: Please define MACHINE |
45 | release the tag for the manifest must be set in mainfest_conf.mk as | 48 | to your target, uncomment and use one of the MACHINE lines listed |
46 | MANIFESTHASH, typically something like refs/tags/EL6. Before final | 49 | here,<remark>Below is the "machine_list" programlisting in |
47 | release, it is possible to set MANIFESTHASH on the make command line | 50 | machine_list_generated.xml created by the make system by extracting |
48 | to override the value, e.g. with a commit hash string for a release | 51 | from the manifest</remark></para> |
49 | candidate to be tested</remark></para> | ||
50 | 52 | ||
51 | <programlisting>$ mkdir enea-linux | 53 | <xi:include href="machine_list_generated.xml" |
52 | $ cd enea-linux | 54 | xmlns:xi="http://www.w3.org/2001/XInclude" |
53 | $ repo init -u <xi:include href="../../s_docsrc_common/pardoc-distro.xml" | 55 | xpointer="element(machine-list/1)" /> |
54 | xmlns:xi="http://www.w3.org/2001/XInclude" | ||
55 | xpointer="element(EneaLinux_MANIFESTURL/1)" /> \ | ||
56 | -b <xi:include href="../../s_docsrc_common/pardoc-distro.xml" | ||
57 | xmlns:xi="http://www.w3.org/2001/XInclude" | ||
58 | xpointer="element(EneaLinux_MANIFESTHASH/1)" /> \ | ||
59 | -m <manifest file> | ||
60 | $ repo sync</programlisting> | ||
61 | 56 | ||
62 | <para>The parameter <manifest file> depends on the target. Use | 57 | <para>and use the repo command below:<remark> Below is include of ID |
63 | the following:</para> | 58 | "eltf-repo-cloning-enea-linux" from eltf_params_updated.xml. Here the |
59 | $MACHINE shall be given!</remark></para> | ||
64 | 60 | ||
65 | <xi:include element="manifestfiles/1" | 61 | <xi:include href="eltf_params_updated.xml" |
66 | href="manifestfiles_generated.xml" | 62 | xmlns:xi="http://www.w3.org/2001/XInclude" |
67 | xmlns:xi="http://www.w3.org/2001/XInclude" /> | 63 | xpointer="element(eltf-repo-cloning-enea-linux/1)" /> |
68 | </listitem> | 64 | </listitem> |
69 | </orderedlist> | 65 | </orderedlist> |
70 | 66 | ||
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 index 0cd0b13..173046b 100644 --- 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 | |||
@@ -6,16 +6,20 @@ | |||
6 | 6 | ||
7 | <para>The open source projects are continuously working on correcting | 7 | <para>The open source projects are continuously working on correcting |
8 | reported problems. Corrections to bugs detected by Enea are submitted | 8 | reported problems. Corrections to bugs detected by Enea are submitted |
9 | upstream, and the corrections are included in Enea Linux regardless of | 9 | upstream, and the corrections are included in Enea Linux regardless of when |
10 | when they will be included by the open source project. Remaining issues are | 10 | they will be included by the open source project. Remaining issues are |
11 | listed below.</para> | 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> | ||
12 | 16 | ||
13 | <section id="bugs-limitations-yocto"> | 17 | <section id="bugs-limitations-yocto"> |
14 | <title>Yocto</title> | 18 | <title>Yocto</title> |
15 | 19 | ||
16 | <para>The Yocto Project community uses a Bugzilla database to track | 20 | <para>The Yocto Project community uses a Bugzilla database to track |
17 | information on reported bugs and other issues: | 21 | information on reported bugs and other issues: <ulink |
18 | <ulink url="https://bugzilla.yoctoproject.org"> | 22 | url="https://bugzilla.yoctoproject.org"> |
19 | https://bugzilla.yoctoproject.org</ulink>.</para> | 23 | https://bugzilla.yoctoproject.org</ulink>.</para> |
20 | </section> | 24 | </section> |
21 | 25 | ||
@@ -26,7 +30,9 @@ | |||
26 | <listitem> | 30 | <listitem> |
27 | <para>Building the kernel might fail if GNU Make of version 3.82 has | 31 | <para>Building the kernel might fail if GNU Make of version 3.82 has |
28 | been installed on the host. The mandatory recovery action is to revert | 32 | been installed on the host. The mandatory recovery action is to revert |
29 | to version 3.81.</para> | 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> | ||
30 | </listitem> | 36 | </listitem> |
31 | 37 | ||
32 | <listitem> | 38 | <listitem> |
@@ -43,7 +49,8 @@ | |||
43 | <para>Installation of some packages might currently fail when installing | 49 | <para>Installation of some packages might currently fail when installing |
44 | using the Smart Package Manager. An example is the qemu package. Errors | 50 | using the Smart Package Manager. An example is the qemu package. Errors |
45 | can e.g. be reported by smart about conflicts with files from other | 51 | can e.g. be reported by smart about conflicts with files from other |
46 | packages.</para> | 52 | packages.<remark>INFO It is possible to hide this setting condition hidden |
53 | on the section element</remark></para> | ||
47 | 54 | ||
48 | <para>The recommended solution to this problem is to install the failing | 55 | <para>The recommended solution to this problem is to install the failing |
49 | package using rpm, already available in enea-image-base. In order to | 56 | package using rpm, already available in enea-image-base. In order to |
@@ -63,7 +70,8 @@ | |||
63 | <title>Example with Failing QEMU Package</title> | 70 | <title>Example with Failing QEMU Package</title> |
64 | 71 | ||
65 | <para>As an example, the qemu installation can show the following | 72 | <para>As an example, the qemu installation can show the following |
66 | error.</para> | 73 | error.<remark>INFO It is possible to hide this setting condition hidden |
74 | on the section element</remark></para> | ||
67 | 75 | ||
68 | <note> | 76 | <note> |
69 | <para>The example below is for ARM, including the RPM names. For | 77 | <para>The example below is for ARM, including the RPM names. For |
diff --git a/doc/book-enea-linux-release-info/doc/main_changes.xml b/doc/book-enea-linux-release-info/doc/main_changes.xml index c295ade..115acb5 100644 --- a/doc/book-enea-linux-release-info/doc/main_changes.xml +++ b/doc/book-enea-linux-release-info/doc/main_changes.xml | |||
@@ -17,7 +17,7 @@ | |||
17 | <itemizedlist spacing="compact"> | 17 | <itemizedlist spacing="compact"> |
18 | <listitem> | 18 | <listitem> |
19 | <para>New Yocto version (<xi:include | 19 | <para>New Yocto version (<xi:include |
20 | href="../../s_docsrc_common/pardoc-distro.xml" | 20 | href="eltf_params_updated.xml" |
21 | xmlns:xi="http://www.w3.org/2001/XInclude" | 21 | xmlns:xi="http://www.w3.org/2001/XInclude" |
22 | xpointer="element(Yocto_VER/1)" />). See <ulink | 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> | 23 | url="https://www.yoctoproject.org/downloads/core/krogoth21">https://www.yoctoproject.org/downloads/core/krogoth21</ulink>.</para> |
diff --git a/doc/book-enea-linux-release-info/doc/prerequisites.xml b/doc/book-enea-linux-release-info/doc/prerequisites.xml index fb2d208..9c5aa95 100644 --- a/doc/book-enea-linux-release-info/doc/prerequisites.xml +++ b/doc/book-enea-linux-release-info/doc/prerequisites.xml | |||
@@ -4,11 +4,8 @@ | |||
4 | <chapter id="prerequisites"> | 4 | <chapter id="prerequisites"> |
5 | <title>Prerequisites</title> | 5 | <title>Prerequisites</title> |
6 | 6 | ||
7 | <xi:include href="../../s_doceneacommon/doc/system_requirements.xml" | ||
8 | xmlns:xi="http://www.w3.org/2001/XInclude" /> | ||
9 | |||
10 | <para>Building Enea Linux or compiling applications requires that your git | 7 | <para>Building Enea Linux or compiling applications requires that your git |
11 | environment be setup properly, and for certain packages to be installed on | 8 | environment be setup properly and for certain packages to be installed on |
12 | your Linux development host.</para> | 9 | your Linux development host.</para> |
13 | 10 | ||
14 | <para>Please refer to <ulink | 11 | <para>Please refer to <ulink |
@@ -20,18 +17,18 @@ | |||
20 | <programlisting>$ git config --global user.name "John Doe" | 17 | <programlisting>$ git config --global user.name "John Doe" |
21 | $ git config --global user.email johndoe@example.com</programlisting> | 18 | $ git config --global user.email johndoe@example.com</programlisting> |
22 | 19 | ||
23 | <section id="inst-host-packages-ubuntu-debian"> | 20 | <para>First ensure the system is up-to-date, then for the supported |
24 | <title>Ubuntu 14.04 LTS, 64-bit</title> | 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> | ||
25 | 27 | ||
26 | <para>For the supported distribution(s) you need the following packages: | 28 | <xi:include href="eltf_params_updated.xml" |
27 | <remark>INFO: The programlisting below is a parameter in | 29 | xmlns:xi="http://www.w3.org/2001/XInclude" |
28 | eltf_params_updated.xml with ID: "eltf-prereq-apt-get-command-host". If | 30 | xpointer="element(eltf-prereq-apt-get-commands-host/1)" /> |
29 | multiple hosts are supported, store the commands for each host in the same | ||
30 | programlisting with empty lines between each - the comment with the FULL | ||
31 | HOST name and version is essential.</remark></para> | ||
32 | 31 | ||
33 | <!-- <xi:include href="eltf_params_updated.xml" | 32 | <xi:include href="system_requirements.xml" |
34 | xmlns:xi="http://www.w3.org/2001/XInclude" | 33 | xmlns:xi="http://www.w3.org/2001/XInclude" /> |
35 | xpointer="element(eltf-prereq-apt-get-commands-host/1)" /> --> | ||
36 | </section> | ||
37 | </chapter> \ No newline at end of file | 34 | </chapter> \ No newline at end of file |
diff --git a/doc/book-enea-linux-release-info/doc/system_requirements.xml b/doc/book-enea-linux-release-info/doc/system_requirements.xml index 2c14761..e94d012 100644 --- a/doc/book-enea-linux-release-info/doc/system_requirements.xml +++ b/doc/book-enea-linux-release-info/doc/system_requirements.xml | |||
@@ -15,7 +15,7 @@ | |||
15 | and the Yocto Project Reference Manual <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"> | 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>. | 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 links provided with a more | 18 | If needed, replace the Yocto version in the link(s) provided with a more |
19 | recent version.</para> | 19 | recent version.</para> |
20 | 20 | ||
21 | <informaltable> | 21 | <informaltable> |