summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMiruna Paun <Miruna.Paun@enea.com>2018-05-24 12:38:58 +0200
committerMiruna Paun <Miruna.Paun@enea.com>2018-05-24 12:38:58 +0200
commitaa362ce74c49da7ecd489f40843f8a0c7aa46d03 (patch)
treeba7ccb2cd5050852a90f863c3d7ef6508674fecb
parente9d286982ad56577e3cd9c2b545c867baafbd13e (diff)
downloadel_releases-standard-aa362ce74c49da7ecd489f40843f8a0c7aa46d03.tar.gz
Updated the user's guide and rel notes with olinks and minor edits.
Signed-off-by: Miruna Paun <Miruna.Paun@enea.com>
-rw-r--r--doc/book-enea-linux-release-info/doc/about_release.xml61
-rw-r--r--doc/book-enea-linux-release-info/doc/eltf_params_updated.xml2
-rw-r--r--doc/book-enea-linux-release-info/doc/known_bugs_and_limitations.xml18
-rw-r--r--doc/book-enea-linux-release-info/doc/main_changes.xml17
-rw-r--r--doc/book-enea-linux-user-guide/doc/preface.xml2
-rw-r--r--doc/book-enea-linux-user-guide/doc/using_enea_linux.xml20
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 @@
15 xpointer="element(Yocto_NAME/1)" />.<remark>INFO <emphasis 15 xpointer="element(Yocto_NAME/1)" />.<remark>INFO <emphasis
16 role="bold">eltf_params_updated.xml</emphasis> contains many parameters in 16 role="bold">eltf_params_updated.xml</emphasis> contains many parameters in
17 the book, also in the open source books, and MUST be created FROM <emphasis 17 the book, also in the open source books, and MUST be created FROM <emphasis
18 role="bold">eltf_params_template.xml</emphasis>. The parameters are 18 role="bold">eltf_params_template.xml</emphasis>. </remark></para>
19 automatically used in the books, via xi:include statements, similar to how 19
20 parameters from pardoc-distro.xml are included in the book. Read the file 20 <para><remark>The parameters are automatically used in the books, via
21 <emphasis role="bold">eltf_params_updated_template_how_to_use.txt</emphasis> 21 xi:include statements, similar to how parameters from pardoc-distro.xml are
22 for important details about formats and how to do! The idea is that ELTF 22 included in the book. Read the file <emphasis
23 will auto-create/update it.</remark></para> 23 role="bold">eltf_params_updated_template_how_to_use.txt</emphasis> for
24 important details about formats and how to do! The idea is that ELTF will
25 auto-create/update it.</remark></para>
24 26
25 <section id="relinfo-provided-contents"> 27 <section id="relinfo-provided-contents">
26 <title>Provided Contents</title> 28 <title>Provided Contents</title>
27 29
28 <para>The current release contains along with other items, documentation, 30 <para>The current release contains documentation, prebuilt kernels and
29 pre-built kernels and images, a bootloader and an SDK. The directories 31 images, a bootloader and an SDK. The directories structure is detailed
30 structure is detailed below:</para> 32 below:</para>
31 33
32 <programlisting>-- Documentation/ 34 <programlisting>-- Documentation/
33 /* Enea Linux 7 documentation */ 35 /* Enea Linux 7 documentation */
@@ -76,14 +78,16 @@
76 <section id="relinfo-supported-host-environment"> 78 <section id="relinfo-supported-host-environment">
77 <title>Supported Host Environment</title> 79 <title>Supported Host Environment</title>
78 80
79 <para>Ubuntu 16.04 LTS, 64-bit<remark>Hardcoded now in this XML file. 81 <para>The following environments have been validated as host environments
80 Might be moved to the parameter file later.</remark><remark>INFO Below is 82 for this release of Enea Linux: <emphasis role="bold">Ubuntu 16.04 LTS,
81 a complete section with ID "eltf-target-tables-section" included from 83 64-bit</emphasis>.</para>
82 elft_params_updated.xml. It contains a variable number of target tables 84
83 and the section title should be "Supported Targets with Parameters". It 85 <para><remark>INFO Below is a complete section with ID
84 has have a short sentence about what it is in the beginning. The subtitles 86 "eltf-target-tables-section" included from elft_params_updated.xml. It
85 shall have the directory name of the target in the 87 contains a variable number of target tables and the section title should
86 manifest.</remark></para> 88 be "Supported Targets with Parameters". It has have a short sentence about
89 what it is in the beginning. The subtitles shall have the directory name
90 of the target in the manifest.</remark></para>
87 </section> 91 </section>
88 92
89 <xi:include href="eltf_params_updated.xml" 93 <xi:include href="eltf_params_updated.xml"
@@ -126,9 +130,13 @@
126 <title>Provided Toolchains (SDK)</title> 130 <title>Provided Toolchains (SDK)</title>
127 131
128 <para>The SDK contains toolchains supporting cross-compilation of 132 <para>The SDK contains toolchains supporting cross-compilation of
129 applications for the targets on an aarch64 host. See the <trademark 133 applications for the targets on an aarch64 host. For information on how to
130 class="registered">Enea</trademark> Linux User's Guide for information on 134 build and install a toolchain, see the chapter <olink
131 how to build and install a toolchain.</para> 135 targetdoc="book_enea_linux_user_guide_standard"
136 targetptr="using_enealinux">Using Enea Linux, in the <xi:include
137 href="../../s_docbuild/olinkdb/pardoc-names.xml"
138 xmlns:xi="http://www.w3.org/2001/XInclude"
139 xpointer="element(book_enea_linux_user_guide_standard/1)" /></olink>.</para>
132 </section> 140 </section>
133 141
134 <section id="relinfo-documentation"> 142 <section id="relinfo-documentation">
@@ -143,13 +151,13 @@
143 </listitem> 151 </listitem>
144 152
145 <listitem> 153 <listitem>
146 <para><trademark class="registered">Enea</trademark> Linux User's 154 <para><olink targetdoc="book_enea_linux_user_guide_standard"
147 Guide</para> 155 targetptr="book_enea_linux_user_guide_standard"><trademark
156 class="registered">Enea</trademark> Linux User's Guide</olink></para>
148 </listitem> 157 </listitem>
149 158
150 <listitem> 159 <listitem>
151 <para><olink security="" 160 <para><olink targetdoc="book_enea_linux_open_source_standard"
152 targetdoc="book_enea_linux_open_source_standard"
153 targetptr="book_enea_linux_open_source_standard"><trademark 161 targetptr="book_enea_linux_open_source_standard"><trademark
154 class="registered">Enea</trademark> Linux Open Source 162 class="registered">Enea</trademark> Linux Open Source
155 Report</olink></para> 163 Report</olink></para>
@@ -166,9 +174,8 @@
166 </listitem> 174 </listitem>
167 175
168 <listitem> 176 <listitem>
169 <para><trademark class="registered">Enea</trademark> Linux Real-Time 177 <para><trademark class="registered">Enea</trademark><ulink
170 Guide can be read at <ulink 178 url="http://linuxrealtime.org"> Linux Real-Time Guide</ulink></para>
171 url="http://linuxrealtime.org">http://linuxrealtime.org</ulink>.</para>
172 </listitem> 179 </listitem>
173 </itemizedlist> 180 </itemizedlist>
174 </section> 181 </section>
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</programlisting></para>
88 </section> 88 </section>
89 89
90 <section id="eltf-target-tables-section"> 90 <section id="eltf-target-tables-section">
91 <title>Supported Targets with Parameters</title> 91 <title>Supported Reference Boards with Parameters</title>
92 92
93 <para>The section(s) below describe the target(s) supported in this Enea 93 <para>The section(s) below describe the target(s) supported in this Enea
94 Linux release.</para> 94 Linux release.</para>
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 @@
5 <title>Known Problems in this Release</title> 5 <title>Known Problems in this Release</title>
6 6
7 <para>Open source projects are continuously working on correcting reported 7 <para>Open source projects are continuously working on correcting reported
8 problems. Corrections to bugs detected by Enea are submitted upstream, and 8 problems. Fixes and workarounds to bugs detected by Enea are submitted
9 the corrections are included in Enea Linux regardless of when they will be 9 upstream, and included in Enea Linux regardless of when they will be
10 included by the open source project. Remaining issues are listed 10 included by the open source project. Issues that still affect the current
11 below.<remark>INFO: The <emphasis role="bold">Release-Specific 11 release are listed below.<remark>INFO: The <emphasis
12 Problems</emphasis> section further down is generated from JIRA with 12 role="bold">Release-Specific Problems</emphasis> section further down is
13 gen_known_issues.py, but that script is HARDCODED with affectedversion "Enea 13 generated from JIRA with gen_known_issues.py, but that script is HARDCODED
14 Linux 6" and needs to be adapted when a release info for another EL version 14 with affectedversion "Enea Linux 6" and needs to be adapted when a release
15 changes.</remark></para> 15 info for another EL version changes.</remark></para>
16 16
17 <section id="bugs-limitations-yocto"> 17 <section id="bugs-limitations-yocto">
18 <title>Yocto Project </title> 18 <title>Yocto Project</title>
19 19
20 <para>The Yocto Project community uses a <ulink 20 <para>The Yocto Project community uses a <ulink
21 url="https://bugzilla.yoctoproject.org">Bugzilla database</ulink> to track 21 url="https://bugzilla.yoctoproject.org">Bugzilla database</ulink> 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 @@
5 <title>Main Changes</title> 5 <title>Main Changes</title>
6 6
7 <para>This chapter describes the major changes and additions made to this 7 <para>This chapter describes the major changes and additions made to this
8 release of Enea Linux, as compared to the previous Enea Linux 6.<remark>INFO 8 release of Enea Linux.<remark>INFO Just now Hardcoded previous release
9 Just now Hardcoded previous release string in this 9 string in this paragraph.</remark><remark>The list of changed packages
10 paragraph.</remark><remark>The list of changed packages further down is 10 further down is created from the open source book licenses.xml by the script
11 created from the open source book licenses.xml by the script gen_pkgdiff.py 11 gen_pkgdiff.py by comparing with an older open source licenses.xml,
12 by comparing with an older open source licenses.xml, depending on the 12 depending on the parameter "prev_baseline" in pardoc-distro.xml, e.g. a tag
13 parameter "prev_baseline" in pardoc-distro.xml, e.g. a tag like "EL5". This 13 like "EL5". This parameter needs to be changed to a new TAG when a release
14 parameter needs to be changed to a new TAG when a release info for another 14 info for another EL version is created. It must correspond to the release
15 EL version is created. It must correspond to the release string 15 string above.</remark></para>
16 above.</remark></para>
17 16
18 <section id="relinfo-changes-other"> 17 <section id="relinfo-changes-other">
19 <title>New Functionality/Enhancements</title> 18 <title>New Functionality/Enhancements</title>
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 @@
3 <title>Preface</title> 3 <title>Preface</title>
4 4
5 <section id="guide_purpose"> 5 <section id="guide_purpose">
6 <title>The Purpose of This Guide</title> 6 <title>The Purpose of this Guide</title>
7 7
8 <para>This guide is intended for all Enea Linux developers who want to 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 9 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 @@
5 <section id="build_enealinux"> 5 <section id="build_enealinux">
6 <title>Building Enea Linux</title> 6 <title>Building Enea Linux</title>
7 7
8 <para>Enea Linux is made available as sources as well. This allows 8 <para>Enea Linux is made available as sources, this allows for of building
9 building various Enea Linux artifacts and this is detailed in the 9 various Enea Linux artifacts and is detailed in the following
10 following sections:</para> 10 sections:</para>
11 11
12 <section id="build_images"> 12 <section id="build_images">
13 <title>Building the images</title> 13 <title>Building the images</title>
@@ -17,8 +17,7 @@
17 <procedure> 17 <procedure>
18 <step> 18 <step>
19 <para>Clone Enea Linux sources using Repo tool. Please refer to 19 <para>Clone Enea Linux sources using Repo tool. Please refer to
20 chapter 3.2 in the current documebt for more details on how to do 20 <xref linkend="getting_sources" /> for more details.</para>
21 this.</para>
22 21
23 <programlisting>$ mkdir enea-linux 22 <programlisting>$ mkdir enea-linux
24$ cd enea-linux 23$ cd enea-linux
@@ -35,13 +34,10 @@ $ repo sync</programlisting>
35$ TEMPLATECONF=meta-el-standard/conf/template.&lt;machine&gt; \ 34$ TEMPLATECONF=meta-el-standard/conf/template.&lt;machine&gt; \
36. ./oe-init-build-env &lt;build_dir&gt;</programlisting> 35. ./oe-init-build-env &lt;build_dir&gt;</programlisting>
37 36
38 <note> 37 <para>Sourcing the build environment is needed everytime a new shell
39 <para>Sourcing the build environment is needed everytime a new 38 is used. However, sourcing using the <literal>TEMPLATECONF</literal>
40 shell is used. However, sourcing using the 39 is only needed the first time around. After the first time, it is
41 <literal>TEMPLATECONF</literal> is only needed the first time 40 enough to source the build directory created before.</para>
42 around. Afterwards it is enough to source the build directory
43 created before.</para>
44 </note>
45 41
46 <note> 42 <note>
47 <para>The build directory may reside on an NFS mount, but the 43 <para>The build directory may reside on an NFS mount, but the