From a6d4e68bf121a3d0e1e626f4d288ad2b594947e2 Mon Sep 17 00:00:00 2001 From: Sona Sarmadi Date: Tue, 28 Aug 2018 07:11:55 +0200 Subject: First draft of doc copied from standard profile -updated rel-info -updated UG -added new chapterdoc for RT: Real-Time in Enea Linux Change-Id: If8cec0e29d1d6aa4a09507881d815af13dd68ee2 Signed-off-by: Sona Sarmadi --- doc/book-enea-linux-user-guide/doc/preface.xml | 157 +++++++++++++++++++++++++ 1 file changed, 157 insertions(+) create mode 100644 doc/book-enea-linux-user-guide/doc/preface.xml (limited to 'doc/book-enea-linux-user-guide/doc/preface.xml') 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 @@ + + + Preface + +
+ The Purpose of this Guide + + 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. + + + Always read the README files and the Release Information before + this User's Guide. + + + The recommended order of operations for developers are: + + + + Receive information from Enea and read the initial documentation + online. + + + + Update the development host with the needed packages, then + download and install Enea Linux. + + + + Download and install the Cross-Compilation Toolchain. + + + + Start developing your own Enea Linux applications or building + your own Enea Linux images. + + + + 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 + training courses. + + 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. + + 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: + + + + + + Enea Linux Release Information + + 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. + + + + README files for the distribution + + 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. + + + + Enea Linux User's Guide + + The generic manual for developers who build Linux kernels + for embedded systems or use prebuilt Linux kernels. + + + + Enea Linux Open Source Report + + The distribution specific list of software packages with + corresponding Open Source Licenses, that are included in the Enea + Linux distribution. + + + + Enea Linux Security Report + + The release specific document listing the CVEs affecting + this distribuition. + + + +
+ + See also the following generic documentation related to the Yocto + project, which actually is based on OpenEmbedded. + + + + https://www.yoctoproject.org/documentation/archived + - Yocto project documentation. Search for the Yocto version included + in your Enea Linux distribution. + + + + + + http://docs.openembedded.org + - OpenEmbedded documentation, useful since Yocto is based on + OpenEmbedded. + + + + + + https://wiki.yoctoproject.org/wiki + - Yocto Wiki, useful information for Yocto users + + + + + + https://wiki.yoctoproject.org/wiki/Ptest + - Ptest wiki. Ptest was initiated by Enea, for building, installing + and running package test suites + + + + + + http://www.crashcourse.ca/wiki/index.php/Poky_Variable_Glossary + - Explanation of some Yocto/Poky variables used in the build + configuration files. + + +
+ \ No newline at end of file -- cgit v1.2.3-54-g00ecf