summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMiruna Paun <Miruna.Paun@enea.com>2017-08-09 11:10:23 +0200
committerMiruna Paun <Miruna.Paun@enea.com>2017-08-09 11:10:23 +0200
commit9544fb3595a9a47376b04070a3e0f99eb87e49ae (patch)
tree59e467e1a4167755b1f8c6c6be92dbaf23e42677
parentcd3ffd401c3e2ba9baa967637c6e1dafe4011b7f (diff)
downloadnfv-access-documentation-9544fb3595a9a47376b04070a3e0f99eb87e49ae.tar.gz
Fixing issues caused by moving certain xml files to el-common
INTCR-0 Signed-off-by: Miruna Paun <Miruna.Paun@enea.com>
Diffstat
-rw-r--r--doc/Makefile2
-rw-r--r--doc/book-enea-nfv-access-guide/doc/book.xml2
-rw-r--r--doc/book-enea-nfv-access-guide/doc/eltf_params_template.xml2
-rw-r--r--doc/book-enea-nfv-access-guide/doc/eltf_params_updated.xml8
-rw-r--r--doc/book-enea-nfv-access-guide/doc/eltf_params_updated_template_how_to_use.txt320
-rw-r--r--doc/book-enea-nfv-access-guide/doc/getting_started.xml45
-rw-r--r--doc/book-enea-nfv-access-release-info/doc/about_release.xml341
-rw-r--r--doc/book-enea-nfv-access-release-info/doc/book.xml47
-rw-r--r--doc/book-enea-nfv-access-release-info/doc/eltf_params_updated.xml6
-rw-r--r--doc/book-enea-nfv-access-release-info/doc/getting_enea_nfv_access.xml59
-rw-r--r--doc/book-enea-nfv-access-release-info/doc/known_bugs_and_limitations.xml240
-rw-r--r--doc/book-enea-nfv-access-release-info/doc/main_changes.xml22
-rw-r--r--doc/book-enea-nfv-access-release-info/doc/system_requirements_prerequisites.xml (renamed from doc/book-enea-nfv-access-release-info/doc/prerequisites.xml)6
-rw-r--r--doc/init.mk2
14 files changed, 208 insertions, 894 deletions
diff --git a/doc/Makefile b/doc/Makefile
index 70135de..469bd65 100644
--- a/doc/Makefile
+++ b/doc/Makefile
@@ -48,7 +48,7 @@ DOCBOOK_TO_BOOKDIR ?= yes
48DOCBOOK_CLEANTMP ?= yes 48DOCBOOK_CLEANTMP ?= yes
49 49
50#Components (books) in this subsystem. Now use all books found here 50#Components (books) in this subsystem. Now use all books found here
51# COMPONENTS := book-enea-nfv-access-release-info book-enea-linux-open-source 51COMPONENTS := book-enea-nfv-access-release-info book-enea-linux-open-source
52# COMPONENTS += book-enea-linux-eclipse-open-source (as of 13.04.2017 this is not needed) 52# COMPONENTS += book-enea-linux-eclipse-open-source (as of 13.04.2017 this is not needed)
53COMPONENTS := $(shell ls -d book-enea* ) 53COMPONENTS := $(shell ls -d book-enea* )
54 54
diff --git a/doc/book-enea-nfv-access-guide/doc/book.xml b/doc/book-enea-nfv-access-guide/doc/book.xml
index f23213c..368f9ba 100644
--- a/doc/book-enea-nfv-access-guide/doc/book.xml
+++ b/doc/book-enea-nfv-access-guide/doc/book.xml
@@ -25,6 +25,4 @@
25 xmlns:xi="http://www.w3.org/2001/XInclude" /> 25 xmlns:xi="http://www.w3.org/2001/XInclude" />
26 <xi:include href="using_nfv_access_sdks.xml" 26 <xi:include href="using_nfv_access_sdks.xml"
27 xmlns:xi="http://www.w3.org/2001/XInclude" /> 27 xmlns:xi="http://www.w3.org/2001/XInclude" />
28 <xi:include href="../../s_docbuild/template/docsrc_common/contacting_enea_enea_linux.xml"
29 xmlns:xi="http://www.w3.org/2001/XInclude" />
30</book> 28</book>
diff --git a/doc/book-enea-nfv-access-guide/doc/eltf_params_template.xml b/doc/book-enea-nfv-access-guide/doc/eltf_params_template.xml
index 862eb23..eaa7ebd 100644
--- a/doc/book-enea-nfv-access-guide/doc/eltf_params_template.xml
+++ b/doc/book-enea-nfv-access-guide/doc/eltf_params_template.xml
@@ -79,7 +79,7 @@
79 <title>Supported Targets with Parameters</title> 79 <title>Supported Targets with Parameters</title>
80 80
81 <para>The tables below describes the target(s) supported in this Enea 81 <para>The tables below describes the target(s) supported in this Enea
82 Linux release.</para> 82 NFV Access release.</para>
83 83
84 <section id="eltf-target-table-ELTF_T_MANIFEST_DIR"> 84 <section id="eltf-target-table-ELTF_T_MANIFEST_DIR">
85 <title>MACHINE ELTF_T_MANIFEST_DIR - Information</title> 85 <title>MACHINE ELTF_T_MANIFEST_DIR - Information</title>
diff --git a/doc/book-enea-nfv-access-guide/doc/eltf_params_updated.xml b/doc/book-enea-nfv-access-guide/doc/eltf_params_updated.xml
index 424751e..f6bd068 100644
--- a/doc/book-enea-nfv-access-guide/doc/eltf_params_updated.xml
+++ b/doc/book-enea-nfv-access-guide/doc/eltf_params_updated.xml
@@ -60,7 +60,7 @@ export PATH=~/bin:$PATH</programlisting></para>
60 60
61 <para id="eltf-repo-cloning-enea-linux"><programlisting>mkdir enea-linux 61 <para id="eltf-repo-cloning-enea-linux"><programlisting>mkdir enea-linux
62cd enea-linux 62cd enea-linux
63repo init -u git://git.enea.com/linux/el_manifests-networking.git \ 63repo init -u git@git.enea.com:linux/manifests/el_manifests-virtualization.git \
64 -b refs/tags/EL6 -m $MACHINE/default.xml 64 -b refs/tags/EL6 -m $MACHINE/default.xml
65repo sync</programlisting></para> 65repo sync</programlisting></para>
66 66
@@ -89,10 +89,10 @@ repo sync</programlisting></para>
89 </section> 89 </section>
90 90
91 <section id="eltf-target-tables-section"> 91 <section id="eltf-target-tables-section">
92 <title>Supported Targets with Parameters</title> 92 <title>Supported Reference Boards with Parameters</title>
93 93
94 <para>The tables below describes the target(s) supported in this Enea 94 <para>The tables below describes the target(s) supported in this Enea NFV
95 Linux release.</para> 95 Access release.</para>
96 96
97 <section id="eltf-target-table-p2041rdb"> 97 <section id="eltf-target-table-p2041rdb">
98 <title>MACHINE p2041rdb - Information</title> 98 <title>MACHINE p2041rdb - Information</title>
diff --git a/doc/book-enea-nfv-access-guide/doc/eltf_params_updated_template_how_to_use.txt b/doc/book-enea-nfv-access-guide/doc/eltf_params_updated_template_how_to_use.txt
deleted file mode 100644
index 87a6445..0000000
--- a/doc/book-enea-nfv-access-guide/doc/eltf_params_updated_template_how_to_use.txt
+++ /dev/null
@@ -1,320 +0,0 @@
1eltf_params_template_updated_howto_use.txt
2
3This is a way to collect all parameters for an Enea NFV Access release
4in one parameter file, easy to automatically update by ELTF regularly.
5
6NOTE: Both the release info AND the open source books use parameters from
7 here, but the XML file is inside the release info book directory.
8
9NOTE: The manifest_conf.mk, or overridden by the environment variable
10 MANIFESTHASH, contains the full tag (or hashvalue) for downloading
11 the manifest when the books are built. The list of target
12 directories are fetched from the manifest into the book.
13 The eltf_params_updates.xml can all the time contain
14 the final next complete tag e.g. refs/tags/EL6 or similar
15 in the ELTF_PL_CLONE_W_REPO parameter command lines.
16
17The ordinary book XML files use xi:include statements to include elements
18from this parameter file. The book XML files can thus be manually edited.
19Before editing, you must run "make init".
20Any other text in the template or updated.xml file, outside the parts that
21are included in the book, are not used but still all must be correct
22DocBook XML files.
23
24ELTF work:
25 template => ELTF replaces ALL ELTF_xxx variables => updated XML file
26 => push to git only if changed
27
28
29eltf_params_template.xml (in git)
30 File used by ELTF to autocreate/update the real parameter
31 file eltf_params_updated.xml.
32
33eltf_params_updated.xml (in git)
34 Real parameter file where ELTF has replaced all ELTF_xx variables with
35 strings, in several cases with multiline strings.
36 No spaces or linefeed allowed in beginning or end of the variable values!
37
38
39xi:include: Each parameter is xi:include'ed in various book files, using
40 the IDs existing in the parameter files.
41 In most cases the 1:st element inside an element with an ID is included
42 using a format like eltf-prereq-apt-get-commands-host/1.
43 In very few cases the element with the ID is included in the book, one
44 example is the target section which has an ID, but which contains
45 multiple subsections, one per target.
46 All IDs in a book must be unique.
47
48DocBook XML: All XML files must be correct DocBook XML files.
49
50Do NOT edit/save the real *updated.xml file with XMLmind to avoid changes
51 not done by ELTF. But it is OK to open the real file in XMLmind to
52 check that the format is correct.
53
54ELTF should autocreate a temporary "real" file but only replace
55 and push the eltf_params_updated.xml if it is changed.
56
57
58make eltf
59 This lists all ELTF_xxx variables and some rules how to treat them
60
61DocBook Format: All elements - rules:
62 Several strict generic XML rules apply for all strings:
63 1. No TABs allowed or any other control chr than "linefeed"
64 2. Only 7-bit ASCII
65 3. Any < > & must be converted to &lt; &gt; and &amp;
66 Similar for any other non-7-bit-ASCII but avoid those!
67 4. No leading spaces or linefeeds when replacing the ELTF_* variable
68 5. No trailing spaces or linefeeds when replacing the ELTF_* variable
69 6. Note: Keep existing spaces before/efter ELTF_* in a few cases.
70
71DocBook Format: <programlisting> - rules: ELTF*PL* variables
72 Several strict rules apply for the multiline string in programlisting
73 in addition to the general XML rules above:
74 7. Max line length < 80 char
75 8. Use backslash (\) to break longer lines
76 9. Use spaces (e.g. 4) to indent continuation lines in programlistings
77 10. No trailing spaces on any line
78 11. No spaces or linefeed immediately after leading <programlisting>
79 12. No spaces or linefeed before trailing </programlisting>
80
81DocBook Format: <ulink> - rules: ELTF_*URL* variables
82 13. ELTF_*URL and corresponding ELTF_*TXTURL shall be identical strings
83 14. Only if the URL is extremely long, the TXTURL can be a separate string
84
85Each target has one section with target parameters:
86 <section id="eltf-target-table-ELTF_T_MANIFEST_DIR">
87 <title>MACHINE ELTF_T_MANIFEST_DIR - Information</title>
88 ..... with many ELTF_ variables ....
89 </section>
90
91 15. If there is only one target. ELTF just replaces ELTF parameters
92
93 16. It there are multiple targets. ELTF copies the section and appends the
94 section the required number of times.
95 Each section ID will become unique: eltf-target-table-ELTF_T_MANIFEST_DIR
96 Each section title will become unique
97
98Tables with target parameters in each target section:
99 17. It is possible for ELTF to append more rows with one parameter each
100 to these tables, because the entire tables are included in the book
101
102Special - NOT YET READY DEFINED how to handle the optionally included
103 Eclipse and its version, but this is a first suggestion:
104 18. Just now ELTF can define ELFT_ECLIPSE_VERSION as a full string
105 with both version number and name,
106 19. MANUALLY if Eclipse is NOT included in the release,
107 the release manager should manually set condition="hidden" on
108 the entire section in the book XML about Eclipse
109
110
111
112BELOW WE TRY TO EXPLAIN EACH ELTF_* variable, but always check with make eltf
113if there are more new variables, missing in this description file.
114
115_____________________________________________________________________________
116ELTF_PL_HOST_PREREQ Multiline list of host prerequisites, e.g. commands
117 like sudo apt-get install xxxx or similar.
118 First line = comment with the complete host name!
119 It is possible to include multiple hosts by just
120 adding an empty line, comment with host name, etc.
121 xi:include eltf-prereq-apt-get-commands-host/1
122 This is a <programlisting>...</programlisting>
123 Example:
124# Host Ubuntu 14.04.5 LTS 64bit
125sudo apt-get update
126sudo apt-get install sed wget subversion git-core coreutils unzip texi2html \
127 texinfo libsdl1.2-dev docbook-utils fop gawk python-pysqlite2 diffstat \
128 make gcc build-essential xsltproc g++ desktop-file-utils chrpath \
129 libgl1-mesa-dev libglu1-mesa-dev autoconf automake groff libtool xterm \
130 libxml-parser-perl
131
132_____________________________________________________________________________
133ELTF_PL_GET_REPO Multiline commands to download the repo tool
134 xi:include eltf-getting-repo-install-command/1
135 This is a <programlisting>...</programlisting>
136 Example:
137mkdir -p ~/bin
138curl https://storage.googleapis.com/git-repo-downloads/repo > ~/bin/repo
139chmod a+x ~/bin/repo
140export PATH=~/bin:$PATH
141
142_____________________________________________________________________________
143ELTF_EL_REL_VER General parameter string: The version of this Enea
144 Linux release. Major version and optional .Minor
145 Typically created from MAJOR and MINOR in enea.conf
146 MINOR in enea.conf is empty or contains a dot+minor
147 xi_include EneaLinux_REL_VER/1
148 This is a <phrase>X.x</phrase> used in many places.
149 Examples:
1506
151 or
1526.1
153
154_____________________________________________________________________________
155ELTF_YOCTO_VER General parameter string: Yocto version, created
156 from DISTRO in poky.ent
157 xi:include Yocto_VER/1
158 This is a <phrase>X.x</phrase> used in many places.
159 Example:
1602.1
161
162_____________________________________________________________________________
163ELTF_YOCTO_NAME General parameter string: Yocto name (branch), created
164 from DISTRO_NAME_NO_CAP in poky.ent
165 xi:include Yocto_NAME/1
166 This is a <phrase>X.x</phrase> used in many places.
167 Example:
168krogoth
169
170_____________________________________________________________________________
171ELTF_YOCTO_PROJ_DOWNLOAD_TXTURL General parameters. These two are IDENTICAL
172ELTF_YOCTO_PROJ_DOWNLOAD_URL strings with correct Yocto version string
173 at the end, typically without "dot".
174 xi:include ULINK_YOCTO_PROJECT_DOWNLOAD/1
175 This is an <ulink url="...">...</ulink>
176 Example:
177http://www.yoctoproject.org/downloads/core/krogoth/21
178
179_____________________________________________________________________________
180ELTF_EL_DOWNLOAD_TXTURL General parameters. These two are IDENTICAL strings
181ELTF_EL_DOWNLOAD_URL and shall be the http:/..... address where
182 Enea NFV Access can be downloaded
183 Often containing same version as in ELTF_EL_REL_VER
184 xi:include ULINK_ENEA_LINUX_URL/1
185 This is an <ulink url="...">...</ulink>
186 Example:
187http://linux.enea.com/6
188
189_____________________________________________________________________________
190ELTF_PL_CLONE_W_REPO Multiline commands to run repo to clone everything.
191 Use the variable $MACHINE/default.xml (the text in
192 the book will list the avaiable values of MACHINE,
193 taken from the manifest repository)
194 xi:include eltf-repo-cloning-enea-linux/1
195 This is a <programlisting>...</programlisting>
196 Example:
197mkdir enea-linux
198cd enea-linux
199repo init -u git://git.enea.com/linux/el_manifests-standard.git \
200 -b refs/tags/EL6 -m $MACHINE/default.xml
201repo sync
202
203_____________________________________________________________________________
204ELTF_ECLIPSE_VERSION Optional general parameter string.
205 NOT YET READY DEFINED
206 Just now a release manage must manually set
207 condition="hidden" on the Eclipse section,
208 if Eclipse is not included in the release.
209 ELTF just replaces ELTF_ECLIPSE_VERSION with a full
210 string with "X.Y (name)"
211 It includes the ID and can only be ONCE in the book.
212 xi:include eltf-eclipse-version-row
213 Example.
2144.5 (Mars)
215
216
217_____________________________________________________________________________
218ELTF_T_* All these are in each target (MACHINE) and ELTF
219 must separately replace them with strings for
220 each target
221 NOTE: All (except the MANIFEST_DIR) are in rows
222 in a table and ELTF can select to append
223 more parameters by adding more rows
224
225_____________________________________________________________________________
226ELTF_T_MANIFEST_DIR This happens to be in two places. Must be exactly
227ELTF_T_MANIFEST_DIR the directory name in the manifest, e.g. same
228 as the MACHINE names in $MACHINE/default.xml.
229 In book: a) Part of section ID
230 b) Part of section title
231 Examples:
232p2041rgb
233 or
234ls1021aiot
235 or
236qemuarm
237
238_____________________________________________________________________________
239ELTF_T_NAME Target specific: "Target Official Name"
240 NOT same as the target directory name in most cases.
241 In book: An <entry> element in a row
242 Examples:
243P2041RGB
244 or
245LS1021a-IoT
246 or
247qemuarm
248
249_____________________________________________________________________________
250ELTF_T_ARC_DESC Target specific: "Architecture and Description"
251 It can be a short identification string or
252 it can be a longer descriptive sentence.
253 In book: An <entry> element in a row
254 Examples:
255Power, e500mc
256 or
257ARM Cortex-A7
258
259_____________________________________________________________________________
260ELTF_T_DS_TXTURL Target specific: "Link to target datasheet. These
261ELTF_T_DS_URL two usually are IDENTICAL strings with correct
262 hyperlink to the target's official datasheet.
263 In book: an <ulink url="...">...</ulink>
264 Only if the link is VERY LONG, the text part shall
265 instead be a descriptive string (see 2:nd example).
266 NOTE: Also here no spaces or line-feeds!
267 Examples:
268url="http://wiki.qemu.org">http://wiki.qemu.org
269or
270url="http://www.nxp.com/products/microcontrollers-and-processors/arm-processors/qoriq-arm-processors/qoriq-ls1021a-iot-gateway-reference-design:LS1021A-IoT">link to NXP's datasheet
271
272_____________________________________________________________________________
273ELTF_T_POKY_VER Target specific: "Poky version" created either
274 from POKYVERSION in poky.ent
275 or using a hashvalue with a leading string, in
276 which case it may be different per target.
277 In book: An <entry> in a row
278 Examples:
27915.0.0
280or
281Git commit id: 75ca53211488a3e268037a44ee2a7ac5c7181bd2
282
283_____________________________________________________________________________
284ELTF_T_GCC_VER Target specific: "GCC Version". Should be in poky
285 but not easy to find among various parameters.
286 ELTF would extract it from build logs building SDK
287 and it is possibly different per target.
288 In book: An <entry> in a row
289 Example:
2905.3
291
292_____________________________________________________________________________
293ELTF_T_KERN_VER Target specific: "Linux Kernel Version". Often
294 different per target.
295 In book: An <entry> in a row
296 Example:
2973.12
298
299_____________________________________________________________________________
300ELTF_T_DRIVERS Target specific: "Supported Drivers". This is a
301 comma-separated list of driver names.
302 ELTF should create the list in same order for each
303 target, e.g. alphabetic migth be OK.
304 In book: An <entry> in a row
305 Example:
306Ethernet, I2C, SPI, PCI, USB, SD/SDHC/SDXC
307
308
309_____________________________________________________________________________
310ELTF_T_EL_RPM_TXTURL Target specific: "Enea rpm folder for downloading
311ELTF_T_EL_RPM_URL RPM packages for this target". These two are
312 INDENTICAL strings with hyperlink to the web site
313 at Enea where the customer can download RPMs
314 Note: Often the ELFT_EL_REL_VER value and
315 the ELTF_T_MANIFEST_DIR are used in the link.
316 In book: an <ulink url="...">...</ulink>
317 Example:
318url="https://linux.enea.com/6/ls1021aiot/rpm">https://linux.enea.com/6/ls1021aiot/rpm
319
320_____________________________________________________________________________
diff --git a/doc/book-enea-nfv-access-guide/doc/getting_started.xml b/doc/book-enea-nfv-access-guide/doc/getting_started.xml
index fff4bd3..6c20d5e 100644
--- a/doc/book-enea-nfv-access-guide/doc/getting_started.xml
+++ b/doc/book-enea-nfv-access-guide/doc/getting_started.xml
@@ -90,37 +90,6 @@
90 /* GRUB EFI file */</programlisting> 90 /* GRUB EFI file */</programlisting>
91 </section> 91 </section>
92 92
93 <section id="docs">
94 <title>Included Documention</title>
95
96 <para>Enea NFV Access is provided with the following set of
97 documents:</para>
98
99 <itemizedlist>
100 <listitem>
101 <para>Enea NFV Access Guide &ndash; A document describing the Enea NFV
102 Access release content and how to use it, as well as benchmark
103 results.</para>
104 </listitem>
105
106 <listitem>
107 <para>Enea NFV Access Open Source Report &ndash; A document containing
108 the open source and license information pertaining to packages
109 provided with Enea NFV Access 1.0.</para>
110 </listitem>
111
112 <listitem>
113 <para>Enea NFV Access Test Report &ndash; The document that summarizes
114 the test results for the Enea NFV Access release.</para>
115 </listitem>
116
117 <listitem>
118 <para>Enea NFV Access Security Report &ndash; The document that lists
119 all security fixes included in the Enea NFV Access 1.0 release.</para>
120 </listitem>
121 </itemizedlist>
122 </section>
123
124 <section id="prebuilt-artifacts"> 93 <section id="prebuilt-artifacts">
125 <title>How to use the Prebuilt Artifacts</title> 94 <title>How to use the Prebuilt Artifacts</title>
126 95
@@ -171,9 +140,9 @@ label el_ramfs
171 140
172 <para>Restart the target. Then enter (F11) in the Boot Menu and select 141 <para>Restart the target. Then enter (F11) in the Boot Menu and select
173 the Ethernet interface used for PXE boot. From the PXE Boot Menu select 142 the Ethernet interface used for PXE boot. From the PXE Boot Menu select
174 <emphasis role="bold">Enea NFV Access_RAMfs</emphasis>. Once the Enea NFV 143 <emphasis role="bold">Enea NFV Access_RAMfs</emphasis>. Once the Enea
175 Access is started you can partition the HDD/SDD and install 144 NFV Access is started you can partition the HDD/SDD and install GRUB as
176 GRUB as described in in the following section.</para> 145 described in in the following section.</para>
177 </section> 146 </section>
178 147
179 <section id="install-grub"> 148 <section id="install-grub">
@@ -289,12 +258,10 @@ menuentry "Linux sda7" {
289 </section> 258 </section>
290 259
291 <section id="boot-hdd"> 260 <section id="boot-hdd">
292 <title>Installing and booting Enea NFV Access on the 261 <title>Installing and booting Enea NFV Access on the harddisk</title>
293 harddisk</title>
294 262
295 <para>After partitioning the harddisk, boot Enea NFV Access 263 <para>After partitioning the harddisk, boot Enea NFV Access from RAMFS
296 from RAMFS or from a reference image installed on one of the 264 or from a reference image installed on one of the partitions.</para>
297 partitions.</para>
298 265
299 <para>To install Enea NFV Access image on a partition follow these 266 <para>To install Enea NFV Access image on a partition follow these
300 steps:</para> 267 steps:</para>
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
index 203637c..a470845 100644
--- a/doc/book-enea-nfv-access-release-info/doc/about_release.xml
+++ b/doc/book-enea-nfv-access-release-info/doc/about_release.xml
@@ -4,8 +4,8 @@
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 NFV Access <xi:include href="eltf_params_updated.xml" 7 <para>This release of Enea NFV Access <xi:include
8 xmlns:xi="http://www.w3.org/2001/XInclude" 8 href="eltf_params_updated.xml" xmlns:xi="http://www.w3.org/2001/XInclude"
9 xpointer="element(EneaLinux_REL_VER/1)" /> provides a publicly available 9 xpointer="element(EneaLinux_REL_VER/1)" /> provides a publicly available
10 Enea NFV Access distribution for a selected set of targets. This release is 10 Enea NFV Access distribution for a selected set of targets. This release is
11 generated from the yocto <xi:include href="eltf_params_updated.xml" 11 generated from the yocto <xi:include href="eltf_params_updated.xml"
@@ -22,146 +22,101 @@
22 for important details about formats and how to do! The idea is that ELTF 22 for important details about formats and how to do! The idea is that ELTF
23 will auto-create/update it.</remark></para> 23 will auto-create/update it.</remark></para>
24 24
25 <section id="relinfo-provided-contents"> 25 <section id="release-content">
26 <title>Provided Contents</title> 26 <title>NFV Access Release content</title>
27 27
28 <informaltable> 28 <para>The NFV Access 1.0 Release contains along with other items,
29 <tgroup cols="1"> 29 documentation, pre-built kernels and images, a bootloader and a
30 <thead> 30 SDK.</para>
31 <row> 31
32 <entry>Item</entry> 32 <para>The directories structure is detailed below:</para>
33 </row> 33
34 </thead> 34 <programlisting>-- documentation/
35 35 /* NFV Access documentation */
36 <tbody> 36-- inteld1521/
37 <row> 37 /* artifacts for the host side */
38 <entry><para>Source code, recipes and scripts for building the 38 -- deb/
39 distribution and SDKs. See <xref 39 /* deb packages */
40 linkend="relinfo-getting-enea-linux" />.</para></entry> 40 -- images/
41 </row> 41 -- enea-image-virtualization-host
42 42 /* precompiled artifacts for the Host release image */
43 <row> 43 -- various artifacts
44 <entry><para>Documentation. See <xref 44 -- enea-image-virtualization-host-sdk
45 linkend="relinfo-documentation" />.</para></entry> 45 /* precompiled artifacts for the Host SDK image.
46 </row> 46 The SDK image contains userspace tools and kernel
47 47 configurations necessary for developing, debugging
48 <row> 48 and profiling applications and kernel modules */
49 <entry>Pre-built binaries (kernel image, dtb &amp; rootfs)</entry> 49 -- various artifacts
50 </row> 50 -- sdk
51 51 /* NFV Access SDK for the host */
52 <row> 52 -- enea-glibc-x86_64-enea-image-virtualization-host-sdk /
53 <entry>Pre-built packages (RPM). See links for each 53 -corei7-64-toolchain-7.0.sh
54 target.<remark>INFO Below is an Eclipse row from 54 /* self-extracting archive installing
55 eltf_params_updated.xml. MANUALLY if eclipse is not included, set 55 cross-compilation toolchain for the host */
56 condition hidden on the row element BOTH in template.xml and in 56-- qemux86-64
57 updated.xml.</remark></entry> 57 /* artifacts for the guest side */
58 </row> 58 -- deb/
59 59 /* deb packages */
60 <xi:include href="eltf_params_updated.xml" 60 -- images/
61 xmlns:xi="http://www.w3.org/2001/XInclude" 61 -- enea-image-virtualization-guest
62 xpointer="element(eltf-eclipse-version-row)" /> 62 /* precompiled artifacts for the Guest image */
63 </tbody> 63 -- various artifacts
64 </tgroup> 64 -- sdk
65 </informaltable> 65 /* NFV Access SDK for the guest */
66 </section> 66 -- enea-glibc-x86_64-enea-image-virtualization-guest-sdk /
67 67 -core2-64-toolchain-7.0.sh
68 <section id="relinfo-supported-targets"> 68 /* self-extracting archive installing cross-compilation
69 <title>Supported Targets</title> 69 toolchain for the guest (QEMU x86-64) */
70 70</programlisting>
71 <informaltable> 71
72 <tgroup cols="3"> 72 <para>For each combination of image and target, the following set of
73 <colspec align="left" colname="c1" colwidth="1*" /> 73 artifacts is available:</para>
74 74
75 <colspec align="left" colname="c2" colwidth="1*" /> 75 <programlisting>-- bzImage
76 76 /* kernel image */
77 <colspec align="left" colname="c3" colwidth="1*" /> 77-- bzImage-&lt;target&gt;.bin
78 78 /* kernel image, same as above */
79 <thead valign="bottom"> 79-- config-&lt;target&gt;.config
80 <row> 80 /* kernel configuration file */
81 <entry>Target</entry> 81-- core-image-minimal-initramfs-&lt;target&gt;.cpio.gz
82 82 /* cpio archive of the initramfs */
83 <entry>Architecture</entry> 83-- core-image-minimal-initramfs-&lt;target&gt;.qemuboot.conf
84 84 /* qemu config file for the initramfs image */
85 <entry>Specification</entry> 85-- &lt;image-name&gt;-&lt;target&gt;.ext4
86 </row> 86 /* EXT4 image of the rootfs */
87 </thead> 87-- &lt;image-name&gt;-&lt;target&gt;.hddimg
88 88 /* msdos filesystem containing syslinux, kernel, initrd and rootfs image */
89 <tbody> 89-- &lt;image-name&gt;-&lt;target&gt;.iso
90 <row> 90 /* CD .iso image */
91 <entry>P2041RDB</entry> 91-- &lt;image-name&gt;-&lt;target&gt;.qemuboot.conf
92 92 /* qemu config file for the image */
93 <entry><para>Power, e500mc</para></entry> 93-- &lt;image-name&gt;-&lt;target&gt;.tar.gz
94 94 /* tar archive of the image */
95 <entry>See <ulink 95-- &lt;image-name&gt;-&lt;target&gt;.wic
96 url="http://www.nxp.com/products/microcontrollers-and-processors/power-architecture-processors/qoriq-power-architecture-processors/p2041-qoriq-reference-design-board:RDP2041BOARD">link 96 /* Wic image */
97 to NXP's datasheet</ulink></entry> 97-- microcode.cpio
98 </row> 98 /* kernel microcode data */
99 </tbody> 99-- modules-&lt;target&gt;.tgz
100 </tgroup> 100 /* external kernel modules */
101 </informaltable> 101-- ovmf.*.qcow2
102 102 /* ovmf firmware for uefi support in qemu */
103 <para><remark>FIXME should autocreate a list of targets, hopefully from 103-- rmc.db
104 the generated README file, by using MAKEFILE to update pardoc-distro 104 /* Central RMC Database */
105 AND/OR also auto-create an XML file to include here with description text 105-- systemd-bootx64.efi
106 for each target etc..</remark></para> 106 /* systemd-boot EFI file */
107-- grub-efi-bootx64.efi
108 /* GRUB EFI file */</programlisting>
107 </section> 109 </section>
108 110
109 <section id="relinfo-supported-host-environment"> 111 <xi:include href="../../s_doceneacommon/doc/supported_host_environment.xml"
110 <title>Supported Host Environment</title> 112 xmlns:xi="http://www.w3.org/2001/XInclude" />
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 113
126 <xi:include href="eltf_params_updated.xml" 114 <xi:include href="eltf_params_updated.xml"
127 xmlns:xi="http://www.w3.org/2001/XInclude" 115 xmlns:xi="http://www.w3.org/2001/XInclude"
128 xpointer="element(eltf-target-tables-section)" /> 116 xpointer="element(eltf-target-tables-section)" />
129 117
130 <section id="relinfo-packages"> 118 <section condition="hidden" id="relinfo-provided-sdk">
131 <title>Provided Packages</title> 119 <title>Provided Toolchain(s) (SDK)</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 NFV Access</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> NFV Access 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 120
166 <para>The SDK contains toolchains supporting cross-compilation of 121 <para>The SDK contains toolchains supporting cross-compilation of
167 applications for the targets on an x86_64 host. See the <olink 122 applications for the targets on an x86_64 host. See the <olink
@@ -175,120 +130,42 @@
175 <section id="relinfo-documentation"> 130 <section id="relinfo-documentation">
176 <title>Provided Documentation</title> 131 <title>Provided Documentation</title>
177 132
178 <para>The following Enea NFV Access manuals are available:</para> 133 <para>Enea NFV Access is provided with the following set of
134 documents:</para>
179 135
180 <itemizedlist spacing="compact"> 136 <itemizedlist spacing="compact">
181 <listitem> 137 <listitem>
182 <para><trademark class="registered">Enea</trademark> NFV Access Release 138 <para><olink targetdoc="book_enea_nfv_access_guide"
183 Information (this document)</para> 139 targetptr="book_enea_nfv_access_guide">Enea NFV Access Guide</olink>
184 </listitem> 140 &ndash; A document describing how to use ENFV Access, as well as use
185 141 cases and benchmark results.</para>
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> NFV Access 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> NFV Access Application Development
197 Guide</olink></para>
198 </listitem> 142 </listitem>
199 143
200 <listitem> 144 <listitem>
201 <para><trademark class="registered">Enea</trademark> NFV Access Networking 145 <para>Enea NFV Access Release Information &ndash; This document,
202 Profile Guide</para> 146 describing the Enea NFV Access release content</para>
203 </listitem> 147 </listitem>
204 148
205 <listitem> 149 <listitem>
206 <para><olink targetdoc="book_enea_linux_open_source" 150 <para><olink targetdoc="book_enea_nfv_access_open_source"
207 targetptr="book_enea_linux_open_source"><trademark 151 targetptr="book_enea_nfv_access_open_source">Enea NFV Access Open
208 class="registered">Enea</trademark> NFV Access Open Source 152 Source Report</olink> &ndash; A document containing the open source
209 Report</olink></para> 153 and license information pertaining to packages provided with Enea NFV
154 Access 1.0.</para>
210 </listitem> 155 </listitem>
211 156
212 <listitem> 157 <listitem>
213 <para><olink targetdoc="book_enea_linux_eclipse_open_source" 158 <para>Enea NFV Access Test Report &ndash; The document that summarizes
214 targetptr="book_enea_linux_eclipse_open_source"><trademark 159 the test results for the Enea NFV Access release.</para>
215 class="registered">Enea</trademark> NFV Access Eclipse Open Source
216 Report</olink></para>
217 </listitem> 160 </listitem>
218 161
219 <listitem> 162 <listitem>
220 <para><trademark class="registered">Enea</trademark> NFV Access Test 163 <para>Enea NFV Access Security Report &ndash; The document that lists
221 Report</para> 164 all security fixes included in the Enea NFV Access 1.0 release.</para>
222 </listitem>
223
224 <listitem>
225 <para><trademark class="registered">Enea</trademark> NFV Access Real-Time
226 Guide can be read at <ulink
227 url="http://linuxrealtime.org">http://linuxrealtime.org</ulink>.</para>
228 </listitem> 165 </listitem>
229 </itemizedlist> 166 </itemizedlist>
230 </section> 167 </section>
231 168
232 <section condition="hidden" id="relinfo-provided-other"> 169 <xi:include href="../../s_doceneacommon/doc/security_fixes.xml"
233 <title>Other Provided Functionality</title> 170 xmlns:xi="http://www.w3.org/2001/XInclude" />
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 NFV Access</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 NFV Access 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 171</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
index 9c96184..ea37252 100644
--- a/doc/book-enea-nfv-access-release-info/doc/book.xml
+++ b/doc/book-enea-nfv-access-release-info/doc/book.xml
@@ -1,18 +1,35 @@
1<?xml version="1.0" encoding="ISO-8859-1"?> 1<?xml version="1.0" encoding="ISO-8859-1"?>
2<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" 2<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
3"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ 3"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
4]>
5<book id="book_enea_nfv_access_release_info"> 4<book id="book_enea_nfv_access_release_info">
6 <title><trademark class="registered">Enea</trademark> NFV Access Release Information</title> 5 <title><trademark class="registered">Enea</trademark> NFV Access Release
7 <subtitle>Release Version 6 Information</title>
8 <xi:include href="eltf_params_updated.xml" xpointer="element(EneaLinux_REL_VER/1)" 7
9 xmlns:xi="http://www.w3.org/2001/XInclude" /></subtitle> 8 <subtitle>Release Version <xi:include href="eltf_params_updated.xml"
10 <xi:include href="../../s_docbuild/template/docsrc_common/bookinfo_userdoc.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> 9 xmlns:xi="http://www.w3.org/2001/XInclude"
11 <xi:include href="about_release.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> 10 xpointer="element(EneaLinux_REL_VER/1)" /></subtitle>
12 <xi:include href="prerequisites.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> 11
13 <xi:include href="getting_enea_nfv_access.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> 12 <xi:include href="../../s_docbuild/template/docsrc_common/bookinfo_userdoc.xml"
14 <xi:include href="build_boot_generated.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> 13 xmlns:xi="http://www.w3.org/2001/XInclude" />
15 <xi:include href="main_changes.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> 14
16 <xi:include href="known_bugs_and_limitations.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> 15 <xi:include href="about_release.xml"
17 <xi:include href="../../s_docbuild/template/docsrc_common/contacting_enea_enea_linux.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> 16 xmlns:xi="http://www.w3.org/2001/XInclude" />
18</book> 17
18 <xi:include href="system_requirements_prerequisites.xml"
19 xmlns:xi="http://www.w3.org/2001/XInclude" />
20
21 <xi:include href="getting_enea_nfv_access.xml"
22 xmlns:xi="http://www.w3.org/2001/XInclude" />
23
24 <xi:include href="build_boot_generated.xml"
25 xmlns:xi="http://www.w3.org/2001/XInclude" />
26
27 <xi:include href="main_changes.xml"
28 xmlns:xi="http://www.w3.org/2001/XInclude" />
29
30 <xi:include href="known_bugs_and_limitations.xml"
31 xmlns:xi="http://www.w3.org/2001/XInclude" />
32
33 <xi:include href="../../s_docbuild/template/docsrc_common/contacting_enea_enea_linux.xml"
34 xmlns:xi="http://www.w3.org/2001/XInclude" />
35</book> \ 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
index 627e923..f6bd068 100644
--- 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
@@ -89,10 +89,10 @@ repo sync</programlisting></para>
89 </section> 89 </section>
90 90
91 <section id="eltf-target-tables-section"> 91 <section id="eltf-target-tables-section">
92 <title>Supported Targets with Parameters</title> 92 <title>Supported Reference Boards with Parameters</title>
93 93
94 <para>The tables below describes the target(s) supported in this Enea 94 <para>The tables below describes the target(s) supported in this Enea NFV
95 NFV Access release.</para> 95 Access release.</para>
96 96
97 <section id="eltf-target-table-p2041rdb"> 97 <section id="eltf-target-table-p2041rdb">
98 <title>MACHINE p2041rdb - Information</title> 98 <title>MACHINE p2041rdb - Information</title>
diff --git a/doc/book-enea-nfv-access-release-info/doc/getting_enea_nfv_access.xml b/doc/book-enea-nfv-access-release-info/doc/getting_enea_nfv_access.xml
index 9436fab..664766d 100644
--- a/doc/book-enea-nfv-access-release-info/doc/getting_enea_nfv_access.xml
+++ b/doc/book-enea-nfv-access-release-info/doc/getting_enea_nfv_access.xml
@@ -4,16 +4,17 @@
4<chapter id="relinfo-getting-enea-nfv-access"> 4<chapter id="relinfo-getting-enea-nfv-access">
5 <title>Getting Enea NFV Access</title> 5 <title>Getting Enea NFV Access</title>
6 6
7 <para>Enea NFV Access is available as both pre-built binary images and source 7 <para>Enea NFV Access is available as both pre-built binary images and
8 code. Both serve a specific purpose and each have their advantages. However, 8 source code. Both serve a specific purpose and each have their advantages.
9 using the pre-built binary images allows for getting up and running faster. 9 However, using the pre-built binary images allows for getting up and running
10 Please refer to the sections below for details on how to get Enea NFV Access as 10 faster. Please refer to the sections below for details on how to get Enea
11 pre-built binary images or source code.</para> 11 NFV Access as pre-built binary images or source code.</para>
12 12
13 <section id="relinfo-getting-pre-built-images"> 13 <section id="relinfo-getting-pre-built-images">
14 <title>Getting Pre-built Binaries</title> 14 <title>Getting Pre-built Binaries</title>
15 15
16 <para>Enea NFV Access pre-built binaries are available for download on <ulink 16 <para>Enea NFV Access pre-built binaries are available for download on
17 <ulink
17 url="https://portal.enea.com/login/?redirect_to=https%3A%2F%2Fportal.enea.com%2F">Enea 18 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 Download Portal</ulink>. Log in using the credentials provided. Using the
19 menu, browse to the <emphasis role="bold">Linux</emphasis> section. You 20 menu, browse to the <emphasis role="bold">Linux</emphasis> section. You
@@ -21,19 +22,19 @@
21 and the <emphasis role="bold">Online Documentation</emphasis> 22 and the <emphasis role="bold">Online Documentation</emphasis>
22 section.</para> 23 section.</para>
23 24
24 <para>The Files section lists each Enea NFV Access distribution, one for each 25 <para>The Files section lists each Enea NFV Access distribution, one for
25 version and profile, as a separate download package. Clicking on the name 26 each version and profile, as a separate download package. Clicking on the
26 of the distribution will open a new page, which presents further details 27 name of the distribution will open a new page, which presents further
27 about the content of the release and a list of downloadable archives, one 28 details about the content of the release and a list of downloadable
28 for each hardware target included in the release. Each archive provides 29 archives, one for each hardware target included in the release. Each
29 the following content:</para> 30 archive provides the following content:</para>
30 31
31 <itemizedlist> 32 <itemizedlist>
32 <listitem> 33 <listitem>
33 <para><emphasis>images</emphasis> directory &ndash; this directory 34 <para><emphasis>images</emphasis> directory &ndash; this directory
34 includes the binary image files needed to boot the target with Enea 35 includes the binary image files needed to boot the target with Enea
35 NFV Access. This includes the kernel, the root file system, device tree, 36 NFV Access. This includes the kernel, the root file system, device
36 etc.</para> 37 tree, etc.</para>
37 </listitem> 38 </listitem>
38 39
39 <listitem> 40 <listitem>
@@ -57,28 +58,28 @@
57 <itemizedlist> 58 <itemizedlist>
58 <listitem> 59 <listitem>
59 <para><emphasis role="bold">Enea NFV Access Developer&rsquo;s 60 <para><emphasis role="bold">Enea NFV Access Developer&rsquo;s
60 Guide</emphasis> -intended for Enea NFV Access developers, who 61 Guide</emphasis> -intended for Enea NFV Access developers, who want to
61 want to configure and build customized NFV Access kernel images for 62 configure and build customized NFV Access kernel images for embedded
62 embedded system targets, using the Yocto configuration and build 63 system targets, using the Yocto configuration and build system.</para>
63 system.</para>
64 </listitem> 64 </listitem>
65 65
66 <listitem> 66 <listitem>
67 <para><emphasis role="bold">Enea NFV Access Application Developer's 67 <para><emphasis role="bold">Enea NFV Access Application Developer's
68 Guide</emphasis> - dedicated to Enea NFV Access application developers, who 68 Guide</emphasis> - dedicated to Enea NFV Access application
69 want to build and run applications.</para> 69 developers, who want to build and run applications.</para>
70 </listitem> 70 </listitem>
71 71
72 <listitem> 72 <listitem>
73 <para><emphasis role="bold">Enea NFV Access Guide</emphasis> 73 <para><emphasis role="bold">Enea NFV Access Guide</emphasis> -
74 - provides further information meant to get the most out of the 74 provides further information meant to get the most out of the
75 virtualization features.</para> 75 virtualization features.</para>
76 </listitem> 76 </listitem>
77 77
78 <listitem> 78 <listitem>
79 <para><emphasis role="bold">Enea NFV Access Open Source Report</emphasis> - 79 <para><emphasis role="bold">Enea NFV Access Open Source
80 contains the open source and license information pertaining to 80 Report</emphasis> - contains the open source and license information
81 packages provided with this release of Enea NFV Access.</para> 81 pertaining to packages provided with this release of Enea NFV
82 Access.</para>
82 </listitem> 83 </listitem>
83 84
84 <listitem> 85 <listitem>
@@ -102,8 +103,8 @@
102 103
103 <para>Enea NFV Access sources are available for cloning from a set of Git 104 <para>Enea NFV Access sources are available for cloning from a set of Git
104 repositories on <ulink url="https://git.enea.com">git.enea.com</ulink>. 105 repositories on <ulink url="https://git.enea.com">git.enea.com</ulink>.
105 Since Enea NFV Access requires multiple repositories, Google Repo tool is used 106 Since Enea NFV Access requires multiple repositories, Google Repo tool is
106 in order to manage configurations and make the cloning step simpler. 107 used 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 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 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 the list of tuples in the manifest file and clone the specified versions
@@ -147,8 +148,8 @@ id_rsa.pub</programlisting>
147 <section id="getting-source-code-step-two"> 148 <section id="getting-source-code-step-two">
148 <title>Get Sources</title> 149 <title>Get Sources</title>
149 150
150 <para>To use the Repo tool to download the sources for Enea NFV Access, do 151 <para>To use the Repo tool to download the sources for Enea NFV Access,
151 the following:</para> 152 do the following:</para>
152 153
153 <orderedlist> 154 <orderedlist>
154 <listitem condition="hidden"> 155 <listitem condition="hidden">
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
index 44c76e1..e3f068a 100644
--- 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
@@ -6,221 +6,16 @@
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 NFV Access regardless of when 9 upstream, and the corrections are included in Enea NFV Access regardless of
10 they will be included by the open source project. Remaining issues are 10 when they will be included by the open source project. Remaining issues are
11 listed below.<remark>INFO: The <emphasis role="bold">Release-Specific 11 listed below.<remark>INFO: The <emphasis role="bold">Release-Specific
12 Problems</emphasis> section further down is generated from JIRA with 12 Problems</emphasis> section further down is generated from JIRA with
13 gen_known_issues.py, but that script is HARDCODED with affectedversion "Enea 13 gen_known_issues.py, but that script is HARDCODED with affectedversion "Enea
14 NFV Access 1.0" and needs to be adapted when a release info for another ENFV Access version 14 NFV Access 1.0" and needs to be adapted when a release info for another ENFV
15 changes.</remark></para> 15 Access version changes.</remark></para>
16 16
17 <section id="bugs-limitations-yocto"> 17 <section id="release-specific-limitations">
18 <title>Yocto</title> 18 <title>Release-Specific Limitations</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 &lt;packagename&gt;.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 &lt;build_dir&gt;/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 &gt;= 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 &gt;= 2.22 is needed by qemu-2.1.0+git0+541bbb07eb-r0.0.aarch64
98 libglib-2.0-0 &gt;= 2.40.0 is needed by qemu-2.1.0+git0+541bbb07eb-r0.0.aarch64
99 bluez4 &gt;= 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 19
225 <itemizedlist spacing="compact"> 20 <itemizedlist spacing="compact">
226 <listitem> 21 <listitem>
@@ -234,28 +29,7 @@
234 </listitem> 29 </listitem>
235 30
236 <listitem> 31 <listitem>
237 <para><emphasis role="bold">Internet Explorer (IE) cannot display some 32 <para></para>
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> 33 </listitem>
260 </itemizedlist> 34 </itemizedlist>
261 </section> 35 </section>
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
index 18bb93f..ebe69c6 100644
--- a/doc/book-enea-nfv-access-release-info/doc/main_changes.xml
+++ b/doc/book-enea-nfv-access-release-info/doc/main_changes.xml
@@ -6,18 +6,18 @@
6 6
7 <para>N/A.</para> 7 <para>N/A.</para>
8 8
9 <para>This is the first release of Enea NFV Access, Networking profile.</para> 9 <para>This is the first release of Enea NFV Access, Networking
10 profile.</para>
10 11
11 <section condition="hidden" id="relinfo-changes-other"> 12 <section condition="hidden" id="relinfo-changes-other">
12 <title>New Functionality/Enhancements</title> 13 <title>New Features</title>
13 14
14 <remark>Based in the Jira query: 'project = CPDX and fixVersion = "Enea 15 <remark>Based in the Jira query: 'project = CPDX and fixVersion = "Enea
15 NFV Access 1.0"'</remark> 16 NFV Access 1.0"'</remark>
16 17
17 <itemizedlist spacing="compact"> 18 <itemizedlist spacing="compact">
18 <listitem> 19 <listitem>
19 <para>New Yocto version (<xi:include 20 <para>New Yocto version (<xi:include href="eltf_params_updated.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>
@@ -34,20 +34,20 @@
34 on repos and the manifest.</para> 34 on repos and the manifest.</para>
35 </section> 35 </section>
36 36
37 <section condition="hidden" id="relinfo-fixed"> 37 <section id="packages">
38 <title>Problems Fixed in this Release</title> 38 <title>Provided Packages</title>
39 39
40 <para>TBD <remark>FIXME or set condition hidden</remark></para> 40 <para></para>
41 </section> 41 </section>
42 42
43 <section condition="hidden" id="relinfo-added-drivers"> 43 <section id="relinfo-backward-compat">
44 <title>Added Drivers</title> 44 <title>Compatibility</title>
45 45
46 <para>TBD <remark>FIXME or set condition hidden</remark></para> 46 <para></para>
47 </section> 47 </section>
48 48
49 <!-- 49 <!--
50 <xi:include href="pkgdiff_generated.xml" 50 <xi:include href="pkgdiff_generated.xml"
51 xmlns:xi="http://www.w3.org/2001/XInclude" /> 51 xmlns:xi="http://www.w3.org/2001/XInclude" />
52 --> 52 -->
53</chapter> 53</chapter> \ No newline at end of file
diff --git a/doc/book-enea-nfv-access-release-info/doc/prerequisites.xml b/doc/book-enea-nfv-access-release-info/doc/system_requirements_prerequisites.xml
index 7ae2eb6..f598693 100644
--- a/doc/book-enea-nfv-access-release-info/doc/prerequisites.xml
+++ b/doc/book-enea-nfv-access-release-info/doc/system_requirements_prerequisites.xml
@@ -1,10 +1,10 @@
1<?xml version="1.0" encoding="ISO-8859-1"?> 1<?xml version="1.0" encoding="ISO-8859-1"?>
2<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" 2<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
3"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> 3"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
4<chapter id="prerequisites"> 4<chapter id="sys-req-prerequisites">
5 <title>Prerequisites</title> 5 <title>System Requirements and Prerequisites</title>
6 6
7 <para>Building Enea NFV Access or compiling applications requires that your git 7 <para>Using Enea NFV Access or compiling applications requires that your git
8 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
9 your NFV Access development host.</para> 9 your NFV Access development host.</para>
10 10
diff --git a/doc/init.mk b/doc/init.mk
index 7dc5efd..0950c27 100644
--- a/doc/init.mk
+++ b/doc/init.mk
@@ -91,7 +91,7 @@ $(TMPCLONEROOT)/$(NAME_DOCENEACOMMON):
91 else \ 91 else \
92 echo "Cloning $(REPO_DOCENEACOMMON) in $(TMPCLONEROOT) as $(NAME_DOCENEACOMMON)" ; \ 92 echo "Cloning $(REPO_DOCENEACOMMON) in $(TMPCLONEROOT) as $(NAME_DOCENEACOMMON)" ; \
93 cd "$(TMPCLONEROOT)"; \ 93 cd "$(TMPCLONEROOT)"; \
94 git clone -b $(BRANCH_DOCENEACOMMON) git@git.enea.se:$(REPO_DOCENEACOMMON) $(NAME_DOCENEACOMMON) ; \ 94 git clone -b $(BRANCH_DOCENEACOMMON) git@git.enea.com:$(REPO_DOCENEACOMMON) $(NAME_DOCENEACOMMON) ; \
95 fi 95 fi
96 96
97cleaninit: 97cleaninit:
generated by cgit v1.2.3-54-g00ecf (git 2.39.0) at 2025-05-16 09:53:09 +0000