From aa362ce74c49da7ecd489f40843f8a0c7aa46d03 Mon Sep 17 00:00:00 2001 From: Miruna Paun Date: Thu, 24 May 2018 12:38:58 +0200 Subject: Updated the user's guide and rel notes with olinks and minor edits. Signed-off-by: Miruna Paun --- .../doc/about_release.xml | 61 ++++++++++++---------- .../doc/eltf_params_updated.xml | 2 +- .../doc/known_bugs_and_limitations.xml | 18 +++---- .../doc/main_changes.xml | 17 +++--- doc/book-enea-linux-user-guide/doc/preface.xml | 2 +- .../doc/using_enea_linux.xml | 20 +++---- 6 files changed, 61 insertions(+), 59 deletions(-) diff --git a/doc/book-enea-linux-release-info/doc/about_release.xml b/doc/book-enea-linux-release-info/doc/about_release.xml index 5004f66..0ed0730 100644 --- a/doc/book-enea-linux-release-info/doc/about_release.xml +++ b/doc/book-enea-linux-release-info/doc/about_release.xml @@ -15,19 +15,21 @@ xpointer="element(Yocto_NAME/1)" />.INFO eltf_params_updated.xml contains many parameters in the book, also in the open source books, and MUST be created FROM eltf_params_template.xml. The parameters are - automatically used in the books, via xi:include statements, similar to how - parameters from pardoc-distro.xml are included in the book. Read the file - eltf_params_updated_template_how_to_use.txt - for important details about formats and how to do! The idea is that ELTF - will auto-create/update it. + role="bold">eltf_params_template.xml. + + The parameters are automatically used in the books, via + xi:include statements, similar to how parameters from pardoc-distro.xml are + included in the book. Read the file eltf_params_updated_template_how_to_use.txt for + important details about formats and how to do! The idea is that ELTF will + auto-create/update it.
Provided Contents - The current release contains along with other items, documentation, - pre-built kernels and images, a bootloader and an SDK. The directories - structure is detailed below: + The current release contains documentation, prebuilt kernels and + images, a bootloader and an SDK. The directories structure is detailed + below: -- Documentation/ /* Enea Linux 7 documentation */ @@ -76,14 +78,16 @@
Supported Host Environment - Ubuntu 16.04 LTS, 64-bitHardcoded now in this XML file. - Might be moved to the parameter file later.INFO Below is - a complete section with ID "eltf-target-tables-section" included from - elft_params_updated.xml. It contains a variable number of target tables - and the section title should be "Supported Targets with Parameters". It - has have a short sentence about what it is in the beginning. The subtitles - shall have the directory name of the target in the - manifest. + The following environments have been validated as host environments + for this release of Enea Linux: Ubuntu 16.04 LTS, + 64-bit. + + INFO Below is a complete section with ID + "eltf-target-tables-section" included from elft_params_updated.xml. It + contains a variable number of target tables and the section title should + be "Supported Targets with Parameters". It has have a short sentence about + what it is in the beginning. The subtitles shall have the directory name + of the target in the manifest.
Provided Toolchains (SDK) The SDK contains toolchains supporting cross-compilation of - applications for the targets on an aarch64 host. See the Enea Linux User's Guide for information on - how to build and install a toolchain. + applications for the targets on an aarch64 host. For information on how to + build and install a toolchain, see the chapter Using Enea Linux, in the .
@@ -143,13 +151,13 @@ - Enea Linux User's - Guide + Enea Linux User's Guide - Enea Linux Open Source Report @@ -166,9 +174,8 @@ - Enea Linux Real-Time - Guide can be read at http://linuxrealtime.org. + Enea Linux Real-Time Guide
diff --git a/doc/book-enea-linux-release-info/doc/eltf_params_updated.xml b/doc/book-enea-linux-release-info/doc/eltf_params_updated.xml index 35db2a3..0aa2e06 100644 --- a/doc/book-enea-linux-release-info/doc/eltf_params_updated.xml +++ b/doc/book-enea-linux-release-info/doc/eltf_params_updated.xml @@ -88,7 +88,7 @@ repo sync
- Supported Targets with Parameters + Supported Reference Boards with Parameters The section(s) below describe the target(s) supported in this Enea Linux release. diff --git a/doc/book-enea-linux-release-info/doc/known_bugs_and_limitations.xml b/doc/book-enea-linux-release-info/doc/known_bugs_and_limitations.xml index 5c0c594..6fafb8d 100644 --- a/doc/book-enea-linux-release-info/doc/known_bugs_and_limitations.xml +++ b/doc/book-enea-linux-release-info/doc/known_bugs_and_limitations.xml @@ -5,17 +5,17 @@ Known Problems in this Release Open source projects are continuously working on correcting reported - problems. Corrections to bugs detected by Enea are submitted upstream, and - the corrections are included in Enea Linux regardless of when they will be - included by the open source project. Remaining issues are listed - below.INFO: The Release-Specific - Problems section further down is generated from JIRA with - gen_known_issues.py, but that script is HARDCODED with affectedversion "Enea - Linux 6" and needs to be adapted when a release info for another EL version - changes. + problems. Fixes and workarounds to bugs detected by Enea are submitted + upstream, and included in Enea Linux regardless of when they will be + included by the open source project. Issues that still affect the current + release are listed below.INFO: The Release-Specific Problems section further down is + generated from JIRA with gen_known_issues.py, but that script is HARDCODED + with affectedversion "Enea Linux 6" and needs to be adapted when a release + info for another EL version changes.
- Yocto Project + Yocto Project The Yocto Project community uses a Bugzilla database to track diff --git a/doc/book-enea-linux-release-info/doc/main_changes.xml b/doc/book-enea-linux-release-info/doc/main_changes.xml index c0e3006..9f036db 100644 --- a/doc/book-enea-linux-release-info/doc/main_changes.xml +++ b/doc/book-enea-linux-release-info/doc/main_changes.xml @@ -5,15 +5,14 @@ Main Changes This chapter describes the major changes and additions made to this - release of Enea Linux, as compared to the previous Enea Linux 6.INFO - Just now Hardcoded previous release string in this - paragraph.The list of changed packages further down is - created from the open source book licenses.xml by the script gen_pkgdiff.py - by comparing with an older open source licenses.xml, depending on the - parameter "prev_baseline" in pardoc-distro.xml, e.g. a tag like "EL5". This - parameter needs to be changed to a new TAG when a release info for another - EL version is created. It must correspond to the release string - above. + release of Enea Linux.INFO Just now Hardcoded previous release + string in this paragraph.The list of changed packages + further down is created from the open source book licenses.xml by the script + gen_pkgdiff.py by comparing with an older open source licenses.xml, + depending on the parameter "prev_baseline" in pardoc-distro.xml, e.g. a tag + like "EL5". This parameter needs to be changed to a new TAG when a release + info for another EL version is created. It must correspond to the release + string above.
New Functionality/Enhancements diff --git a/doc/book-enea-linux-user-guide/doc/preface.xml b/doc/book-enea-linux-user-guide/doc/preface.xml index b1de43c..1752ff5 100644 --- a/doc/book-enea-linux-user-guide/doc/preface.xml +++ b/doc/book-enea-linux-user-guide/doc/preface.xml @@ -3,7 +3,7 @@ Preface
- The Purpose of This Guide + 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 diff --git a/doc/book-enea-linux-user-guide/doc/using_enea_linux.xml b/doc/book-enea-linux-user-guide/doc/using_enea_linux.xml index 3997038..a0b7d2c 100644 --- a/doc/book-enea-linux-user-guide/doc/using_enea_linux.xml +++ b/doc/book-enea-linux-user-guide/doc/using_enea_linux.xml @@ -5,9 +5,9 @@
Building Enea Linux - Enea Linux is made available as sources as well. This allows - building various Enea Linux artifacts and this is detailed in the - following sections: + Enea Linux is made available as sources, this allows for of building + various Enea Linux artifacts and is detailed in the following + sections:
Building the images @@ -17,8 +17,7 @@ Clone Enea Linux sources using Repo tool. Please refer to - chapter 3.2 in the current documebt for more details on how to do - this. + for more details. $ mkdir enea-linux $ cd enea-linux @@ -35,13 +34,10 @@ $ repo sync $ TEMPLATECONF=meta-el-standard/conf/template.<machine> \ . ./oe-init-build-env <build_dir> - - Sourcing the build environment is needed everytime a new - shell is used. However, sourcing using the - TEMPLATECONF is only needed the first time - around. Afterwards it is enough to source the build directory - created before. - + Sourcing the build environment is needed everytime a new shell + is used. However, sourcing using the TEMPLATECONF + is only needed the first time around. After the first time, it is + enough to source the build directory created before. The build directory may reside on an NFS mount, but the -- cgit v1.2.3-54-g00ecf