Restructuring Enea NFV Access Rel Notes

USERDOCAP-224

Signed-off-by: Miruna Paun <Miruna.Paun@enea.com>

7 files changed, 226 insertions, 76 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 a3b6779..9ee8d14 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
@@ -103,23 +103,34 @@
    /* GRUB EFI file */</programlisting>
   </section>
 
-  <xi:include href="../../s_doceneacommon/doc/supported_host_environment.xml"
-              xmlns:xi="http://www.w3.org/2001/XInclude" />
+  <section id="relinfo-supported-host-environment">
+    <title>Supported Host Environment</title>
+
+    <itemizedlist>
+      <listitem>
+        <para>Ubuntu 14.04 LTS, 64-bit<remark>Hardcoded now in this XML file.
+        Might be moved to the parameter file later.</remark><remark>INFO Below
+        is a complete section with ID "eltf-target-tables-section" included
+        from elft_params_updated.xml. It contains a variable number of target
+        tables and the section title should be "Supported Targets with
+        Parameters". It has have a short sentence about what it is in the
+        beginning. The subtitles shall have the directory name of the target
+        in the manifest.</remark></para>
+      </listitem>
+    </itemizedlist>
+  </section>
 
   <xi:include href="eltf_params_updated.xml"
               xmlns:xi="http://www.w3.org/2001/XInclude"
               xpointer="element(eltf-target-tables-section)" />
 
-  <section condition="hidden" id="relinfo-provided-sdk">
+  <section id="relinfo-provided-sdk">
     <title>Provided Toolchain(s) (SDK)</title>
 
     <para>The SDK contains toolchains supporting cross-compilation of
-    applications for the targets on an x86_64 host. See the <olink
-    targetdoc="book_enea_linux_app_dev_guide"
-    targetptr="book_enea_linux_app_dev_guide"><trademark
+    applications for the targets on an x86_64 host. See the <trademark
     class="registered">Enea</trademark> NFV Access Application Development
-    Guide</olink> for information on how to build and install a
-    toolchain.</para>
+    Guide for information on how to build and install a toolchain.</para>
   </section>
 
   <section id="relinfo-documentation">
@@ -130,23 +141,19 @@
 
     <itemizedlist spacing="compact">
       <listitem>
-        <para><olink targetdoc="book_enea_nfv_access_guide"
-        targetptr="book_enea_nfv_access_guide">Enea NFV Access Guide</olink>
-        &ndash; A document describing how to use ENFV Access, as well as use
-        cases and benchmark results.</para>
+        <para>Enea NFV Access Release Information &ndash; This document,
+        describing the Enea NFV Access release content.</para>
       </listitem>
 
       <listitem>
-        <para>Enea NFV Access Release Information &ndash; This document,
-        describing the Enea NFV Access release content</para>
+        <para>Enea NFV Access Guide &ndash; A document describing how to use
+        Enea NFV Access, as well as use cases and benchmark results.</para>
       </listitem>
 
       <listitem>
-        <para><olink targetdoc="book_enea_nfv_access_open_source"
-        targetptr="book_enea_nfv_access_open_source">Enea NFV Access Open
-        Source Report</olink> &ndash; A document containing the open source
-        and license information pertaining to packages provided with Enea NFV
-        Access.</para>
+        <para>Enea NFV Access Open Source Report &ndash; A document containing
+        the open source and license information pertaining to packages
+        provided with Enea NFV Access.</para>
       </listitem>
 
       <listitem>
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 41cd118..f98751b 100644
--- a/doc/book-enea-nfv-access-release-info/doc/book.xml
+++ b/doc/book-enea-nfv-access-release-info/doc/book.xml
@@ -23,8 +23,8 @@
   <xi:include href="getting_enea_nfv_access.xml"
               xmlns:xi="http://www.w3.org/2001/XInclude" />
 
-  <xi:include href="build_boot_generated.xml"
-              xmlns:xi="http://www.w3.org/2001/XInclude" />
+<!--  <xi:include href="build_boot_generated.xml"
+              xmlns:xi="http://www.w3.org/2001/XInclude" /> -->
 
   <xi:include href="main_changes.xml"
               xmlns:xi="http://www.w3.org/2001/XInclude" />
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 0d0d805..503eb7c 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,8 +94,8 @@ repo sync</programlisting></para>
     <para>The table(s) below describes the target(s) supported in this Enea
     NFV Access release.</para>
 
-    <section id="eltf-target-table-p2041rdb">
-      <title>MACHINE p2041rdb - Information</title>
+    <section id="eltf-target-table-D-1521">
+      <title>MACHINE Intel Xeon D-1521 - Information</title>
 
       <para><informaltable>
           <tgroup cols="2">
@@ -107,21 +107,21 @@ repo sync</programlisting></para>
               <row>
                 <entry>Target official name</entry>
 
-                <entry>P2041RDB</entry>
+                <entry>Intel Xeon D-1521</entry>
               </row>
 
               <row>
                 <entry>Architecture and Description</entry>
 
-                <entry>Power, e500mc</entry>
+                <entry>x86-64b</entry>
               </row>
 
               <row>
                 <entry>Link to target datasheet</entry>
 
-                <entry>See <ulink
-                url="http://www.nxp.com/products/microcontrollers-and-processors/power-architecture-processors/qoriq-power-architecture-processors/p2041-qoriq-reference-design-board:RDP2041BOARD">link
-                to NXP's datasheet</ulink></entry>
+                <entry>See link to <ulink
+                url="https://ark.intel.com/products/91202/Intel-Xeon-Processor-D-1521-6M-Cache-2_40-GHz">Intel's
+                datasheet</ulink></entry>
               </row>
 
               <row>
@@ -149,14 +149,6 @@ repo sync</programlisting></para>
                 <entry>Ethernet, I2C, SPI, PCI Express, USB, Flash,
                 SD/SDHC/SDXC, RTC</entry>
               </row>
-
-              <row>
-                <entry>Enea rpm folder for downloading RPM packages for this
-                target</entry>
-
-                <entry><ulink
-                url="https://linux.enea.com/6/p2041rgb/rpm">https://linux.enea.com/6/p2041rgb/rpm</ulink></entry>
-              </row>
             </tbody>
           </tgroup>
         </informaltable></para>
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 664766d..aedfd1b 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
@@ -43,9 +43,9 @@
       </listitem>
 
       <listitem>
-        <para><emphasis>rpm</emphasis> directory &ndash; this directory
-        contains all the packages included in the distribution in rpm format,
-        which can be installed using the package manager.</para>
+        <para><emphasis>rpm/deb</emphasis> directory &ndash; this directory
+        contains all the packages included in the distribution in rpm/deb
+        format, which can be installed using the package manager.</para>
       </listitem>
     </itemizedlist>
 
@@ -98,7 +98,7 @@
     </itemizedlist>
   </section>
 
-  <section id="relinfo-getting-source">
+  <section condition="hidden" id="relinfo-getting-source">
     <title>Getting the Sources</title>
 
     <para>Enea NFV Access sources are available for cloning from a set of Git
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 ebe69c6..3dd3e80 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
@@ -9,7 +9,7 @@
   <para>This is the first release of Enea NFV Access, Networking
   profile.</para>
 
-  <section condition="hidden" id="relinfo-changes-other">
+  <section id="relinfo-changes-other">
     <title>New Features</title>
 
     <remark>Based in the Jira query: 'project = CPDX and fixVersion = "Enea
@@ -30,8 +30,8 @@
     </itemizedlist>
 
     <para>For details, see the Git logs for the repositories specified in the
-    manifest files. See <xref linkend="relinfo-getting-source" /> for more inf
-    on repos and the manifest.</para>
+    manifest files. See <xref linkend="relinfo-getting-enea-nfv-access" /> for
+    more inf on repos and the manifest.</para>
   </section>
 
   <section id="packages">
diff --git a/doc/book-enea-nfv-access-release-info/doc/system_requirements.xml b/doc/book-enea-nfv-access-release-info/doc/system_requirements.xml
index 015edb5..7bab63d 100644
--- a/doc/book-enea-nfv-access-release-info/doc/system_requirements.xml
+++ b/doc/book-enea-nfv-access-release-info/doc/system_requirements.xml
@@ -1,11 +1,11 @@
 <?xml version="1.0" encoding="ISO-8859-1"?>
 <!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
-<section id="enea-linux-sysreq">
+<section id="enea-nfv-access-sysreq">
   <title>System Requirements</title>
 
   <para>The host requirements listed below are extensive to allow for the
-  building of Linux images via the Yocto system and not just
+  building of Linux images via the Yocto system, and not just
   applications.</para>
 
   <para>Please also see the system requirements in the Yocto 2.1 documents:
@@ -40,7 +40,7 @@
           <entry>The downloaded code shall be built on a Linux host to
           generate images for your target or for emulation in QEMU. For
           information about the supported hosts and targets, see the <emphasis
-          role="bold">Enea NFV Access Release Information</emphasis> in your Enea
+          role="bold">Enea Linux Release Information</emphasis> in your Enea
           Linux distribution.</entry>
         </row>
 
@@ -66,7 +66,7 @@
 
           <entry>Images can be built or downloaded for any of the targets
           supported in this release, as specified in the <emphasis
-          role="bold">Enea NFV Access Release Information</emphasis>.</entry>
+          role="bold">Enea Linux Release Information</emphasis>.</entry>
         </row>
 
         <row>
@@ -98,7 +98,7 @@
           <emphasis>Eclipse Project Release Notes</emphasis> for the version
           used. This can usually be found via
           http://www.eclipse.org/eclipse/development/readme_eclipse_version.
-          See the <emphasis role="bold">Enea NFV Access Release Information
+          See the <emphasis role="bold">Enea Linux Release Information
           </emphasis>for the Eclipse Version.</entry>
         </row>
       </tbody>
@@ -146,7 +146,7 @@
   <section id="ensure-bash">
     <title>System Shell Configuration</title>
 
-    <para>Before installing Enea NFV Access, ensure that bash is the default
+    <para>Before installing Enea Linux, ensure that bash is the default
     shell.</para>
 
     <para>If your system runs Ubuntu, you can use ls -l to ensure
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 f598693..f4a815f 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
@@ -4,31 +4,182 @@
 <chapter id="sys-req-prerequisites">
   <title>System Requirements and Prerequisites</title>
 
-  <para>Using Enea NFV Access or compiling applications requires that your git
-  environment be setup properly and for certain packages to be installed on
-  your NFV Access development host.</para>
-
-  <para>Please refer to <ulink
-  url="https://git-scm.com/book/en/v2/Getting-Started-First-Time-Git-Setup">Getting
-  Started - First-Time Git Setup</ulink>, for more details on how to set up
-  your git environment correctly, including how to set your identity using the
-  following commands:</para>
-
-  <programlisting>$ git config --global user.name "John Doe"
-$ git config --global user.email johndoe@example.com</programlisting>
-
-  <para>First ensure the system is up-to-date, then for the supported
-  distribution(s), you need the following packages:<remark>INFO: The
-  programlisting below is a parameters in eltf_params_updated.xml with ID:
-  "eltf-prereq-apt-get-command-host". If multiple hosts are supported, store
-  the commands for each host in the same programlisting with empty lines
-  between each - the comment with the FULL HOST name and version is
-  essential.</remark></para>
-
-  <xi:include href="eltf_params_updated.xml"
-              xmlns:xi="http://www.w3.org/2001/XInclude"
-              xpointer="element(eltf-prereq-apt-get-commands-host/1)" />
-
-  <xi:include href="system_requirements.xml"
-              xmlns:xi="http://www.w3.org/2001/XInclude" />
+  <para>Using Enea NFV Access or compiling applications requires certain
+  packages to be installed on your NFV Access development host.</para>
+
+  <section id="enea-nfv-access-sysreq">
+    <title>System Requirements</title>
+
+    <para>The host requirements listed below are extensive to allow for the
+    building of Linux images via the Yocto system, and not just
+    applications.</para>
+
+    <para>Please also see the system requirements in the Yocto 2.1 documents:
+    Yocto Project Start <ulink
+    url="http://www.yoctoproject.org/docs/2.1/yocto-project-qs/yocto-project-qs.html#yp-resources">
+    http://www.yoctoproject.org/docs/2.1/yocto-project-qs/yocto-project-qs.html#yp-resources</ulink>
+    and the Yocto Project Reference Manual <ulink
+    url="http://www.yoctoproject.org/docs/2.1/ref-manual/ref-manual.html#intro-requirements">
+    http://www.yoctoproject.org/docs/2.1/ref-manual/ref-manual.html#intro-requirements</ulink>.
+    If needed, replace the Yocto version in the link(s) provided with a more
+    recent version.</para>
+
+    <informaltable>
+      <tgroup cols="2">
+        <colspec align="left" colname="1" colwidth="1*" />
+
+        <colspec align="left" colname="2" colwidth="3*" />
+
+        <spanspec nameend="2" namest="1" spanname="onetwo" />
+
+        <tbody>
+          <row>
+            <entry spanname="onetwo"><emphasis role="bold"> Build host
+            requirements<indexterm>
+                <primary>system requirements</primary>
+              </indexterm></emphasis></entry>
+          </row>
+
+          <row>
+            <entry>Linux distribution</entry>
+
+            <entry>The downloaded code shall be built on a Linux host to
+            generate images for your target or for emulation in QEMU. For
+            information about the supported hosts and targets, see the
+            <emphasis role="bold">Enea Linux Release Information</emphasis> in
+            your Enea Linux distribution.</entry>
+          </row>
+
+          <row>
+            <entry>Internet access</entry>
+
+            <entry>Internet access must be available when building an image,
+            since bitbake downloads source files from various servers during
+            the build.</entry>
+          </row>
+
+          <row>
+            <entry>Packages</entry>
+
+            <entry>Depending on the Linux distribution and version on host,
+            some packages may be required, by bitbake for example. You will
+            install any required packages while following the installation
+            instructions.</entry>
+          </row>
+
+          <row>
+            <entry>Targets</entry>
+
+            <entry>Images can be built or downloaded for any of the targets
+            supported in this release, as specified in the <emphasis
+            role="bold">Enea Linux Release Information</emphasis>.</entry>
+          </row>
+
+          <row>
+            <entry>Disk space</entry>
+
+            <entry><para>Your system should have at least 50 GB of free disk
+            space when bitbaking the basic enea-image-name kernel
+            image.</para> <para>For larger images and to allow for future
+            package extensions and variations in the build process, a minimum
+            of 100 GB free disk space is recommended.</para></entry>
+          </row>
+
+          <row>
+            <entry>Recommended RAM</entry>
+
+            <entry><para>Your system must have at least 4 GB available
+            RAM.</para> <para>It is recommended to have 8 GB RAM available for
+            parallel build jobs.</para></entry>
+          </row>
+
+          <row>
+            <entry>Java</entry>
+
+            <entry>Java <indexterm>
+                <primary>java</primary>
+              </indexterm>is required to run Eclipse. Currenly, Eclipse
+            generally recommends at least Java 6 JRE/JDK. More information
+            regarding operating environments for Eclipse, is provided in the
+            <emphasis>Eclipse Project Release Notes</emphasis> for the version
+            used. This can usually be found via
+            http://www.eclipse.org/eclipse/development/readme_eclipse_version.
+            See the <emphasis role="bold">Enea Linux Release Information
+            </emphasis>for the Eclipse Version.</entry>
+          </row>
+        </tbody>
+      </tgroup>
+    </informaltable>
+
+    <para>The build time depends on the capacity of the processor and other
+    hardware, available resources, speed of internet connection, load
+    situation, etc. E.g: on a fast 16 core machine with 16 GB RAM and SSD
+    disks, a complete build from source could take about two hours.</para>
+
+    <informaltable>
+      <tgroup cols="2">
+        <colspec align="left" colname="1" colwidth="1*" />
+
+        <colspec align="left" colname="2" colwidth="3*" />
+
+        <spanspec nameend="2" namest="1" spanname="onetwo" />
+
+        <tbody>
+          <row>
+            <entry spanname="onetwo"><emphasis role="bold">Target
+            Requirements</emphasis></entry>
+          </row>
+
+          <row>
+            <entry>External memory</entry>
+
+            <entry>To boot a CGL<indexterm>
+                <primary>CGL</primary>
+              </indexterm> image, you need at least 16 GB on a hard-disk
+            drive<indexterm>
+                <primary>HDD</primary>
+              </indexterm> on eSATA, USB drive, or SD card.<remark>INFO:
+            (packed rootfs 4.5 GB + unpacked rootfs 1.5 GB + good
+            margins)</remark><remark>INFO: NFS does not support SELinux. In
+            order to have a security-enhanced Linux, one must take off from an
+            NFS-booted system and proceed with boot from external
+            memory.</remark></entry>
+          </row>
+        </tbody>
+      </tgroup>
+    </informaltable>
+  </section>
+
+  <section id="ensure-bash">
+    <title>System Shell Configuration</title>
+
+    <para>Before installing Enea Linux, ensure that bash is the default
+    shell.</para>
+
+    <para>If your system runs Ubuntu, you can use ls -l to ensure
+    <filename>/usr/bin</filename> is a symbolic link to bash. In case the link
+    points to dash, which is default in some Ubuntu versions, change it to
+    bash by running <emphasis role="bold">sudo dpkg-reconfigure
+    dash</emphasis> and answer <emphasis role="bold">No</emphasis> to the
+    question "Use dash as the default system shell (/bin/sh)?":</para>
+
+    <programlisting># ls -l /bin/sh
+        lrwxrwxrwx 1 root root 4 2012-03-02 11:53 /bin/sh -&gt; bash</programlisting>
+  </section>
+
+  <section id="preq-packages">
+    <title>Prerequisite Packages</title>
+
+    <para>First ensure the system is up-to-date, then for the supported
+    distribution(s), you need the following packages:<remark>INFO: The
+    programlisting below is a parameters in eltf_params_updated.xml with ID:
+    "eltf-prereq-apt-get-command-host". If multiple hosts are supported, store
+    the commands for each host in the same programlisting with empty lines
+    between each - the comment with the FULL HOST name and version is
+    essential.</remark></para>
+
+    <xi:include href="eltf_params_updated.xml"
+                xmlns:xi="http://www.w3.org/2001/XInclude"
+                xpointer="element(eltf-prereq-apt-get-commands-host/1)" />
+  </section>
 </chapter>
\ No newline at end of file