diff options
| author | Dragos Motrea <Dragos.Motrea@enea.com> | 2018-01-17 10:52:51 +0100 |
|---|---|---|
| committer | Dragos Motrea <Dragos.Motrea@enea.com> | 2018-01-17 10:52:51 +0100 |
| commit | ae1e0b34609584805aa217ba412d774302f88794 (patch) | |
| tree | f670c17fd8b0452764e4e0e745d1233fafec8312 /doc | |
| parent | fc581a780d145c4624890fa506d9d5386821a507 (diff) | |
| download | el_releases-standard-ae1e0b34609584805aa217ba412d774302f88794.tar.gz | |
el7_std: Added Preface and Introduction chapter to doc
Signed-off-by: Dragos Motrea <Dragos.Motrea@enea.com>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/book-enea-linux-user-guide/doc/introduction.xml | 53 | ||||
| -rw-r--r-- | doc/book-enea-linux-user-guide/doc/preface.xml | 146 |
2 files changed, 192 insertions, 7 deletions
diff --git a/doc/book-enea-linux-user-guide/doc/introduction.xml b/doc/book-enea-linux-user-guide/doc/introduction.xml index 79d15d6..ccbdb0a 100644 --- a/doc/book-enea-linux-user-guide/doc/introduction.xml +++ b/doc/book-enea-linux-user-guide/doc/introduction.xml | |||
| @@ -2,9 +2,54 @@ | |||
| 2 | <chapter id="intro"> | 2 | <chapter id="intro"> |
| 3 | <title>Introduction</title> | 3 | <title>Introduction</title> |
| 4 | 4 | ||
| 5 | <section id="placeholder_id_a"> | 5 | <para>Welcome to Enea<trademark class="registered"></trademark> Linux</para> |
| 6 | <title></title> | ||
| 7 | 6 | ||
| 8 | <para></para> | 7 | <para>Enea<trademark class="registered"></trademark> Linux is based on the |
| 9 | </section> | 8 | open source configuration system Yocto which is becoming the de facto |
| 9 | standard for building and configuring embedded Linux. Yocto development is | ||
| 10 | coordinated by the Yocto Project which was initiated by the Linux | ||
| 11 | Foundation.</para> | ||
| 12 | |||
| 13 | <para>The Yocto-based development environment of Enea Linux allows you to | ||
| 14 | build embedded Linux kernels and tool chains on a Linux host. It aids you in | ||
| 15 | customizing embedded Linux kernels for a specific hardware architecture, and | ||
| 16 | in building and troubleshooting embedded Linux applications on targets or | ||
| 17 | emulated in QEMU.</para> | ||
| 18 | |||
| 19 | <para>Enea Linux also provides verified and easily installed board support | ||
| 20 | packages (BSP) for a number of hardware architectures. Each BSP includes a | ||
| 21 | Linux kernel and a root filesystem (rootfs), plus a number of packages that | ||
| 22 | can be extended on request.</para> | ||
| 23 | |||
| 24 | <para>Providing true open source Linux with customer interests in mind, is | ||
| 25 | the cornerstone for Enea when supplying Enea Linux. We provide:</para> | ||
| 26 | |||
| 27 | <itemizedlist> | ||
| 28 | <listitem> | ||
| 29 | <para>A Yocto compatible environment, familiar for those who have used | ||
| 30 | Yocto from any other distribution.</para> | ||
| 31 | </listitem> | ||
| 32 | |||
| 33 | <listitem> | ||
| 34 | <para>The Enea Linux environment is fully independent from hardware | ||
| 35 | vendor leverage and does not push for a particular hardware | ||
| 36 | architecture.</para> | ||
| 37 | </listitem> | ||
| 38 | |||
| 39 | <listitem> | ||
| 40 | <para>Enea has initiated and contributes the ptest package test | ||
| 41 | framework to the Yocto Project. Enea also uses ptest to verify the | ||
| 42 | packages on target.</para> | ||
| 43 | </listitem> | ||
| 44 | </itemizedlist> | ||
| 45 | |||
| 46 | <para>By using, testing Yocto and sharing Linux patches with upstream | ||
| 47 | projects, Enea assists the open source community in providing mature | ||
| 48 | software in less time. As an Enea Linux user, you are welcome to contribute | ||
| 49 | to the global development of Linux by propagating your Linux patches through | ||
| 50 | Enea.</para> | ||
| 51 | |||
| 52 | <para>Enea can also assist a customer by analyzing source code and producing | ||
| 53 | valid open source reports, as required by the community when open source | ||
| 54 | components are used.</para> | ||
| 10 | </chapter> \ No newline at end of file | 55 | </chapter> \ No newline at end of file |
diff --git a/doc/book-enea-linux-user-guide/doc/preface.xml b/doc/book-enea-linux-user-guide/doc/preface.xml index 2c80732..49373b2 100644 --- a/doc/book-enea-linux-user-guide/doc/preface.xml +++ b/doc/book-enea-linux-user-guide/doc/preface.xml | |||
| @@ -2,9 +2,149 @@ | |||
| 2 | <chapter id="preface"> | 2 | <chapter id="preface"> |
| 3 | <title>Preface</title> | 3 | <title>Preface</title> |
| 4 | 4 | ||
| 5 | <section id="placeholder_id_b"> | 5 | <section id="guide_purpose"> |
| 6 | <title></title> | 6 | <title>The Purpose of This Guide</title> |
| 7 | 7 | ||
| 8 | <para></para> | 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 | </tbody> | ||
| 100 | </tgroup> | ||
| 101 | </table> | ||
| 102 | |||
| 103 | <para>See also the following generic documentation related to the Yocto | ||
| 104 | project, which actually is based on OpenEmbedded.</para> | ||
| 105 | |||
| 106 | <itemizedlist> | ||
| 107 | <listitem> | ||
| 108 | <para><ulink | ||
| 109 | url="https://www.yoctoproject.org/documentation/archived">https://www.yoctoproject.org/documentation/archived</ulink> | ||
| 110 | - Yocto project documentation. Search for the Yocto version included | ||
| 111 | in your Enea Linux distribution.</para> | ||
| 112 | </listitem> | ||
| 113 | </itemizedlist> | ||
| 114 | |||
| 115 | <itemizedlist> | ||
| 116 | <listitem> | ||
| 117 | <para><ulink | ||
| 118 | url="http://docs.openembedded.org">http://docs.openembedded.org</ulink> | ||
| 119 | - OpenEmbedded documentation, useful since Yocto is based on | ||
| 120 | OpenEmbedded.</para> | ||
| 121 | </listitem> | ||
| 122 | </itemizedlist> | ||
| 123 | |||
| 124 | <itemizedlist> | ||
| 125 | <listitem> | ||
| 126 | <para><ulink | ||
| 127 | url="https://wiki.yoctoproject.org/wiki">https://wiki.yoctoproject.org/wiki | ||
| 128 | </ulink>- Yocto Wiki, useful information for Yocto users</para> | ||
| 129 | </listitem> | ||
| 130 | </itemizedlist> | ||
| 131 | |||
| 132 | <itemizedlist> | ||
| 133 | <listitem> | ||
| 134 | <para><ulink | ||
| 135 | url="https://wiki.yoctoproject.org/wiki/Ptest">https://wiki.yoctoproject.org/wiki/Ptest</ulink> | ||
| 136 | - Ptest wiki. Ptest was initiated by Enea, for building, installing | ||
| 137 | and running package test suites</para> | ||
| 138 | </listitem> | ||
| 139 | </itemizedlist> | ||
| 140 | |||
| 141 | <itemizedlist> | ||
| 142 | <listitem> | ||
| 143 | <para><ulink | ||
| 144 | url="http://www.crashcourse.ca/wiki/index.php/Poky_Variable_Glossary">http://www.crashcourse.ca/wiki/index.php/Poky_Variable_Glossary</ulink> | ||
| 145 | - Explanation of some Yocto/Poky variables used in the build | ||
| 146 | configuration files.</para> | ||
| 147 | </listitem> | ||
| 148 | </itemizedlist> | ||
| 9 | </section> | 149 | </section> |
| 10 | </chapter> \ No newline at end of file | 150 | </chapter> \ No newline at end of file |
