summaryrefslogtreecommitdiffstats
path: root/doc/book-enea-linux-user-guide/doc/getting_enea_linux.xml
diff options
context:
space:
mode:
Diffstat (limited to 'doc/book-enea-linux-user-guide/doc/getting_enea_linux.xml')
-rw-r--r--doc/book-enea-linux-user-guide/doc/getting_enea_linux.xml145
1 files changed, 145 insertions, 0 deletions
diff --git a/doc/book-enea-linux-user-guide/doc/getting_enea_linux.xml b/doc/book-enea-linux-user-guide/doc/getting_enea_linux.xml
new file mode 100644
index 0000000..e58726e
--- /dev/null
+++ b/doc/book-enea-linux-user-guide/doc/getting_enea_linux.xml
@@ -0,0 +1,145 @@
1<?xml version="1.0" encoding="ISO-8859-1"?>
2<chapter id="getting_el">
3 <title>Getting Enea Linux</title>
4
5 <para>Enea Linux is available as both pre-built binary images and source
6 code. Both serve a specific purpose and each have their advantages. However,
7 using the pre-built binary images allows for getting up and running faster.
8 Please refer to the sections below for details on how to get Enea Linux as
9 pre-built binary images or source code.</para>
10
11 <section id="get_prebuilt_bin">
12 <title>Getting Pre-Built Binaries</title>
13
14 <para>Enea Linux pre-built binaries are available for download on <ulink
15 url="https://portal.enea.com/login/?redirect_to=https%3A%2F%2Fportal.enea.com%2F">Enea
16 Download Portal</ulink>. Log in using the credentials provided. Using the
17 menu, browse to the <emphasis role="bold">Linux</emphasis> section. You
18 will now have access to the <emphasis role="bold">Files</emphasis> section
19 and the <emphasis role="bold">Online Documentation</emphasis>
20 section.</para>
21
22 <para>The Files section lists each Enea Linux distribution, one for each
23 version and profile, as a separate download package. Clicking on the name
24 of the distribution will open a new page, which presents further details
25 about the content of the release and a list of downloadable archives, one
26 for each hardware target included in the release. Each archive provides
27 the following content:</para>
28
29 <itemizedlist>
30 <listitem>
31 <para><emphasis>images</emphasis> directory - this directory includes
32 the binary image files needed to boot the target with Enea Linux. This
33 includes the kernel, the root file system, device tree, etc.</para>
34 </listitem>
35
36 <listitem>
37 <para><emphasis>sdk</emphasis> directory - this directory includes the
38 installer for the SDK.</para>
39 </listitem>
40
41 <listitem>
42 <para><emphasis>deb</emphasis> directory - this directory contains all
43 the packages included in the distribution in deb format, which can be
44 installed using the package manager.</para>
45 </listitem>
46 </itemizedlist>
47
48 <para>For faster downloads, each archive is mirrored in several places,
49 geographically. Choose the archive in the region closest to you.</para>
50
51 <para>The Documentation section lists all the documents delivered with the
52 release.</para>
53 </section>
54
55 <section id="getting_sources">
56 <title>Getting the Sources</title>
57
58 <para>Enea Linux sources are available for cloning from a set of Git
59 repositories on <ulink url="https://git.enea.com">git.enea.com</ulink>.
60 Since Enea Linux requires multiple repositories, Google Repo tool is used
61 in order to manage configurations and make the cloning step simpler.
62 Google Repo tool uses files, known as manifests, which store a list of
63 tuples (repository URL, version). The Repo tool is then used to traverse
64 the list of tuples in the manifest file and clone the specified versions
65 of each repository. See <ulink
66 url="https://code.google.com/p/git-repo/">https://code.google.com/p/git-repo/</ulink>
67 for more info.</para>
68
69 <section id="get_sourcecode_stepone">
70 <title>Get access to git.enea.com</title>
71
72 <para>In order to get access to git.enea.com, a ssh key is required for
73 Git authentication. If you don't already have such a key, follow the
74 steps below to generate one:</para>
75
76 <orderedlist>
77 <listitem>
78 <para>Generate the ssh key pair:</para>
79
80 <programlisting>$ ssh-keygen -t rsa</programlisting>
81
82 <para>When asked for a password, just press Enter. This will create
83 two files in the .ssh directory in your home directory.</para>
84
85 <programlisting>id_rsa
86id_rsa.pub</programlisting>
87 </listitem>
88
89 <listitem>
90 <para>Copy the public key into an authorized_keys file:</para>
91
92 <programlisting>$ cat id_rsa.pub &gt;&gt; authorized_keys</programlisting>
93 </listitem>
94 </orderedlist>
95
96 <para>Once these steps are done and you have a valid ssh key pair, send
97 the public key, <emphasis>id_rsa.pub</emphasis>, via email to
98 <email>mailto:git_support@list.enea.se</email> in order to get access to
99 <ulink url="https://git.enea.com">git.enea.com</ulink>.</para>
100 </section>
101
102 <section id="get_sourcecode_steptwo">
103 <title>Get Sources</title>
104
105 <para>To use the Repo tool to download the sources for Enea Linux, do
106 the following:</para>
107
108 <orderedlist>
109 <listitem>
110 <para>Make sure that the repo tool is installed. If not, do the
111 following: <remark>Below is include of ID
112 "eltf-getting-repo-install-command" from
113 eltf_params_updated.xml</remark></para>
114
115 <xi:include href="../../book-enea-linux-release-info/doc/eltf_params_updated.xml"
116 xmlns:xi="http://www.w3.org/2001/XInclude"
117 xpointer="element(eltf-getting-repo-install-command/1)" />
118 </listitem>
119
120 <listitem>
121 <para>Then use the repo command below:</para>
122
123 <xi:include href="../../book-enea-linux-release-info/doc/eltf_params_updated.xml"
124 xmlns:xi="http://www.w3.org/2001/XInclude"
125 xpointer="element(eltf-repo-cloning-enea-linux/1)" />
126 </listitem>
127 </orderedlist>
128
129 <para>Once the source code is downloaded, the current directory will
130 contain a <filename>README</filename> file with instructions on how to
131 build the distro and boot the machine you choose. .</para>
132
133 <para>It's not necessary to explicitly clone the manifest repository
134 since that is done automatically by the repo tool. To see the current
135 manifest, use the following command:</para>
136
137 <programlisting>$ repo manifest</programlisting>
138
139 <remark>The UG should be updated with instructions on how to add
140 customizations. That section should also contain more info about the
141 manifest: the manifest templates, using a branch instead of the tag EL6,
142 etc. When this is done a reference from here should be added.</remark>
143 </section>
144 </section>
145</chapter>