summaryrefslogtreecommitdiffstats
path: root/doc/book-enea-nfv-access-release-info
diff options
context:
space:
mode:
authorMiruna Paun <Miruna.Paun@enea.com>2018-06-25 18:37:06 +0200
committerMiruna Paun <Miruna.Paun@enea.com>2018-06-25 18:37:06 +0200
commitfaf8a658ac97857e35cec7440a83c05a56247757 (patch)
tree1c343935a2cd1a3e198d42852f03f6ad75199e41 /doc/book-enea-nfv-access-release-info
parentcd6c360d563bdbf8ea92c6fcebaf2698a4a2eb4f (diff)
downloadel_releases-nfv-access-faf8a658ac97857e35cec7440a83c05a56247757.tar.gz
Updated Provided Docs section and removed the "intel" condition from the rel notes.
USERDOCAP-336 Signed-off-by: Miruna Paun <Miruna.Paun@enea.com>
Diffstat (limited to 'doc/book-enea-nfv-access-release-info')
-rw-r--r--doc/book-enea-nfv-access-release-info/doc/about_release.xml71
-rw-r--r--doc/book-enea-nfv-access-release-info/doc/eltf_params_updated.xml10
-rw-r--r--doc/book-enea-nfv-access-release-info/doc/main_changes.xml20
3 files changed, 59 insertions, 42 deletions
diff --git a/doc/book-enea-nfv-access-release-info/doc/about_release.xml b/doc/book-enea-nfv-access-release-info/doc/about_release.xml
index f056135..cb2e211 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
@@ -8,25 +8,28 @@
8 href="eltf_params_updated.xml" 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)" /> includes optimizations to the 9 xpointer="element(EneaLinux_REL_VER/1)" /> includes optimizations to the
10 FCAPS framework, DPDK, cross-developement on both an SDK and an eSDK, 10 FCAPS framework, DPDK, cross-developement on both an SDK and an eSDK,
11 USB-stick based installation, and various other optimizations, 11 USB-stick based installation, and various other optimizations, security
12 security patches and documentation updated accordingly.</para> 12 patches and documentation updated accordingly.</para>
13 13
14 <para><remark> INFO <emphasis role="bold">eltf_params_updated.xml</emphasis> 14 <para>
15 contains many parameters in the book, also in the open source books, and 15 <remark>INFO <emphasis role="bold">eltf_params_updated.xml</emphasis>
16 MUST be created FROM <emphasis 16 contains many parameters in the book, also in the open source books, and
17 role="bold">eltf_params_template.xml</emphasis>. The parameters are 17 MUST be created FROM <emphasis
18 automatically used in the books, via xi:include statements, similar to how 18 role="bold">eltf_params_template.xml</emphasis>. The parameters are
19 parameters from pardoc-distro.xml are included in the book. Read the file 19 automatically used in the books, via xi:include statements, similar to how
20 <emphasis role="bold">eltf_params_updated_template_how_to_use.txt</emphasis> 20 parameters from pardoc-distro.xml are included in the book. Read the file
21 for important details about formats and how to do! The idea is that ELTF 21 <emphasis
22 will auto-create/update it.</remark></para> 22 role="bold">eltf_params_updated_template_how_to_use.txt</emphasis> for
23 important details about formats and how to do! The idea is that ELTF will
24 auto-create/update it.</remark>
25 </para>
23 26
24 <section id="release-content"> 27 <section id="release-content">
25 <title>Enea NFV Access Release Content</title> 28 <title>Enea NFV Access Release Content</title>
26 29
27 <para>The release directory structure is detailed below:</para> 30 <para>The release directory structure is detailed below:</para>
28 31
29 <programlisting condition="intel">-- Documentation/ 32 <programlisting>-- Documentation/
30 /* Enea NFV Access documentation */ 33 /* Enea NFV Access documentation */
31-- x86-64 /* architecture */ 34-- x86-64 /* architecture */
32 -- xeon-d/ 35 -- xeon-d/
@@ -96,8 +99,8 @@
96 -- docker-pxe-ramboot 99 -- docker-pxe-ramboot
97 /* tools and files used in buidling a boot setup */</programlisting> 100 /* tools and files used in buidling a boot setup */</programlisting>
98 101
99 <para condition="hidden">For each combination of image and target, the following set of 102 <para condition="hidden">For each combination of image and target, the
100 artifacts is available:</para> 103 following set of artifacts is available:</para>
101 104
102 <programlisting condition="hidden">-- bzImage 105 <programlisting condition="hidden">-- bzImage
103 /* kernel image */ 106 /* kernel image */
@@ -134,12 +137,13 @@
134 /* external kernel modules */</programlisting> 137 /* external kernel modules */</programlisting>
135 </section> 138 </section>
136 139
137 <remark>INFO Below is a complete section 140 <remark>INFO Below is a complete section with ID
138 with ID "eltf-target-tables-section" included from 141 "eltf-target-tables-section" included from elft_params_updated.xml. It
139 elft_params_updated.xml. It contains a variable number of target tables 142 contains a variable number of target tables and the section title should be
140 and the section title should be "Supported Targets with Parameters". It 143 "Supported Targets with Parameters". It has have a short sentence about what
141 has have a short sentence about what it is in the beginning. The subtitles 144 it is in the beginning. The subtitles shall have the directory name of the
142 shall have the directory name of the target in the manifest.</remark> 145 target in the manifest.</remark>
146
143 <xi:include href="eltf_params_updated.xml" 147 <xi:include href="eltf_params_updated.xml"
144 xmlns:xi="http://www.w3.org/2001/XInclude" 148 xmlns:xi="http://www.w3.org/2001/XInclude"
145 xpointer="element(eltf-target-tables-section)" /> 149 xpointer="element(eltf-target-tables-section)" />
@@ -163,7 +167,7 @@
163 Access release content.</para> 167 Access release content.</para>
164 </listitem> 168 </listitem>
165 169
166 <listitem condition="intel"> 170 <listitem>
167 <para><xi:include href="../../s_docbuild/olinkdb/pardoc-common.xml" 171 <para><xi:include href="../../s_docbuild/olinkdb/pardoc-common.xml"
168 xmlns:xi="http://www.w3.org/2001/XInclude" 172 xmlns:xi="http://www.w3.org/2001/XInclude"
169 xpointer="element(book_enea_nfv_access_guide_intel/1)" />. Describes 173 xpointer="element(book_enea_nfv_access_guide_intel/1)" />. Describes
@@ -172,9 +176,11 @@
172 </listitem> 176 </listitem>
173 177
174 <listitem condition="arm"> 178 <listitem condition="arm">
175 <para><phrase><olink targetdoc="book_enea_nfv_access_guide">Enea NFV 179 <para><phrase>
176 Access Guide</olink></phrase>. Describes how to use Enea NFV Access, 180 <olink targetdoc="book_enea_nfv_access_guide">Enea NFV Access
177 provides use cases and benchmark results.</para> 181 Guide</olink>
182 </phrase>. Describes how to use Enea NFV Access, provides use cases
183 and benchmark results.</para>
178 </listitem> 184 </listitem>
179 185
180 <listitem> 186 <listitem>
@@ -186,9 +192,17 @@
186 </listitem> 192 </listitem>
187 193
188 <listitem> 194 <listitem>
195 <para>Enea NFV Access eSDK Open Source Report.</para>
196 </listitem>
197
198 <listitem>
199 <para>Enea NFV Access SDK Open Source Report.</para>
200 </listitem>
201
202 <listitem>
189 <para>Enea Element On-Device Management Kick Start Guide. Use this 203 <para>Enea Element On-Device Management Kick Start Guide. Use this
190 guide to learn about the Element ODM software product, and install 204 guide to learn about the Element ODM software product, and install and
191 and use Element ODM on both development and target platforms.</para> 205 use Element ODM on both development and target platforms.</para>
192 </listitem> 206 </listitem>
193 207
194 <listitem> 208 <listitem>
@@ -209,5 +223,4 @@
209 </listitem> 223 </listitem>
210 </itemizedlist> 224 </itemizedlist>
211 </section> 225 </section>
212 226</chapter> \ No newline at end of file
213</chapter>
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 6573b61..74311e5 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
@@ -94,7 +94,7 @@ repo sync</programlisting></para>
94 <para>The table(s) below describes the target(s) supported in this Enea 94 <para>The table(s) below describes the target(s) supported in this Enea
95 NFV Access release.</para> 95 NFV Access release.</para>
96 96
97 <table condition="intel"> 97 <table>
98 <title>MACHINE Information Intel Xeon D</title> 98 <title>MACHINE Information Intel Xeon D</title>
99 99
100 <tgroup cols="2"> 100 <tgroup cols="2">
@@ -157,7 +157,7 @@ repo sync</programlisting></para>
157 </tgroup> 157 </tgroup>
158 </table> 158 </table>
159 159
160 <table condition="intel"> 160 <table>
161 <title>MACHINE Information Intel Atom C3000</title> 161 <title>MACHINE Information Intel Atom C3000</title>
162 162
163 <tgroup cols="2"> 163 <tgroup cols="2">
@@ -251,8 +251,8 @@ repo sync</programlisting></para>
251 <entry align="left">Link to target datasheet</entry> 251 <entry align="left">Link to target datasheet</entry>
252 252
253 <entry><ulink 253 <entry><ulink
254 url="http://www.cavium.com/OCTEON-TX-CN82XX-83XX.html">OCTEON TX™ 254 url="http://www.cavium.com/OCTEON-TX-CN82XX-83XX.html">OCTEON
255 cn8304 datasheet</ulink></entry> 255 TX™ cn8304 datasheet</ulink></entry>
256 </row> 256 </row>
257 257
258 <row> 258 <row>
@@ -283,4 +283,4 @@ repo sync</programlisting></para>
283 </tgroup> 283 </tgroup>
284 </table> 284 </table>
285 </section> 285 </section>
286</section> 286</section> \ No newline at end of file
diff --git a/doc/book-enea-nfv-access-release-info/doc/main_changes.xml b/doc/book-enea-nfv-access-release-info/doc/main_changes.xml
index 8b1d8ee..60f00a3 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
@@ -47,8 +47,9 @@
47 <para>Feature Extensions:</para> 47 <para>Feature Extensions:</para>
48 48
49 <itemizedlist> 49 <itemizedlist>
50 <listitem condition="intel"> 50 <listitem>
51 <para>Integrated Element ODM 4.0.3: FCAPS framework with NETCONF and Yang</para> 51 <para>Integrated Element ODM 4.0.3: FCAPS framework with NETCONF
52 and Yang</para>
52 </listitem> 53 </listitem>
53 54
54 <listitem condition="hidden"> 55 <listitem condition="hidden">
@@ -59,8 +60,8 @@
59 </listitem> 60 </listitem>
60 61
61 <listitem> 62 <listitem>
62 <para>Extensible SDK for cross-development and deployment of applications 63 <para>Extensible SDK for cross-development and deployment of
63 as docker containers</para> 64 applications as docker containers</para>
64 </listitem> 65 </listitem>
65 66
66 <listitem> 67 <listitem>
@@ -99,10 +100,13 @@
99 release.</para> 100 release.</para>
100 </section> 101 </section>
101 102
102 <section id="relinfo-backward-compat" condition="hidden"> 103 <section condition="hidden" id="relinfo-backward-compat">
103 <title>Compatibility</title> 104 <title>Compatibility</title>
104 105
105 <para condition="intel">There are not any know compatibility 106 <para>In the development of any complex software platform, there is a need
106 issues.</para> 107 to strike a balance between backwards compatibility and new development.
108 In most cases, compatibility will be maintained as long as reasonably
109 possible. Necessary compatibility breaks will be done only as needed and
110 in major releases.</para>
107 </section> 111 </section>
108</chapter> 112</chapter> \ No newline at end of file