summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMiruna Paun <Miruna.Paun@enea.com>2017-05-04 16:45:20 +0200
committerMiruna Paun <Miruna.Paun@enea.com>2017-05-04 16:45:20 +0200
commitfaa47b1d830a510b0923245fca2f9e204d92d63a (patch)
tree241d37c6e4fcf99ef2a4f0c373c724df6da01b2f
parent89b9e8cbdccf656345b81557060deeb05bf63bf5 (diff)
downloadel_releases-virtualization-faa47b1d830a510b0923245fca2f9e204d92d63a.tar.gz
Removing the include note in relnotes virt
LXCR-7635 continuing updates of el relnotes virt LXCR-7714 adding need prebuilt images and source info Signed-off-by: Miruna Paun <Miruna.Paun@enea.com>
-rw-r--r--doc/book-enea-linux-release-info/doc/build_boot_template.xml10
-rw-r--r--doc/book-enea-linux-release-info/doc/getting_enea_linux.xml227
2 files changed, 174 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 @@
7 <para>If the source has been fetched (<xref 7 <para>If the source has been fetched (<xref
8 linkend="relinfo-getting-source" />), there will be a target specific README 8 linkend="relinfo-getting-source" />), there will be a target specific README
9 file containing the build and boot instructions. To make it easier for the 9 file containing the build and boot instructions. To make it easier for the
10 reader, the contents of these build/boot instruction have been extracted 10 reader, the contents of this file(s) have been extracted into the following
11 into the following sections.</para> 11 sections.</para>
12
13 <note>
14 <para>The build process duration may vary and be longer than expected in
15 some cases, depending on the individual build resources and parameters of
16 each target/machine supported in this release.</para>
17 </note>
12 18
13 <para><remark>NOTE: Only EDIT THE TEMPLATE build_boot_template.xml file here 19 <para><remark>NOTE: Only EDIT THE TEMPLATE build_boot_template.xml file here
14 and also only edit the manifest template ".README" (name starting by a dot)! 20 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..f1617c3 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,186 @@
4<chapter id="relinfo-getting-enea-linux"> 4<chapter id="relinfo-getting-enea-linux">
5 <title>Getting Enea Linux</title> 5 <title>Getting Enea Linux</title>
6 6
7 <para>Enea Linux is available as both pre-built binary images and source
8 code. Both serve a specific purpose and each have their advantages. However,
9 using the pre-built binary images allows for getting up and running faster.
10 Please refer to the sections below for details on how to get Enea Linux as
11 pre-built binary images or source code.</para>
12
7 <section id="relinfo-getting-pre-built-images"> 13 <section id="relinfo-getting-pre-built-images">
8 <title>Getting Pre-built Binaries</title> 14 <title>Getting Pre-built Binaries</title>
9 15
10 <para>Application developers will download pre-complied images from the 16 <para>Enea Linux pre-built binaries are available for download on <ulink
11 Enea Portal or will receive prebuilt images from the platform developers. 17 url="https://portal.enea.com/login/?redirect_to=https%3A%2F%2Fportal.enea.com%2F">Enea
12 For further information on this see <olink 18 Download Portal</ulink>. Log in using the credentials provided. Using the
13 targetdoc="book_enea_linux_app_dev_guide" 19 menu, browse to the <emphasis role="bold">Linux</emphasis> section. You
14 targetptr="book_enea_linux_app_dev_guide">Enea Linux Application 20 will now have access to the <emphasis role="bold">Files</emphasis> section
15 Development Guide</olink>.</para> 21 and the <emphasis role="bold">Online Documentation</emphasis>
16 </section> 22 section.</para>
17 23
18 <section id="relinfo-getting-source"> 24 <para>The Files section lists each Enea Linux distribution, one for each
19 <title>Getting the Source</title> 25 version and profile, as a separate download package. Clicking on the name
20 26 of the distribution will open a new page, which presents further details
21 <para>The source for this Enea Linux release is available for cloning from 27 about the content of the release and a list of downloadable archives, one
22 a set of Git repositories. To manage the different repositories, Google's 28 for each hardware target included in the release. Each archive provides
23 repo tool is used. The basic idea is to store a list with (repo-URL, 29 the following content:</para>
24 version) tuples in a separate file, known as the manifest. The repo tool 30
25 is then used to traverse the list and clone the specified versions of the 31 <itemizedlist>
26 repositories. See <ulink 32 <listitem>
27 url="https://code.google.com/p/git-repo/">https://code.google.com/p/git-repo/</ulink> 33 <para><emphasis>images</emphasis> directory &ndash; this directory
28 for more info.</para> 34 includes the binary image files needed to boot the target with Enea
35 Linux. This includes the kernel, the root file system, device tree,
36 etc.</para>
37 </listitem>
38
39 <listitem>
40 <para><emphasis>sdk</emphasis> directory &ndash; this directory
41 includes the installer for the SDK.</para>
42 </listitem>
43
44 <listitem>
45 <para><emphasis>rpm</emphasis> directory &ndash; this directory
46 contains all the packages included in the distribution in rpm format,
47 which can be installed using the package manager.</para>
48 </listitem>
49 </itemizedlist>
50
51 <para>For faster downloads, each archive is mirrored in several places,
52 geographically. Choose the archive in the region closest to you.</para>
29 53
30 <para>To use repo tool to download the source for Enea Linux, follow the 54 <para>The Documentation section lists all the documents delivered with the
31 steps below:</para> 55 release:</para>
32 56
33 <orderedlist> 57 <itemizedlist>
34 <listitem> 58 <listitem>
35 <para>Make sure that the repo tool is installed. If not, follow the 59 <para>Enea Linux Platform Developer&rsquo;s Guide</para>
36 instructions below. The instruction assumes a suitable place in your
37 PATH to use. You might change that.<remark>INFO: Below is include of
38 ID "eltf-getting-repo-install-command" from
39 eltf_params_updated.xml</remark></para>
40
41 <xi:include href="eltf_params_updated.xml"
42 xmlns:xi="http://www.w3.org/2001/XInclude"
43 xpointer="element(eltf-getting-repo-install-command/1)" />
44 </listitem> 60 </listitem>
45 61
46 <listitem> 62 <listitem>
47 <para>Use the repo tool to download the source: Please define MACHINE 63 <para>Enea Linux Application Developer's Guide</para>
48 to your target, uncomment and use one of the MACHINE lines listed 64
49 here,<remark>Below is the "machine_list" programlisting in 65 <remark>change profile as required</remark>
50 machine_list_generated.xml created by the make system by extracting
51 from the manifest</remark></para>
52
53 <xi:include href="machine_list_generated.xml"
54 xmlns:xi="http://www.w3.org/2001/XInclude"
55 xpointer="element(machine-list/1)" />
56
57 <para>and use the repo command below:<remark> Below is include of ID
58 "eltf-repo-cloning-enea-linux" from eltf_params_updated.xml. Here the
59 $MACHINE shall be given!</remark></para>
60
61 <xi:include href="eltf_params_updated.xml"
62 xmlns:xi="http://www.w3.org/2001/XInclude"
63 xpointer="element(eltf-repo-cloning-enea-linux/1)" />
64 </listitem> 66 </listitem>
65 </orderedlist>
66 67
67 <para>The source code is now downloaded. Current directory will contain a 68 <listitem>
68 README file with instructions on how to build the distro and boot the 69 <para>Enea Linux Virtualization Guide</para>
69 target. For convenience, these instructions are also copied into this 70 </listitem>
70 document. See <xref linkend="relinfo-build-boot" />.</para> 71
72 <listitem>
73 <para>Enea Linux Open Source Report</para>
74 </listitem>
75
76 <listitem>
77 <para>Eclipse Open Source Report</para>
78 </listitem>
79
80 <listitem>
81 <para>Enea Linux Release Info</para>
82 </listitem>
83 </itemizedlist>
84 </section>
85
86 <section id="relinfo-getting-source">
87 <title>Getting the Sources</title>
88
89 <para>Enea Linux sources are available for cloning from a set of Git
90 repositories on <ulink url="https://git.enea.com">git.enea.com</ulink>.
91 Since Enea Linux requires multiple repositories, Google Repo tool is used
92 in order to manage configurations and make the cloning step simpler.
93 Google Repo tool uses files, known as manifests, which store a list of
94 tuples (repository URL, version). The Repo tool is then used to traverse
95 the list of tuples in the manifest file and clone the specified versions
96 of each repository. See <ulink
97 url="https://code.google.com/p/git-repo/">https://code.google.com/p/git-repo/</ulink>
98 for more info.</para>
99
100 <section id="getting-source-code-step-one">
101 <title>Get access to git.enea.com</title>
102
103 <para>In order to get access to git.enea.com, a ssh key is required for
104 Git authentication. If you don't already have such a key, follow the
105 steps below to generate one:</para>
106
107 <orderedlist>
108 <listitem>
109 <para>Generate the ssh key pair:</para>
110
111 <programlisting>$ ssh-keygen -t rsa</programlisting>
112
113 <para>When asked for a password, just press Enter. This will create
114 two files in the .ssh directory in your home directory.</para>
115
116 <programlisting>id_rsa
117id_rsa.pub</programlisting>
118 </listitem>
119
120 <listitem>
121 <para>Copy the public key into an authorized_keys file:</para>
122
123 <programlisting>$ cat id_rsa.pub &gt;&gt; authorized_keys</programlisting>
124 </listitem>
125 </orderedlist>
126
127 <para>Once these steps are done and you have a valid ssh key pair, send
128 the public key, <emphasis>id_rsa.pub</emphasis>, via email to
129 <email>mailto:git_support@list.enea.se</email> in order to get access to
130 <ulink url="https://git.enea.com">git.enea.com</ulink>.</para>
131 </section>
132
133 <section id="getting-source-code-step-two">
134 <title>Get Sources</title>
135
136 <para>To use the Repo tool to download the sources for Enea Linux,
137 follow these steps:</para>
138
139 <orderedlist>
140 <listitem>
141 <para>Make sure that the repo tool is installed. If not, do the
142 following: <remark>Below is include of ID
143 "eltf-getting-repo-install-command" from
144 eltf_params_updated.xml</remark></para>
145
146 <xi:include href="eltf_params_updated.xml"
147 xmlns:xi="http://www.w3.org/2001/XInclude"
148 xpointer="element(eltf-getting-repo-install-command/1)" />
149 </listitem>
150
151 <listitem>
152 <para>Define the MACHINE from one of the targets listed
153 here,<remark>Below is the "machine_list" programlisting in
154 machine_list_generated.xml created by the make system by extracting
155 from the manifest</remark></para>
156
157 <xi:include href="machine_list_generated.xml"
158 xmlns:xi="http://www.w3.org/2001/XInclude"
159 xpointer="element(machine-list/1)" />
160
161 <para>and use the repo command below:<remark> Below is include of ID
162 "eltf-repo-cloning-enea-linux" from eltf_params_updated.xml. Here
163 the $MACHINE shall be given!</remark></para>
164
165 <xi:include href="eltf_params_updated.xml"
166 xmlns:xi="http://www.w3.org/2001/XInclude"
167 xpointer="element(eltf-repo-cloning-enea-linux/1)" />
168 </listitem>
169 </orderedlist>
170
171 <para>Once the source code is downloaded, the current directory will
172 contain a README file with instructions on how to build the distro and
173 boot the machine you choose. For ease of use, these instructions are
174 also copied into this document, see <xref
175 linkend="relinfo-build-boot" />.</para>
71 176
72 <para>It is not necessary to explicitly clone the manifest repository 177 <para>It's not necessary to explicitly clone the manifest repository
73 since that is done automatically by the repo tool. To see the current 178 since that is done automatically by the repo tool. To see the current
74 manifest, e.g. to get a list of the repositories, use the following 179 manifest, use the following command:</para>
75 command:</para>
76 180
77 <programlisting>$ repo manifest</programlisting> 181 <programlisting>$ repo manifest</programlisting>
78 182
79 <remark>The UG should be updated with instructions on how to add 183 <remark>The UG should be updated with instructions on how to add
80 customisations. That section should also contain some more info about the 184 customizations. That section should also contain more info about the
81 manifest: The manifest templates, using a branch instead of the tag EL6, 185 manifest: the manifest templates, using a branch instead of the tag EL6,
82 ... When this is done a reference from here should be added.</remark> 186 etc. When this is done a reference from here should be added.</remark>
187 </section>
83 </section> 188 </section>
84</chapter> \ No newline at end of file 189</chapter> \ No newline at end of file