diff options
Diffstat (limited to 'doc/book-enea-linux-user-guide/doc/preface.xml')
-rw-r--r-- | doc/book-enea-linux-user-guide/doc/preface.xml | 157 |
1 files changed, 157 insertions, 0 deletions
diff --git a/doc/book-enea-linux-user-guide/doc/preface.xml b/doc/book-enea-linux-user-guide/doc/preface.xml new file mode 100644 index 0000000..1752ff5 --- /dev/null +++ b/doc/book-enea-linux-user-guide/doc/preface.xml | |||
@@ -0,0 +1,157 @@ | |||
1 | <?xml version="1.0" encoding="ISO-8859-1"?> | ||
2 | <chapter id="preface"> | ||
3 | <title>Preface</title> | ||
4 | |||
5 | <section id="guide_purpose"> | ||
6 | <title>The Purpose of this Guide</title> | ||
7 | |||
8 | <para>This guide is intended for all Enea Linux developers who want to | ||
9 | configure and build customized Linux kernel images for embedded system | ||
10 | targets, but also for developers who want to build and run applications in | ||
11 | Enea Linux.</para> | ||
12 | |||
13 | <note> | ||
14 | <para>Always read the README files and the Release Information before | ||
15 | this User's Guide.</para> | ||
16 | </note> | ||
17 | |||
18 | <para>The recommended order of operations for developers are:</para> | ||
19 | |||
20 | <orderedlist> | ||
21 | <listitem> | ||
22 | <para>Receive information from Enea and read the initial documentation | ||
23 | online.</para> | ||
24 | </listitem> | ||
25 | |||
26 | <listitem> | ||
27 | <para>Update the development host with the needed packages, then | ||
28 | download and install Enea Linux.</para> | ||
29 | </listitem> | ||
30 | |||
31 | <listitem> | ||
32 | <para>Download and install the Cross-Compilation Toolchain.</para> | ||
33 | </listitem> | ||
34 | |||
35 | <listitem> | ||
36 | <para>Start developing your own Enea Linux applications or building | ||
37 | your own Enea Linux images.</para> | ||
38 | </listitem> | ||
39 | </orderedlist> | ||
40 | |||
41 | <para>It is assumed that the reader of this User's Guide has a deep | ||
42 | knowledge about Linux, how to configure the Linux kernel, and knows how to | ||
43 | use the Yocto build system. The variety of information provided in this | ||
44 | guide can serve as a quick start introduction to the standards and best | ||
45 | practices we share with the Linux community. In this spirit, Enea provides | ||
46 | <ulink url="http://www.enea.com/training">training courses</ulink>.</para> | ||
47 | |||
48 | <para>With this Enea Linux release you have a verified and easy to install | ||
49 | board support package for a number of supported hardware types. The board | ||
50 | support package includes a set of prebuilt utilities, accessible and setup | ||
51 | to rapidly reach your objectives as a developer. In this regard, the | ||
52 | support package contains a Linux kernel and root file system, a Software | ||
53 | Development Kit (SDK) which includes the cross-compilation toolchain, a | ||
54 | variety of tools and scripts for development and customization, and if | ||
55 | opted for, a user-friendly Eclipse version with an integrated development | ||
56 | environment.</para> | ||
57 | |||
58 | <para>The documentation for Enea Linux consists of generic and | ||
59 | distribution-specific documents. The generic documents are common for | ||
60 | several Enea Linux distributions. The main documents are:</para> | ||
61 | |||
62 | <table> | ||
63 | <tgroup cols="2"> | ||
64 | <tbody> | ||
65 | <row> | ||
66 | <entry>Enea Linux Release Information</entry> | ||
67 | |||
68 | <entry>A distribution specific document detailing what the current | ||
69 | release contains, including supported features, references to | ||
70 | other documentation, known problems and limitations, and Enea | ||
71 | support contact information.</entry> | ||
72 | </row> | ||
73 | |||
74 | <row> | ||
75 | <entry>README files for the distribution</entry> | ||
76 | |||
77 | <entry>Distribution specific documents that serve as an | ||
78 | introduction and how-to for this release, where you also find | ||
79 | target specific commands and parameters, replacing the generic | ||
80 | examples in the User's Guide. These files also point to Build, | ||
81 | Boot, and Configuration information details for this | ||
82 | distribution.</entry> | ||
83 | </row> | ||
84 | |||
85 | <row> | ||
86 | <entry>Enea Linux User's Guide</entry> | ||
87 | |||
88 | <entry>The generic manual for developers who build Linux kernels | ||
89 | for embedded systems or use prebuilt Linux kernels.</entry> | ||
90 | </row> | ||
91 | |||
92 | <row> | ||
93 | <entry>Enea Linux Open Source Report</entry> | ||
94 | |||
95 | <entry>The distribution specific list of software packages with | ||
96 | corresponding Open Source Licenses, that are included in the Enea | ||
97 | Linux distribution.</entry> | ||
98 | </row> | ||
99 | |||
100 | <row> | ||
101 | <entry>Enea Linux Security Report</entry> | ||
102 | |||
103 | <entry>The release specific document listing the CVEs affecting | ||
104 | this distribuition.</entry> | ||
105 | </row> | ||
106 | </tbody> | ||
107 | </tgroup> | ||
108 | </table> | ||
109 | |||
110 | <para>See also the following generic documentation related to the Yocto | ||
111 | project, which actually is based on OpenEmbedded.</para> | ||
112 | |||
113 | <itemizedlist> | ||
114 | <listitem> | ||
115 | <para><ulink | ||
116 | url="https://www.yoctoproject.org/documentation/archived">https://www.yoctoproject.org/documentation/archived</ulink> | ||
117 | - Yocto project documentation. Search for the Yocto version included | ||
118 | in your Enea Linux distribution.</para> | ||
119 | </listitem> | ||
120 | </itemizedlist> | ||
121 | |||
122 | <itemizedlist> | ||
123 | <listitem> | ||
124 | <para><ulink | ||
125 | url="http://docs.openembedded.org">http://docs.openembedded.org</ulink> | ||
126 | - OpenEmbedded documentation, useful since Yocto is based on | ||
127 | OpenEmbedded.</para> | ||
128 | </listitem> | ||
129 | </itemizedlist> | ||
130 | |||
131 | <itemizedlist> | ||
132 | <listitem> | ||
133 | <para><ulink | ||
134 | url="https://wiki.yoctoproject.org/wiki">https://wiki.yoctoproject.org/wiki | ||
135 | </ulink>- Yocto Wiki, useful information for Yocto users</para> | ||
136 | </listitem> | ||
137 | </itemizedlist> | ||
138 | |||
139 | <itemizedlist> | ||
140 | <listitem> | ||
141 | <para><ulink | ||
142 | url="https://wiki.yoctoproject.org/wiki/Ptest">https://wiki.yoctoproject.org/wiki/Ptest</ulink> | ||
143 | - Ptest wiki. Ptest was initiated by Enea, for building, installing | ||
144 | and running package test suites</para> | ||
145 | </listitem> | ||
146 | </itemizedlist> | ||
147 | |||
148 | <itemizedlist> | ||
149 | <listitem> | ||
150 | <para><ulink | ||
151 | url="http://www.crashcourse.ca/wiki/index.php/Poky_Variable_Glossary">http://www.crashcourse.ca/wiki/index.php/Poky_Variable_Glossary</ulink> | ||
152 | - Explanation of some Yocto/Poky variables used in the build | ||
153 | configuration files.</para> | ||
154 | </listitem> | ||
155 | </itemizedlist> | ||
156 | </section> | ||
157 | </chapter> \ No newline at end of file | ||