summaryrefslogtreecommitdiffstats
path: root/doc/book-enea-linux-user-guide/doc/preface.xml
blob: 1752ff519b618084c32965b0c0cfc6be6fa61f9d (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
146
147
148
149
150
151
152
153
154
155
156
157
<?xml version="1.0" encoding="ISO-8859-1"?>
<chapter id="preface">
  <title>Preface</title>

  <section id="guide_purpose">
    <title>The Purpose of this Guide</title>

    <para>This guide is intended for all Enea Linux developers who want to
    configure and build customized Linux kernel images for embedded system
    targets, but also for developers who want to build and run applications in
    Enea Linux.</para>

    <note>
      <para>Always read the README files and the Release Information before
      this User's Guide.</para>
    </note>

    <para>The recommended order of operations for developers are:</para>

    <orderedlist>
      <listitem>
        <para>Receive information from Enea and read the initial documentation
        online.</para>
      </listitem>

      <listitem>
        <para>Update the development host with the needed packages, then
        download and install Enea Linux.</para>
      </listitem>

      <listitem>
        <para>Download and install the Cross-Compilation Toolchain.</para>
      </listitem>

      <listitem>
        <para>Start developing your own Enea Linux applications or building
        your own Enea Linux images.</para>
      </listitem>
    </orderedlist>

    <para>It is assumed that the reader of this User's Guide has a deep
    knowledge about Linux, how to configure the Linux kernel, and knows how to
    use the Yocto build system. The variety of information provided in this
    guide can serve as a quick start introduction to the standards and best
    practices we share with the Linux community. In this spirit, Enea provides
    <ulink url="http://www.enea.com/training">training courses</ulink>.</para>

    <para>With this Enea Linux release you have a verified and easy to install
    board support package for a number of supported hardware types. The board
    support package includes a set of prebuilt utilities, accessible and setup
    to rapidly reach your objectives as a developer. In this regard, the
    support package contains a Linux kernel and root file system, a Software
    Development Kit (SDK) which includes the cross-compilation toolchain, a
    variety of tools and scripts for development and customization, and if
    opted for, a user-friendly Eclipse version with an integrated development
    environment.</para>

    <para>The documentation for Enea Linux consists of generic and
    distribution-specific documents. The generic documents are common for
    several Enea Linux distributions. The main documents are:</para>

    <table>
      <tgroup cols="2">
        <tbody>
          <row>
            <entry>Enea Linux Release Information</entry>

            <entry>A distribution specific document detailing what the current
            release contains, including supported features, references to
            other documentation, known problems and limitations, and Enea
            support contact information.</entry>
          </row>

          <row>
            <entry>README files for the distribution</entry>

            <entry>Distribution specific documents that serve as an
            introduction and how-to for this release, where you also find
            target specific commands and parameters, replacing the generic
            examples in the User's Guide. These files also point to Build,
            Boot, and Configuration information details for this
            distribution.</entry>
          </row>

          <row>
            <entry>Enea Linux User's Guide</entry>

            <entry>The generic manual for developers who build Linux kernels
            for embedded systems or use prebuilt Linux kernels.</entry>
          </row>

          <row>
            <entry>Enea Linux Open Source Report</entry>

            <entry>The distribution specific list of software packages with
            corresponding Open Source Licenses, that are included in the Enea
            Linux distribution.</entry>
          </row>

          <row>
            <entry>Enea Linux Security Report</entry>

            <entry>The release specific document listing the CVEs affecting
            this distribuition.</entry>
          </row>
        </tbody>
      </tgroup>
    </table>

    <para>See also the following generic documentation related to the Yocto
    project, which actually is based on OpenEmbedded.</para>

    <itemizedlist>
      <listitem>
        <para><ulink
        url="https://www.yoctoproject.org/documentation/archived">https://www.yoctoproject.org/documentation/archived</ulink>
        - Yocto project documentation. Search for the Yocto version included
        in your Enea Linux distribution.</para>
      </listitem>
    </itemizedlist>

    <itemizedlist>
      <listitem>
        <para><ulink
        url="http://docs.openembedded.org">http://docs.openembedded.org</ulink>
        - OpenEmbedded documentation, useful since Yocto is based on
        OpenEmbedded.</para>
      </listitem>
    </itemizedlist>

    <itemizedlist>
      <listitem>
        <para><ulink
        url="https://wiki.yoctoproject.org/wiki">https://wiki.yoctoproject.org/wiki
        </ulink>- Yocto Wiki, useful information for Yocto users</para>
      </listitem>
    </itemizedlist>

    <itemizedlist>
      <listitem>
        <para><ulink
        url="https://wiki.yoctoproject.org/wiki/Ptest">https://wiki.yoctoproject.org/wiki/Ptest</ulink>
        - Ptest wiki. Ptest was initiated by Enea, for building, installing
        and running package test suites</para>
      </listitem>
    </itemizedlist>

    <itemizedlist>
      <listitem>
        <para><ulink
        url="http://www.crashcourse.ca/wiki/index.php/Poky_Variable_Glossary">http://www.crashcourse.ca/wiki/index.php/Poky_Variable_Glossary</ulink>
        - Explanation of some Yocto/Poky variables used in the build
        configuration files.</para>
      </listitem>
    </itemizedlist>
  </section>
</chapter>