summaryrefslogtreecommitdiffstats
path: root/doc/book-enea-linux-user-guide/doc/getting_enea_linux.xml
blob: bb294641b0fc3a553b0bec7c876a34d2a38faa9c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
<?xml version="1.0" encoding="ISO-8859-1"?>
<chapter id="getting_el">
  <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="get_prebuilt_bin">
    <title>Getting Pre-Built Binaries</title>

    <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>

    <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 - 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>esdk</emphasis> directory - this directory includes the
        installer for the Extensible SDK.</para>
      </listitem>

      <listitem>
        <para><emphasis>deb</emphasis> directory - this directory contains all
        the packages included in the distribution in deb 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>
  </section>

  <section id="getting_sources">
    <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="get_sourcecode_stepone">
      <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="get_sourcecode_steptwo">
      <title>Get Sources</title>

      <para>To use the Repo tool to download the sources for Enea Linux, do
      the following:</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="../../book-enea-linux-release-info/doc/eltf_params_updated.xml"
                      xmlns:xi="http://www.w3.org/2001/XInclude"
                      xpointer="element(eltf-getting-repo-install-command/1)" />
        </listitem>

        <listitem>
          <para>Then use the repo command below:</para>

          <xi:include href="../../book-enea-linux-release-info/doc/eltf_params_updated.xml"
                      xmlns:xi="http://www.w3.org/2001/XInclude"
                      xpointer="element(eltf-repo-cloning-enea-linux/1)" />
        </listitem>
      </orderedlist>

      <para>Once the source code is downloaded, the current directory will
      contain a <filename>README</filename> file with instructions on how to
      build the distro and boot the machine you choose. .</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>

      <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>