Updated getting EL and build boot chs

LXCR-7635

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

2 files changed, 182 insertions, 63 deletions

diff --git a/doc/book-enea-linux-release-info/doc/build_boot_template.xml b/doc/book-enea-linux-release-info/doc/build_boot_template.xml
index 2200997..e39dd81 100644
--- a/doc/book-enea-linux-release-info/doc/build_boot_template.xml
+++ b/doc/book-enea-linux-release-info/doc/build_boot_template.xml
@@ -7,8 +7,14 @@
   <para>If the source has been fetched (<xref
   linkend="relinfo-getting-source" />), there will be a target specific README
   file containing the build and boot instructions. To make it easier for the
-  reader, the contents of these build/boot instruction have been extracted
-  into the following sections.</para>
+  reader, the contents of this file(s) have been extracted into the following
+  sections.</para>
+
+  <note>
+    <para>The build process duration may vary and be longer than expected in
+    some cases, depending on the individual build resources and parameters of
+    each target/machine supported in this release.</para>
+  </note>
 
   <para><remark>NOTE: Only EDIT THE TEMPLATE build_boot_template.xml file here
   and also only edit the manifest template ".README" (name starting by a dot)!
diff --git a/doc/book-enea-linux-release-info/doc/getting_enea_linux.xml b/doc/book-enea-linux-release-info/doc/getting_enea_linux.xml
index 055be15..096e317 100644
--- a/doc/book-enea-linux-release-info/doc/getting_enea_linux.xml
+++ b/doc/book-enea-linux-release-info/doc/getting_enea_linux.xml
@@ -4,81 +4,194 @@
 <chapter id="relinfo-getting-enea-linux">
   <title>Getting Enea Linux</title>
 
+  <para>Enea Linux is available as both pre-built binary images and source
+  code. Both serve a specific purpose and each have their advantages. However,
+  using the pre-built binary images allows for getting up and running faster.
+  Please refer to the sections below for details on how to get Enea Linux as
+  pre-built binary images or source code.</para>
+
   <section id="relinfo-getting-pre-built-images">
     <title>Getting Pre-built Binaries</title>
 
-    <para>Application developers will download pre-complied images from the
-    Enea Portal or will receive prebuilt images from the platform developers.
-    For further information on this see <olink
-    targetdoc="book_enea_linux_app_dev_guide"
-    targetptr="book_enea_linux_app_dev_guide">Enea Linux Application
-    Development Guide</olink>.</para>
-  </section>
+    <para>Enea Linux pre-built binaries are available for download on <ulink
+    url="https://portal.enea.com/login/?redirect_to=https%3A%2F%2Fportal.enea.com%2F">Enea
+    Download Portal</ulink>. Log in using the credentials provided. Using the
+    menu, browse to the <emphasis role="bold">Linux</emphasis> section. You
+    will now have access to the <emphasis role="bold">Files</emphasis> section
+    and the <emphasis role="bold">Online Documentation</emphasis>
+    section.</para>
 
-  <section id="relinfo-getting-source">
-    <title>Getting the Source</title>
-
-    <para>The source for this Enea Linux release is available for cloning from
-    a set of Git repositories. To manage the different repositories, Google's
-    repo tool is used. The basic idea is to store a list with (repo-URL,
-    version) tuples in a separate file, known as the manifest. The repo tool
-    is then used to traverse the list and clone the specified versions of the
-    repositories. See <ulink
-    url="https://code.google.com/p/git-repo/">https://code.google.com/p/git-repo/</ulink>
-    for more info.</para>
+    <para>The Files section lists each Enea Linux distribution, one for each
+    version and profile, as a separate download package. Clicking on the name
+    of the distribution will open a new page, which presents further details
+    about the content of the release and a list of downloadable archives, one
+    for each hardware target included in the release. Each archive provides
+    the following content:</para>
+
+    <itemizedlist>
+      <listitem>
+        <para><emphasis>images</emphasis> directory &ndash; this directory
+        includes the binary image files needed to boot the target with Enea
+        Linux. This includes the kernel, the root file system, device tree,
+        etc.</para>
+      </listitem>
+
+      <listitem>
+        <para><emphasis>sdk</emphasis> directory &ndash; this directory
+        includes the installer for the SDK.</para>
+      </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>
+      </listitem>
+    </itemizedlist>
+
+    <para>For faster downloads, each archive is mirrored in several places,
+    geographically. Choose the archive in the region closest to you.</para>
+
+    <para>The Documentation section lists all the documents delivered with the
+    release:</para>
+
+    <itemizedlist>
+      <listitem>
+        <para><emphasis role="bold">Enea Linux Platform Developer&rsquo;s
+        Guide</emphasis> -intended for Enea Linux platform developers, who
+        want to configure and build customized Linux kernel images for
+        embedded system targets, using the Yocto configuration and build
+        system.</para>
+      </listitem>
+
+      <listitem>
+        <para><emphasis role="bold">Enea Linux Application Developer's
+        Guide</emphasis> - dedicated to Enea Linux application developers, who
+        want to build and run applications.</para>
+      </listitem>
 
-    <para>To use repo tool to download the source for Enea Linux, follow the
-    steps below:</para>
+      <listitem>
+        <para><emphasis role="bold">Enea Linux Open Source Report</emphasis> -
+        contains the open source and license information pertaining to
+        packages provided with this release of Enea Linux.</para>
+      </listitem>
 
-    <orderedlist>
       <listitem>
-        <para>Make sure that the repo tool is installed. If not, follow the
-        instructions below. The instruction assumes a suitable place in your
-        PATH to use. You might change that.<remark>INFO: Below is include of
-        ID "eltf-getting-repo-install-command" from
-        eltf_params_updated.xml</remark></para>
-
-        <xi:include href="eltf_params_updated.xml"
-                    xmlns:xi="http://www.w3.org/2001/XInclude"
-                    xpointer="element(eltf-getting-repo-install-command/1)" />
+        <para><emphasis role="bold">Enea Linux Eclipse Open Source
+        Report</emphasis> - contains the open source and license information
+        pertaining to the Eclipse package provided with this release of Enea
+        Linux.</para>
       </listitem>
 
       <listitem>
-        <para>Use the repo tool to download the source: Please define MACHINE
-        to your target, uncomment and use one of the MACHINE lines listed
-        here,<remark>Below is the "machine_list" programlisting in
-        machine_list_generated.xml created by the make system by extracting
-        from the manifest</remark></para>
-
-        <xi:include href="machine_list_generated.xml"
-                    xmlns:xi="http://www.w3.org/2001/XInclude"
-                    xpointer="element(machine-list/1)" />
-
-        <para>and use the repo command below:<remark> Below is include of ID
-        "eltf-repo-cloning-enea-linux" from eltf_params_updated.xml. Here the
-        $MACHINE shall be given!</remark></para>
-
-        <xi:include href="eltf_params_updated.xml"
-                    xmlns:xi="http://www.w3.org/2001/XInclude"
-                    xpointer="element(eltf-repo-cloning-enea-linux/1)" />
+        <para><emphasis role="bold">Enea Linux Release Info</emphasis> -
+        provides information about the current released distribution for a
+        selected set of targets, along with installation requirements and
+        procedures.</para>
       </listitem>
-    </orderedlist>
+    </itemizedlist>
+  </section>
+
+  <section id="relinfo-getting-source">
+    <title>Getting the Sources</title>
+
+    <para>Enea Linux sources are available for cloning from a set of Git
+    repositories on <ulink url="https://git.enea.com">git.enea.com</ulink>.
+    Since Enea Linux requires multiple repositories, Google Repo tool is used
+    in order to manage configurations and make the cloning step simpler.
+    Google Repo tool uses files, known as manifests, which store a list of
+    tuples (repository URL, version). The Repo tool is then used to traverse
+    the list of tuples in the manifest file and clone the specified versions
+    of each repository. See <ulink
+    url="https://code.google.com/p/git-repo/">https://code.google.com/p/git-repo/</ulink>
+    for more info.</para>
+
+    <section id="getting-source-code-step-one">
+      <title>Get access to git.enea.com</title>
+
+      <para>In order to get access to git.enea.com, a ssh key is required for
+      Git authentication. If you don't already have such a key, follow the
+      steps below to generate one:</para>
+
+      <orderedlist>
+        <listitem>
+          <para>Generate the ssh key pair:</para>
+
+          <programlisting>$ ssh-keygen -t rsa</programlisting>
+
+          <para>When asked for a password, just press Enter. This will create
+          two files in the .ssh directory in your home directory.</para>
+
+          <programlisting>id_rsa
+id_rsa.pub</programlisting>
+        </listitem>
+
+        <listitem>
+          <para>Copy the public key into an authorized_keys file:</para>
+
+          <programlisting>$ cat id_rsa.pub &gt;&gt; authorized_keys</programlisting>
+        </listitem>
+      </orderedlist>
+
+      <para>Once these steps are done and you have a valid ssh key pair, send
+      the public key, <emphasis>id_rsa.pub</emphasis>, via email to
+      <email>mailto:git_support@list.enea.se</email> in order to get access to
+      <ulink url="https://git.enea.com">git.enea.com</ulink>.</para>
+    </section>
+
+    <section id="getting-source-code-step-two">
+      <title>Get Sources</title>
+
+      <para>To use the Repo tool to download the sources for Enea Linux,
+      follow these steps:</para>
+
+      <orderedlist>
+        <listitem>
+          <para>Make sure that the repo tool is installed. If not, do the
+          following: <remark>Below is include of ID
+          "eltf-getting-repo-install-command" from
+          eltf_params_updated.xml</remark></para>
+
+          <xi:include href="eltf_params_updated.xml"
+                      xmlns:xi="http://www.w3.org/2001/XInclude"
+                      xpointer="element(eltf-getting-repo-install-command/1)" />
+        </listitem>
+
+        <listitem>
+          <para>Define the MACHINE from one of the targets listed
+          here,<remark>Below is the "machine_list" programlisting in
+          machine_list_generated.xml created by the make system by extracting
+          from the manifest</remark></para>
+
+          <xi:include href="machine_list_generated.xml"
+                      xmlns:xi="http://www.w3.org/2001/XInclude"
+                      xpointer="element(machine-list/1)" />
+
+          <para>and use the repo command below:<remark> Below is include of ID
+          "eltf-repo-cloning-enea-linux" from eltf_params_updated.xml. Here
+          the $MACHINE shall be given!</remark></para>
+
+          <xi:include href="eltf_params_updated.xml"
+                      xmlns:xi="http://www.w3.org/2001/XInclude"
+                      xpointer="element(eltf-repo-cloning-enea-linux/1)" />
+        </listitem>
+      </orderedlist>
 
-    <para>The source code is now downloaded. Current directory will contain a
-    README file with instructions on how to build the distro and boot the
-    target. For convenience, these instructions are also copied into this
-    document. See <xref linkend="relinfo-build-boot" />.</para>
+      <para>Once the source code is downloaded, the current directory will
+      contain a README file with instructions on how to build the distro and
+      boot the machine you choose. For ease of use, these instructions are
+      also copied into this document, see <xref
+      linkend="relinfo-build-boot" />.</para>
 
-    <para>It is not necessary to explicitly clone the manifest repository
-    since that is done automatically by the repo tool. To see the current
-    manifest, e.g. to get a list of the repositories, use the following
-    command:</para>
+      <para>It's not necessary to explicitly clone the manifest repository
+      since that is done automatically by the repo tool. To see the current
+      manifest, use the following command:</para>
 
-    <programlisting>$ repo manifest</programlisting>
+      <programlisting>$ repo manifest</programlisting>
 
-    <remark>The UG should be updated with instructions on how to add
-    customisations. That section should also contain some more info about the
-    manifest: The manifest templates, using a branch instead of the tag EL6,
-    ... When this is done a reference from here should be added.</remark>
+      <remark>The UG should be updated with instructions on how to add
+      customizations. That section should also contain more info about the
+      manifest: the manifest templates, using a branch instead of the tag EL6,
+      etc. When this is done a reference from here should be added.</remark>
+    </section>
   </section>
 </chapter>
\ No newline at end of file