diff options
| author | Miruna Paun <Miruna.Paun@enea.com> | 2018-05-25 11:27:12 +0200 |
|---|---|---|
| committer | Miruna Paun <Miruna.Paun@enea.com> | 2018-05-25 11:27:12 +0200 |
| commit | b23e40cff8fac1215802541a6514a51473c11ce9 (patch) | |
| tree | 367877f976593240e782ac0c2bfc1a9153803c95 | |
| parent | 4163467d61644938130b3b145dedb1ca7a667212 (diff) | |
| download | nfv-access-documentation-b23e40cff8fac1215802541a6514a51473c11ce9.tar.gz | |
Updated the rel notes with olinks, rephrasing of various paragraphs
USERDOCAP-243 Updated several chapters to include comments made by iosc/dape.
Signed-off-by: Miruna Paun <Miruna.Paun@enea.com>
6 files changed, 203 insertions, 249 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 0f5e5e5..171a5fa 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,12 +4,16 @@ | |||
| 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>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)" /> includes following | 9 | xpointer="element(EneaLinux_REL_VER/1)" /> includes optimizations to the |
| 10 | components:<remark>INFO <emphasis | 10 | FCAPS framework, DPDK, cross-developement on both an SDK and an eSDK, |
| 11 | role="bold">eltf_params_updated.xml</emphasis> contains many parameters in | 11 | USB-stick based installation options, and various other optimizations, |
| 12 | the book, also in the open source books, and MUST be created FROM <emphasis | 12 | security patches and documentation updated accordingly.</para> |
| 13 | |||
| 14 | <para><remark> INFO <emphasis role="bold">eltf_params_updated.xml</emphasis> | ||
| 15 | contains many parameters in the book, also in the open source books, and | ||
| 16 | MUST be created FROM <emphasis | ||
| 13 | role="bold">eltf_params_template.xml</emphasis>. The parameters are | 17 | role="bold">eltf_params_template.xml</emphasis>. The parameters are |
| 14 | automatically used in the books, via xi:include statements, similar to how | 18 | automatically used in the books, via xi:include statements, similar to how |
| 15 | parameters from pardoc-distro.xml are included in the book. Read the file | 19 | parameters from pardoc-distro.xml are included in the book. Read the file |
| @@ -17,84 +21,12 @@ | |||
| 17 | for important details about formats and how to do! The idea is that ELTF | 21 | for important details about formats and how to do! The idea is that ELTF |
| 18 | will auto-create/update it.</remark></para> | 22 | will auto-create/update it.</remark></para> |
| 19 | 23 | ||
| 20 | <itemizedlist> | ||
| 21 | <listitem> | ||
| 22 | <para>DPDK 18.02</para> | ||
| 23 | </listitem> | ||
| 24 | |||
| 25 | <listitem> | ||
| 26 | <para>OVS 2.9</para> | ||
| 27 | </listitem> | ||
| 28 | |||
| 29 | <listitem condition="intel"> | ||
| 30 | <para>Element ODM: FCAPS framework with NETCONF and Yang</para> | ||
| 31 | </listitem> | ||
| 32 | |||
| 33 | <listitem> | ||
| 34 | <para>Edge Link Netconf (beta): NETCONF based VNF lifecycle Management | ||
| 35 | Tool</para> | ||
| 36 | </listitem> | ||
| 37 | |||
| 38 | <listitem> | ||
| 39 | <para>Extended Tools Feature Set:</para> | ||
| 40 | |||
| 41 | <itemizedlist> | ||
| 42 | <listitem> | ||
| 43 | <para>python-pip</para> | ||
| 44 | </listitem> | ||
| 45 | |||
| 46 | <listitem> | ||
| 47 | <para>dosfstools</para> | ||
| 48 | </listitem> | ||
| 49 | |||
| 50 | <listitem> | ||
| 51 | <para>htop</para> | ||
| 52 | </listitem> | ||
| 53 | </itemizedlist> | ||
| 54 | </listitem> | ||
| 55 | |||
| 56 | <listitem> | ||
| 57 | <para>Unified cross-development SDK for host and virtualized | ||
| 58 | environments</para> | ||
| 59 | </listitem> | ||
| 60 | |||
| 61 | <listitem> | ||
| 62 | <para>Native toolchain support on development image</para> | ||
| 63 | </listitem> | ||
| 64 | |||
| 65 | <listitem> | ||
| 66 | <para>USB-stick based installation</para> | ||
| 67 | </listitem> | ||
| 68 | |||
| 69 | <listitem> | ||
| 70 | <para>Product Maintenance:</para> | ||
| 71 | |||
| 72 | <itemizedlist> | ||
| 73 | <listitem> | ||
| 74 | <para>Optimizations</para> | ||
| 75 | </listitem> | ||
| 76 | |||
| 77 | <listitem> | ||
| 78 | <para>Security patches</para> | ||
| 79 | </listitem> | ||
| 80 | |||
| 81 | <listitem> | ||
| 82 | <para>Bug fixes</para> | ||
| 83 | </listitem> | ||
| 84 | |||
| 85 | <listitem> | ||
| 86 | <para>Updated documentation</para> | ||
| 87 | </listitem> | ||
| 88 | </itemizedlist> | ||
| 89 | </listitem> | ||
| 90 | </itemizedlist> | ||
| 91 | |||
| 92 | <section id="release-content"> | 24 | <section id="release-content"> |
| 93 | <title>Enea NFV Access Release Content</title> | 25 | <title>Enea NFV Access Release Content</title> |
| 94 | 26 | ||
| 95 | <para>The current release contains along with other items, documentation, | 27 | <para>The current release contains documentation, prebuilt kernels and |
| 96 | pre-built kernels and images, a bootloader and a SDK. The directory | 28 | images, a bootloader, an SDK and an eSDK. The directory structure is |
| 97 | structure is detailed below:</para> | 29 | detailed below:</para> |
| 98 | 30 | ||
| 99 | <programlisting condition="intel">-- documentation/ | 31 | <programlisting condition="intel">-- documentation/ |
| 100 | /* Enea NFV Access documentation */ | 32 | /* Enea NFV Access documentation */ |
| @@ -185,9 +117,9 @@ | |||
| 185 | <para>For each combination of image and target, the following set of | 117 | <para>For each combination of image and target, the following set of |
| 186 | artifacts is available:</para> | 118 | artifacts is available:</para> |
| 187 | 119 | ||
| 188 | <programlisting condition="arm">-- Image | 120 | <programlisting condition="intel">-- bzImage |
| 189 | /* kernel image */ | 121 | /* kernel image */ |
| 190 | -- Image-target.bin | 122 | -- bzImage-target.bin |
| 191 | /* kernel image, same as above */ | 123 | /* kernel image, same as above */ |
| 192 | -- config-target.config | 124 | -- config-target.config |
| 193 | /* kernel configuration file */ | 125 | /* kernel configuration file */ |
| @@ -200,11 +132,13 @@ | |||
| 200 | -- image-name-target.tar.gz | 132 | -- image-name-target.tar.gz |
| 201 | /* tar archive of the image */ | 133 | /* tar archive of the image */ |
| 202 | -- modules-<target>.tgz | 134 | -- modules-<target>.tgz |
| 203 | /* external kernel modules */</programlisting> | 135 | /* external kernel modules */ |
| 136 | -- grub-efi-bootx64.efi | ||
| 137 | /* GRUB EFI file */</programlisting> | ||
| 204 | 138 | ||
| 205 | <programlisting condition="intel">-- bzImage | 139 | <programlisting condition="arm">-- Image |
| 206 | /* kernel image */ | 140 | /* kernel image */ |
| 207 | -- bzImage-target.bin | 141 | -- Image-target.bin |
| 208 | /* kernel image, same as above */ | 142 | /* kernel image, same as above */ |
| 209 | -- config-target.config | 143 | -- config-target.config |
| 210 | /* kernel configuration file */ | 144 | /* kernel configuration file */ |
| @@ -217,9 +151,7 @@ | |||
| 217 | -- image-name-target.tar.gz | 151 | -- image-name-target.tar.gz |
| 218 | /* tar archive of the image */ | 152 | /* tar archive of the image */ |
| 219 | -- modules-<target>.tgz | 153 | -- modules-<target>.tgz |
| 220 | /* external kernel modules */ | 154 | /* external kernel modules */</programlisting> |
| 221 | -- grub-efi-bootx64.efi | ||
| 222 | /* GRUB EFI file */</programlisting> | ||
| 223 | </section> | 155 | </section> |
| 224 | 156 | ||
| 225 | <section id="relinfo-supported-host-environment"> | 157 | <section id="relinfo-supported-host-environment"> |
| @@ -247,69 +179,74 @@ | |||
| 247 | xpointer="element(eltf-target-tables-section)" /> | 179 | xpointer="element(eltf-target-tables-section)" /> |
| 248 | 180 | ||
| 249 | <section id="relinfo-provided-sdk"> | 181 | <section id="relinfo-provided-sdk"> |
| 250 | <title>Provided Toolchain(s) (SDK)</title> | 182 | <title>Provided Toolchains</title> |
| 251 | 183 | ||
| 252 | <para>The provided SDK contains toolchains supporting cross-compilation of | 184 | <para>The provided SDK and eSDK contain toolchains supporting |
| 253 | applications for both the host and the guest targets on an <filename | 185 | cross-compilation of applications for both the host and the guest targets |
| 254 | condition="arm">arm64</filename><filename | 186 | on an <filename condition="intel">x86-64</filename><filename |
| 255 | condition="intel">x86-64</filename> machine.</para> | 187 | condition="arm">arm64</filename> machine.</para> |
| 256 | |||
| 257 | <para><remark>(Possibly add this in later) See the <trademark | ||
| 258 | class="registered">Enea</trademark> NFV Access Application Development | ||
| 259 | Guide for information on how to build and install a | ||
| 260 | toolchain.</remark></para> | ||
| 261 | </section> | 188 | </section> |
| 262 | 189 | ||
| 263 | <section id="relinfo-documentation"> | 190 | <section id="relinfo-documentation"> |
| 264 | <title>Provided Documentation</title> | 191 | <title>Provided Documentation</title> |
| 265 | 192 | ||
| 266 | <para>Enea NFV Access is provided with the following set of | 193 | <para>This release of Enea NFV Access contains the following set of |
| 267 | documents:</para> | 194 | documents:</para> |
| 268 | 195 | ||
| 269 | <itemizedlist> | 196 | <itemizedlist> |
| 270 | <listitem> | 197 | <listitem> |
| 271 | <para>Enea NFV Access Release Information - This document, describing | 198 | <para>Enea NFV Access Release Information. Describes the Enea NFV |
| 272 | the Enea NFV Access release content.</para> | 199 | Access release content.</para> |
| 273 | </listitem> | 200 | </listitem> |
| 274 | 201 | ||
| 275 | <listitem> | 202 | <listitem condition="intel"> |
| 276 | <para>Enea NFV Access Guide - A document describing how to use Enea | 203 | <para><xi:include href="../../s_docbuild/olinkdb/pardoc-common.xml" |
| 277 | NFV Access, as well as use cases and benchmark results.</para> | 204 | xmlns:xi="http://www.w3.org/2001/XInclude" |
| 205 | xpointer="element(book_enea_nfv_access_guide_intel/1)" />. Describes | ||
| 206 | how to use Enea NFV Access, provides use cases and benchmark | ||
| 207 | results.</para> | ||
| 208 | </listitem> | ||
| 209 | |||
| 210 | <listitem condition="arm"> | ||
| 211 | <para><phrase><olink targetdoc="book_enea_nfv_access_guide">Enea NFV | ||
| 212 | Access Guide</olink></phrase>. Describes how to use Enea NFV Access, | ||
| 213 | provides use cases and benchmark results.</para> | ||
| 278 | </listitem> | 214 | </listitem> |
| 279 | 215 | ||
| 280 | <listitem> | 216 | <listitem> |
| 281 | <para>Enea NFV Access Open Source Report - A document containing the | 217 | <para><xi:include href="../../s_docbuild/olinkdb/pardoc-common.xml" |
| 218 | xmlns:xi="http://www.w3.org/2001/XInclude" | ||
| 219 | xpointer="element(book_enea_nfv_access_open_source/1)" />. Contains | ||
| 282 | open source and license information pertaining to packages provided | 220 | open source and license information pertaining to packages provided |
| 283 | with Enea NFV Access.</para> | 221 | with Enea NFV Access.</para> |
| 284 | </listitem> | 222 | </listitem> |
| 285 | 223 | ||
| 286 | <listitem> | 224 | <listitem> |
| 287 | <para>Enea NFV Access Development Open Source Report - A document | 225 | <para>Enea NFV Access Development Open Source Report. Contains open |
| 288 | containing open source and license information pertaining to packages | 226 | source and license information pertaining to packages provided with |
| 289 | provided with Enea NFV Access for application developers.</para> | 227 | Enea NFV Access for application developers.</para> |
| 290 | </listitem> | 228 | </listitem> |
| 291 | 229 | ||
| 292 | <listitem> | 230 | <listitem> |
| 293 | <para>Enea NFV Access Guest Open Source Report - A document containing | 231 | <para>Enea NFV Access Guest Open Source Report. Contains open source |
| 294 | open source and license information concerning packages provided with | 232 | and license information concerning packages provided with Enea NFV |
| 295 | Enea NFV Access for a guest target.</para> | 233 | Access for a guest target.</para> |
| 296 | </listitem> | 234 | </listitem> |
| 297 | 235 | ||
| 298 | <listitem> | 236 | <listitem> |
| 299 | <para>Enea NFV Access Guest Development Open Source Report - A | 237 | <para>Enea NFV Access Guest Development Open Source Report. Details |
| 300 | document detailing the open source and license information of packages | 238 | the open source and license information of packages provided with Enea |
| 301 | provided with Enea NFV Access for applications development on a guest | 239 | NFV Access for applications development on a guest target.</para> |
| 302 | target.</para> | ||
| 303 | </listitem> | 240 | </listitem> |
| 304 | 241 | ||
| 305 | <listitem condition="hidden"> | 242 | <listitem condition="hidden"> |
| 306 | <para>Enea NFV Access Test Report - The document that summarizes the | 243 | <para>Enea NFV Access Test Report. Summarizes the test results for the |
| 307 | test results for the Enea NFV Access release.</para> | 244 | Enea NFV Access release.</para> |
| 308 | </listitem> | 245 | </listitem> |
| 309 | 246 | ||
| 310 | <listitem> | 247 | <listitem> |
| 311 | <para>Enea NFV Access Security Report - The document that lists all | 248 | <para>Enea NFV Access Security Report. Lists all security fixes |
| 312 | security fixes included in the Enea NFV Access release.</para> | 249 | included in this release of Enea NFV Access.</para> |
| 313 | </listitem> | 250 | </listitem> |
| 314 | </itemizedlist> | 251 | </itemizedlist> |
| 315 | </section> | 252 | </section> |
| @@ -320,4 +257,4 @@ | |||
| 320 | <para>A detailed list of all security patches included with this release | 257 | <para>A detailed list of all security patches included with this release |
| 321 | is available in the Enea NFV Access Security Report document.</para> | 258 | is available in the Enea NFV Access Security Report document.</para> |
| 322 | </section> | 259 | </section> |
| 323 | </chapter> | 260 | </chapter> \ 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 40bc8bf..d8ae98e 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 | |||
| @@ -42,7 +42,8 @@ export PATH=~/bin:$PATH</programlisting></para> | |||
| 42 | correct also compared to the "previous" REL VER in pardoc-distro.xml | 42 | correct also compared to the "previous" REL VER in pardoc-distro.xml |
| 43 | "prev_baseline".</bridgehead> | 43 | "prev_baseline".</bridgehead> |
| 44 | 44 | ||
| 45 | <para id="EneaLinux_REL_VER"><phrase>1.1.1</phrase></para> | 45 | <para id="EneaLinux_REL_VER"><phrase condition="intel">2.0</phrase><phrase |
| 46 | condition="arm">1.1.1</phrase></para> | ||
| 46 | 47 | ||
| 47 | <para id="Yocto_VER"><phrase>2.1</phrase></para> | 48 | <para id="Yocto_VER"><phrase>2.1</phrase></para> |
| 48 | 49 | ||
| @@ -94,116 +95,130 @@ repo sync</programlisting></para> | |||
| 94 | <para>The table(s) below describes the target(s) supported in this Enea | 95 | <para>The table(s) below describes the target(s) supported in this Enea |
| 95 | NFV Access release.</para> | 96 | NFV Access release.</para> |
| 96 | 97 | ||
| 97 | <section id="eltf-target-table"> | 98 | <table condition="intel"> |
| 98 | <title>MACHINE Information</title> | 99 | <title>MACHINE Information</title> |
| 99 | 100 | ||
| 100 | <para><informaltable condition="arm"> | 101 | <tgroup cols="2"> |
| 101 | <tgroup cols="2"> | 102 | <colspec align="center" /> |
| 102 | <colspec colwidth="6*" /> | ||
| 103 | 103 | ||
| 104 | <colspec colwidth="9*" /> | 104 | <thead> |
| 105 | <row> | ||
| 106 | <entry align="center">Component</entry> | ||
| 105 | 107 | ||
| 106 | <tbody> | 108 | <entry align="center">Description</entry> |
| 107 | <row> | 109 | </row> |
| 108 | <entry>Target official name</entry> | 110 | </thead> |
| 109 | 111 | ||
| 110 | <entry>OCTEON TX™ cn8304</entry> | 112 | <tbody> |
| 111 | </row> | 113 | <row> |
| 114 | <entry align="left">Target official name</entry> | ||
| 112 | 115 | ||
| 113 | <row> | 116 | <entry>Intel Xeon D-1521</entry> |
| 114 | <entry>Architecture and Description</entry> | 117 | </row> |
| 115 | 118 | ||
| 116 | <entry>arm64</entry> | 119 | <row> |
| 117 | </row> | 120 | <entry align="left">Architecture and Description</entry> |
| 118 | 121 | ||
| 119 | <row> | 122 | <entry>x86-64</entry> |
| 120 | <entry>Link to target datasheet</entry> | 123 | </row> |
| 121 | 124 | ||
| 122 | <entry>See link to <ulink | 125 | <row> |
| 123 | url="http://www.cavium.com/OCTEON-TX-CN82XX-83XX.html">OCTEON | 126 | <entry align="left">Link to target datasheet</entry> |
| 124 | TX™ cn8304 datasheet</ulink></entry> | ||
| 125 | </row> | ||
| 126 | 127 | ||
| 127 | <row> | 128 | <entry><ulink |
| 128 | <entry>Poky version</entry> | 129 | url="https://ark.intel.com/products/91202/Intel-Xeon-Processor-D-1521-6M-Cache-2_40-GHz">Intel's |
| 130 | datasheet</ulink></entry> | ||
| 131 | </row> | ||
| 129 | 132 | ||
| 130 | <entry>Git-commit-id: | 133 | <row> |
| 131 | f01b909a266498853e6b3f10e6b39f2d95148129</entry> | 134 | <entry align="left">Poky version</entry> |
| 132 | </row> | ||
| 133 | 135 | ||
| 134 | <row> | 136 | <entry>Git-commit-id: |
| 135 | <entry>GCC version</entry> | 137 | f01b909a266498853e6b3f10e6b39f2d95148129</entry> |
| 138 | </row> | ||
| 136 | 139 | ||
| 137 | <entry>5.3<remark>FIXME</remark></entry> | 140 | <row> |
| 138 | </row> | 141 | <entry align="left">GCC version</entry> |
| 139 | 142 | ||
| 140 | <row> | 143 | <entry>5.3<remark>FIXME</remark></entry> |
| 141 | <entry>Linux Kernel Version</entry> | 144 | </row> |
| 142 | 145 | ||
| 143 | <entry>3.12<remark>FIXME</remark></entry> | 146 | <row> |
| 144 | </row> | 147 | <entry align="left">Linux Kernel Version</entry> |
| 145 | 148 | ||
| 146 | <row condition="hidden"> | 149 | <entry>3.12<remark>FIXME</remark></entry> |
| 147 | <entry>Supported Drivers</entry> | 150 | </row> |
| 148 | 151 | ||
| 149 | <entry>Ethernet, RTC, UART</entry> | 152 | <row condition="hidden"> |
| 150 | </row> | 153 | <entry align="left">Supported Drivers</entry> |
| 151 | </tbody> | ||
| 152 | </tgroup> | ||
| 153 | </informaltable><informaltable condition="intel"> | ||
| 154 | <tgroup cols="2"> | ||
| 155 | <colspec colwidth="6*" /> | ||
| 156 | 154 | ||
| 157 | <colspec colwidth="9*" /> | 155 | <entry>Ethernet, RTC, UART</entry> |
| 156 | </row> | ||
| 157 | </tbody> | ||
| 158 | </tgroup> | ||
| 159 | </table> | ||
| 158 | 160 | ||
| 159 | <tbody> | 161 | <table condition="arm"> |
| 160 | <row> | 162 | <title>MACHINE Information</title> |
| 161 | <entry>Target official name</entry> | ||
| 162 | 163 | ||
| 163 | <entry>Intel Xeon D-1521</entry> | 164 | <tgroup cols="2"> |
| 164 | </row> | 165 | <colspec align="center" /> |
| 165 | 166 | ||
| 166 | <row> | 167 | <thead> |
| 167 | <entry>Architecture and Description</entry> | 168 | <row> |
| 169 | <entry align="center">Component</entry> | ||
| 168 | 170 | ||
| 169 | <entry>x86-64</entry> | 171 | <entry align="center">Description</entry> |
| 170 | </row> | 172 | </row> |
| 173 | </thead> | ||
| 171 | 174 | ||
| 172 | <row> | 175 | <tbody> |
| 173 | <entry>Link to target datasheet</entry> | 176 | <row> |
| 177 | <entry align="left">Target official name</entry> | ||
| 174 | 178 | ||
| 175 | <entry>See link to <ulink | 179 | <entry>OCTEON TX™ cn8304</entry> |
| 176 | url="https://ark.intel.com/products/91202/Intel-Xeon-Processor-D-1521-6M-Cache-2_40-GHz">Intel's | 180 | </row> |
| 177 | datasheet</ulink></entry> | ||
| 178 | </row> | ||
| 179 | 181 | ||
| 180 | <row> | 182 | <row> |
| 181 | <entry>Poky version</entry> | 183 | <entry align="left">Architecture and Description</entry> |
| 182 | 184 | ||
| 183 | <entry>Git-commit-id: | 185 | <entry>arm64</entry> |
| 184 | f01b909a266498853e6b3f10e6b39f2d95148129</entry> | 186 | </row> |
| 185 | </row> | ||
| 186 | 187 | ||
| 187 | <row> | 188 | <row> |
| 188 | <entry>GCC version</entry> | 189 | <entry align="left">Link to target datasheet</entry> |
| 189 | 190 | ||
| 190 | <entry>5.3<remark>FIXME</remark></entry> | 191 | <entry><ulink |
| 191 | </row> | 192 | url="http://www.cavium.com/OCTEON-TX-CN82XX-83XX.html">OCTEON |
| 193 | TX™ cn8304 datasheet</ulink></entry> | ||
| 194 | </row> | ||
| 192 | 195 | ||
| 193 | <row> | 196 | <row> |
| 194 | <entry>Linux Kernel Version</entry> | 197 | <entry align="left">Poky version</entry> |
| 195 | 198 | ||
| 196 | <entry>3.12<remark>FIXME</remark></entry> | 199 | <entry>Git-commit-id: |
| 197 | </row> | 200 | f01b909a266498853e6b3f10e6b39f2d95148129</entry> |
| 201 | </row> | ||
| 202 | |||
| 203 | <row> | ||
| 204 | <entry align="left">GCC version</entry> | ||
| 205 | |||
| 206 | <entry>5.3<remark>FIXME</remark></entry> | ||
| 207 | </row> | ||
| 198 | 208 | ||
| 199 | <row condition="hidden"> | 209 | <row> |
| 200 | <entry>Supported Drivers</entry> | 210 | <entry align="left">Linux Kernel Version</entry> |
| 201 | 211 | ||
| 202 | <entry>Ethernet, RTC, UART</entry> | 212 | <entry>3.12<remark>FIXME</remark></entry> |
| 203 | </row> | 213 | </row> |
| 204 | </tbody> | 214 | |
| 205 | </tgroup> | 215 | <row condition="hidden"> |
| 206 | </informaltable></para> | 216 | <entry align="left">Supported Drivers</entry> |
| 207 | </section> | 217 | |
| 218 | <entry>Ethernet, RTC, UART</entry> | ||
| 219 | </row> | ||
| 220 | </tbody> | ||
| 221 | </tgroup> | ||
| 222 | </table> | ||
| 208 | </section> | 223 | </section> |
| 209 | </section> \ No newline at end of file | 224 | </section> \ No newline at end of file |
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 2bf9c22..5d8c1ce 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,25 +4,40 @@ | |||
| 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 releases are available as binaries ready for download | 7 | <para>Enea NFV Access releases and updates are available as binaries ready |
| 8 | on the <ulink | 8 | for download from the <ulink |
| 9 | url="https://portal.enea.com/login/?redirect_to=https%3A%2F%2Fportal.enea.com%2F">Enea | 9 | url="https://portal.enea.com/login/?redirect_to=https%3A%2F%2Fportal.enea.com%2F">Enea |
| 10 | Download Portal</ulink>. Updates of Enea NFV Access are also available for | 10 | Download Portal</ulink>.</para> |
| 11 | download through the portal.</para> | 11 | |
| 12 | 12 | <para><emphasis role="bold">Downloading Enea NFV Access</emphasis></para> | |
| 13 | <para>Log in using the credentials provided by Enea. Using the menu at the | 13 | |
| 14 | top, browse to the <literal>NFV</literal> section, which will provide access | 14 | <orderedlist> |
| 15 | to a <literal>Files</literal> section and an <literal>Online | 15 | <listitem> |
| 16 | Documentation</literal> section. The <literal>Files</literal> section lists | 16 | <para>Log in using the credentials provided by Enea.</para> |
| 17 | each Enea NFV Access release version as a separate download package. | 17 | </listitem> |
| 18 | Clicking on any of the release packages will provide further details such as | 18 | |
| 19 | the date when it was made available, the file size and the changelog. Most | 19 | <listitem> |
| 20 | importantly, it provides access to the download links.</para> | 20 | <para>Using the menu at the top, browse to the <literal>NFV</literal> |
| 21 | 21 | section, which will provide access to a <literal>Files</literal> section | |
| 22 | <para>Each archive is mirrored in several places, geographically. Choose the | 22 | and an <literal>Online Documentation</literal> section.</para> |
| 23 | archive in the region closest to you for better download speeds. For details | 23 | </listitem> |
| 24 | about the contents of the release package, please refer to <xref | 24 | |
| 25 | linkend="release-content" />.</para> | 25 | <listitem> |
| 26 | <para>The <literal>Files</literal> section lists each Enea NFV Access | ||
| 27 | release version as a separate download package. Clicking on any of the | ||
| 28 | release packages will provide further details such as the date when it | ||
| 29 | was made available, the file size and the changelog. Most importantly, | ||
| 30 | it provides access to the download links.</para> | ||
| 31 | </listitem> | ||
| 32 | |||
| 33 | <listitem> | ||
| 34 | <para>Choose the archive in the region closest to you for better | ||
| 35 | download speeds and download it.</para> | ||
| 36 | </listitem> | ||
| 37 | </orderedlist> | ||
| 38 | |||
| 39 | <para>For details about the contents of the release package, please refer to | ||
| 40 | <xref linkend="release-content" />.</para> | ||
| 26 | 41 | ||
| 27 | <para>The <literal>Online documentation</literal> section provides quick | 42 | <para>The <literal>Online documentation</literal> section provides quick |
| 28 | access to the documents delivered with the release. For details about the | 43 | access to the documents delivered with the release. For details about the |
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 2d3e576..cccb4df 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 | |||
| @@ -2,7 +2,7 @@ | |||
| 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="bugs-limitations"> | 4 | <chapter id="bugs-limitations"> |
| 5 | <title>Known Problems in This Release</title> | 5 | <title>Known Issues in this Release</title> |
| 6 | 6 | ||
| 7 | <para>All known issues listed in this chapter will be addressed in | 7 | <para>All known issues listed in this chapter will be addressed in |
| 8 | maintenance updates following the major release.<remark>INFO: The <emphasis | 8 | maintenance updates following the major release.<remark>INFO: The <emphasis |
| @@ -14,30 +14,11 @@ | |||
| 14 | <section id="release-specific-limitations"> | 14 | <section id="release-specific-limitations"> |
| 15 | <title>Release-Specific Limitations</title> | 15 | <title>Release-Specific Limitations</title> |
| 16 | 16 | ||
| 17 | <para><emphasis role="bold">Issues concerning the current | ||
| 18 | release</emphasis>:</para> | ||
| 19 | |||
| 20 | <itemizedlist> | 17 | <itemizedlist> |
| 21 | <listitem> | 18 | <listitem> |
| 22 | <para>OFP and ODP are not included with the current release but they | ||
| 23 | will be included in a later maintenance update.<remark>FIXME, | ||
| 24 | requesting help from Ca</remark></para> | ||
| 25 | </listitem> | ||
| 26 | |||
| 27 | <listitem> | ||
| 28 | <para>Kernel modules build using the SDK cannot be removed from the | 19 | <para>Kernel modules build using the SDK cannot be removed from the |
| 29 | <filename>enea-nfv-access</filename> image.</para> | 20 | <filename>enea-nfv-access</filename> image.</para> |
| 30 | </listitem> | 21 | </listitem> |
| 31 | </itemizedlist> | ||
| 32 | |||
| 33 | <para><emphasis role="bold">Issues affecting | ||
| 34 | documentation</emphasis>:</para> | ||
| 35 | |||
| 36 | <itemizedlist> | ||
| 37 | <listitem> | ||
| 38 | <para>Documents provided in this release will continue to be regularly | ||
| 39 | updated with additional content.</para> | ||
| 40 | </listitem> | ||
| 41 | 22 | ||
| 42 | <listitem> | 23 | <listitem> |
| 43 | <para><emphasis role="bold">PDF navigation</emphasis>: When using | 24 | <para><emphasis role="bold">PDF navigation</emphasis>: When using |
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 48e913f..aabe461 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 | |||
| @@ -4,9 +4,10 @@ | |||
| 4 | <chapter id="relinfo-changes"> | 4 | <chapter id="relinfo-changes"> |
| 5 | <title>Main Changes</title> | 5 | <title>Main Changes</title> |
| 6 | 6 | ||
| 7 | <para>This chapter provides information about the new features added in the | 7 | <para>Below you'll find information about the new features and updates made |
| 8 | current release, as well as details on the provided packages and the | 8 | in this release, as well as details on the provided packages and the |
| 9 | backwards compatibility with previous versions of Enea NFV Access.</para> | 9 | backwards compatibility with previous versions of Enea NFV Access if |
| 10 | applicable.</para> | ||
| 10 | 11 | ||
| 11 | <section id="relinfo-changes-other"> | 12 | <section id="relinfo-changes-other"> |
| 12 | <title>New Features</title> | 13 | <title>New Features</title> |
| @@ -23,6 +24,10 @@ | |||
| 23 | <listitem> | 24 | <listitem> |
| 24 | <para>OVS 2.9</para> | 25 | <para>OVS 2.9</para> |
| 25 | </listitem> | 26 | </listitem> |
| 27 | |||
| 28 | <listitem condition="arm"> | ||
| 29 | <para>ODP</para> | ||
| 30 | </listitem> | ||
| 26 | </itemizedlist> | 31 | </itemizedlist> |
| 27 | </listitem> | 32 | </listitem> |
| 28 | 33 | ||
| @@ -60,7 +65,7 @@ | |||
| 60 | </listitem> | 65 | </listitem> |
| 61 | 66 | ||
| 62 | <listitem> | 67 | <listitem> |
| 63 | <para>Unified cross-development SDK for host and virtualized | 68 | <para>Unified cross-development SDK and eSDK for host and virtualized |
| 64 | environments</para> | 69 | environments</para> |
| 65 | </listitem> | 70 | </listitem> |
| 66 | 71 | ||
| @@ -107,12 +112,12 @@ | |||
| 107 | <section id="relinfo-backward-compat"> | 112 | <section id="relinfo-backward-compat"> |
| 108 | <title>Compatibility</title> | 113 | <title>Compatibility</title> |
| 109 | 114 | ||
| 110 | <para condition="arm">Due to the fact that the current release is only | ||
| 111 | supported on ARM reference boards, it is not backwards compatible with | ||
| 112 | previous versions of Enea NFV Access.</para> | ||
| 113 | |||
| 114 | <para condition="intel">Due to the fact that ODP and OFP are not included | 115 | <para condition="intel">Due to the fact that ODP and OFP are not included |
| 115 | in this release, any applications dependent on these components are not | 116 | in this release, any applications dependent on these components are not |
| 116 | compatible with the current release.</para> | 117 | compatible with the current release.</para> |
| 118 | |||
| 119 | <para condition="arm">Due to the fact that the current release is only | ||
| 120 | supported on ARM reference boards, it is not backwards compatible with | ||
| 121 | previous versions of Enea NFV Access.</para> | ||
| 117 | </section> | 122 | </section> |
| 118 | </chapter> | 123 | </chapter> \ No newline at end of file |
diff --git a/doc/book-enea-nfv-access-release-info/doc/system_requirements_prerequisites.xml b/doc/book-enea-nfv-access-release-info/doc/system_requirements_prerequisites.xml index 44e70af..b0317b3 100644 --- a/doc/book-enea-nfv-access-release-info/doc/system_requirements_prerequisites.xml +++ b/doc/book-enea-nfv-access-release-info/doc/system_requirements_prerequisites.xml | |||
| @@ -46,7 +46,8 @@ | |||
| 46 | <entry>Disk space</entry> | 46 | <entry>Disk space</entry> |
| 47 | 47 | ||
| 48 | <entry>Your build host should have at least 50 GB of free disk space | 48 | <entry>Your build host should have at least 50 GB of free disk space |
| 49 | for installing the SDK or cross-compiling applications.</entry> | 49 | for installing the SDK, eSDK or cross-compiling |
| 50 | applications.</entry> | ||
| 50 | </row> | 51 | </row> |
| 51 | 52 | ||
| 52 | <row> | 53 | <row> |
