diff options
Diffstat (limited to 'doc/book-enea-linux-release-info/doc/getting_enea_linux.xml')
-rw-r--r-- | doc/book-enea-linux-release-info/doc/getting_enea_linux.xml | 185 |
1 files changed, 185 insertions, 0 deletions
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 new file mode 100644 index 0000000..76487ef --- /dev/null +++ b/doc/book-enea-linux-release-info/doc/getting_enea_linux.xml | |||
@@ -0,0 +1,185 @@ | |||
1 | <?xml version="1.0" encoding="ISO-8859-1"?> | ||
2 | <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" | ||
3 | "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> | ||
4 | <chapter id="relinfo-getting-enea-linux"> | ||
5 | <title>Getting Enea Linux</title> | ||
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 | |||
13 | <section id="relinfo-getting-pre-built-images"> | ||
14 | <title>Getting Pre-built Binaries</title> | ||
15 | |||
16 | <para>Enea Linux pre-built binaries are available for download on <ulink | ||
17 | url="https://portal.enea.com/login/?redirect_to=https%3A%2F%2Fportal.enea.com%2F">portal.enea.com</ulink>. | ||
18 | Log in using the credentials provided by Enea for your user account. Using | ||
19 | the menu, browse to the Linux section where you will now have access to | ||
20 | the <emphasis role="bold">Files</emphasis> and <emphasis | ||
21 | role="bold">Online Documentation</emphasis> sections.</para> | ||
22 | |||
23 | <para>The Files section lists each Enea Linux distribution, one for each | ||
24 | version and profile, as a separate download package. Clicking on the name | ||
25 | of the distribution will open a new page, which presents further details | ||
26 | about the content of the release and a list of downloadable archives, one | ||
27 | for each hardware target included in the release. Each archive provides | ||
28 | the following content:</para> | ||
29 | |||
30 | <itemizedlist> | ||
31 | <listitem> | ||
32 | <para><emphasis>images</emphasis> directory – this directory | ||
33 | includes the binary image files needed to boot the target with Enea | ||
34 | Linux. This includes the kernel, the root file system, device tree, | ||
35 | etc.</para> | ||
36 | </listitem> | ||
37 | |||
38 | <listitem> | ||
39 | <para><emphasis>sdk</emphasis> directory – this directory | ||
40 | includes the installer for the SDK.</para> | ||
41 | </listitem> | ||
42 | |||
43 | <listitem> | ||
44 | <para><emphasis>deb</emphasis> directory – this directory | ||
45 | contains all the packages included in the distribution in deb format, | ||
46 | which can be installed using the package manager.</para> | ||
47 | </listitem> | ||
48 | </itemizedlist> | ||
49 | |||
50 | <para>For faster downloads, each archive is mirrored in several places, | ||
51 | geographically. Choose the archive in the region closest to you.</para> | ||
52 | |||
53 | <para>The Documentation section lists all the documents delivered with the | ||
54 | release:</para> | ||
55 | |||
56 | <itemizedlist> | ||
57 | <listitem> | ||
58 | <para><emphasis role="bold">Enea Linux User’s Guide</emphasis> - | ||
59 | intended for Enea Linux platform developers, who want to configure and | ||
60 | build customized Linux kernel images for embedded system targets, | ||
61 | using the Yocto configuration and build system.</para> | ||
62 | </listitem> | ||
63 | |||
64 | <listitem> | ||
65 | <para><emphasis role="bold">Enea Linux Open Source Report</emphasis> - | ||
66 | contains the open source and license information pertaining to | ||
67 | packages provided with this release of Enea Linux.</para> | ||
68 | </listitem> | ||
69 | |||
70 | <listitem> | ||
71 | <para><emphasis role="bold">Enea Linux Release Info</emphasis> - | ||
72 | provides information about the current released distribution for a | ||
73 | selected set of targets, along with installation requirements and | ||
74 | procedures.</para> | ||
75 | </listitem> | ||
76 | </itemizedlist> | ||
77 | </section> | ||
78 | |||
79 | <section id="relinfo-getting-source"> | ||
80 | <title>Getting the Sources</title> | ||
81 | |||
82 | <para>Enea Linux sources are available for cloning from a set of Git | ||
83 | repositories on <ulink url="https://git.enea.com">git.enea.com</ulink>. | ||
84 | Since Enea Linux requires multiple repositories, Google Repo tool is used | ||
85 | in order to manage configurations and make the cloning step simpler. The | ||
86 | Google Repo tool uses files, known as manifests, which store a list of | ||
87 | tuples (repository URL, version). The Repo tool is then used to traverse | ||
88 | the list of tuples in the manifest file and clone the specified versions | ||
89 | of each repository. See <ulink | ||
90 | url="https://code.google.com/p/git-repo/">Google Code Archive for | ||
91 | git-repo</ulink>, for more info.</para> | ||
92 | |||
93 | <section id="getting-source-code-step-one"> | ||
94 | <title>Get access to git.enea.com</title> | ||
95 | |||
96 | <para>In order to get access to git.enea.com, a ssh key is required for | ||
97 | Git authentication. If you don't already have such a key, follow the | ||
98 | steps below to generate one:</para> | ||
99 | |||
100 | <orderedlist> | ||
101 | <listitem> | ||
102 | <para>Generate the ssh key pair:</para> | ||
103 | |||
104 | <programlisting>$ ssh-keygen -t rsa</programlisting> | ||
105 | |||
106 | <para>When asked for a password, just press | ||
107 | <command>Enter</command>. This will create two files in the | ||
108 | <literal>.ssh</literal> directory in your home directory.</para> | ||
109 | |||
110 | <programlisting>id_rsa | ||
111 | id_rsa.pub</programlisting> | ||
112 | </listitem> | ||
113 | |||
114 | <listitem> | ||
115 | <para>Copy the public key into an authorized_keys file:</para> | ||
116 | |||
117 | <programlisting>$ cat id_rsa.pub >> authorized_keys</programlisting> | ||
118 | </listitem> | ||
119 | </orderedlist> | ||
120 | |||
121 | <para>Once these steps are done and you have a valid ssh key pair, send | ||
122 | the public key, | ||
123 | <emphasis><emphasis><filename>id_rsa.pub</filename></emphasis></emphasis>, | ||
124 | via email to <email>mailto:git_support@list.enea.se</email> in order to | ||
125 | get access to <ulink | ||
126 | url="https://git.enea.com">git.enea.com</ulink>.</para> | ||
127 | </section> | ||
128 | |||
129 | <section id="getting-source-code-step-two"> | ||
130 | <title>Get Sources</title> | ||
131 | |||
132 | <para>To use the Repo tool to download the sources for Enea Linux, do | ||
133 | the following:</para> | ||
134 | |||
135 | <orderedlist> | ||
136 | <listitem condition="hidden"> | ||
137 | <para>Make sure that the repo tool is installed. If not, do the | ||
138 | following: <remark>Below is include of ID | ||
139 | "eltf-getting-repo-install-command" from | ||
140 | eltf_params_updated.xml</remark></para> | ||
141 | |||
142 | <xi:include href="eltf_params_updated.xml" | ||
143 | xmlns:xi="http://www.w3.org/2001/XInclude" | ||
144 | xpointer="element(eltf-getting-repo-install-command/1)" /> | ||
145 | </listitem> | ||
146 | |||
147 | <listitem> | ||
148 | <para>Define the MACHINE to the following target listed | ||
149 | here:<remark>Below is the "machine_list" programlisting in | ||
150 | machine_list_generated.xml created by the make system by extracting | ||
151 | from the manifest</remark></para> | ||
152 | |||
153 | <xi:include href="machine_list_generated.xml" | ||
154 | xmlns:xi="http://www.w3.org/2001/XInclude" | ||
155 | xpointer="element(machine-list/1)" /> | ||
156 | </listitem> | ||
157 | |||
158 | <listitem> | ||
159 | <para>Then use the repo command below:</para> | ||
160 | |||
161 | <xi:include href="eltf_params_updated.xml" | ||
162 | xmlns:xi="http://www.w3.org/2001/XInclude" | ||
163 | xpointer="element(eltf-repo-cloning-enea-linux/1)" /> | ||
164 | </listitem> | ||
165 | </orderedlist> | ||
166 | |||
167 | <para>Once the source code is downloaded, the current directory will | ||
168 | contain a README file with instructions on how to build the distro and | ||
169 | boot the raspberry pi machine. For ease of use, these instructions are | ||
170 | also copied into this document, see <xref | ||
171 | linkend="relinfo-build-boot" />.</para> | ||
172 | |||
173 | <para>It is not necessary to explicitly clone the manifest repository | ||
174 | since that is done automatically by the repo tool. To see the current | ||
175 | manifest, use the following command:</para> | ||
176 | |||
177 | <programlisting>$ repo manifest</programlisting> | ||
178 | |||
179 | <remark>The UG should be updated with instructions on how to add | ||
180 | customizations. That section should also contain more info about the | ||
181 | manifest: the manifest templates, using a branch instead of the tag EL6, | ||
182 | etc. When this is done a reference from here should be added.</remark> | ||
183 | </section> | ||
184 | </section> | ||
185 | </chapter> \ No newline at end of file | ||