summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorSona Sarmadi <sona.sarmadi@enea.com>2018-10-02 05:43:39 +0000
committerMartin Borg <martin.borg@enea.com>2018-10-08 14:22:10 +0200
commitaccff3502121a15eb08a73a22f5212b1029d64f1 (patch)
tree8890b89454780b19441983855365ec6d76b80fb0 /doc
parent3b640ba3cad4966a532a2d451b6531f7404c7f33 (diff)
downloadel_releases-rt-accff3502121a15eb08a73a22f5212b1029d64f1.tar.gz
UG: fix review comments
1: Add a link to Real time documentation /wiki page from table 1.1 (page 4) 2: Check the portal for Enea Linux content and sdk dir (page 9 sec 4.1) 3: change the tag Enea_Linux_8.0 to Enea_Linux_RT_8.0 (page 11 & 12) 4: Remove references to raspberrypi3 (page 32 sec 7.5) 5: Rename ”sdk” to ”esdk” in getting_enea_linux Change-Id: Ia1e12770998d5e036b3d7562f433d142af48a2e8 Signed-off-by: Sona Sarmadi <sona.sarmadi@enea.com>
Diffstat (limited to 'doc')
-rw-r--r--doc/book-enea-linux-user-guide/doc/getting_enea_linux.xml4
-rw-r--r--doc/book-enea-linux-user-guide/doc/preface.xml13
-rw-r--r--doc/book-enea-linux-user-guide/doc/real_time_in_enea_linux.xml7
-rw-r--r--doc/book-enea-linux-user-guide/doc/using_eclipse.xml8
-rw-r--r--doc/book-enea-linux-user-guide/doc/using_enea_linux.xml21
5 files changed, 35 insertions, 18 deletions
diff --git a/doc/book-enea-linux-user-guide/doc/getting_enea_linux.xml b/doc/book-enea-linux-user-guide/doc/getting_enea_linux.xml
index e58726e..bb29464 100644
--- a/doc/book-enea-linux-user-guide/doc/getting_enea_linux.xml
+++ b/doc/book-enea-linux-user-guide/doc/getting_enea_linux.xml
@@ -34,8 +34,8 @@
34 </listitem> 34 </listitem>
35 35
36 <listitem> 36 <listitem>
37 <para><emphasis>sdk</emphasis> directory - this directory includes the 37 <para><emphasis>esdk</emphasis> directory - this directory includes the
38 installer for the SDK.</para> 38 installer for the Extensible SDK.</para>
39 </listitem> 39 </listitem>
40 40
41 <listitem> 41 <listitem>
diff --git a/doc/book-enea-linux-user-guide/doc/preface.xml b/doc/book-enea-linux-user-guide/doc/preface.xml
index 1752ff5..ff06753 100644
--- a/doc/book-enea-linux-user-guide/doc/preface.xml
+++ b/doc/book-enea-linux-user-guide/doc/preface.xml
@@ -103,6 +103,17 @@
103 <entry>The release specific document listing the CVEs affecting 103 <entry>The release specific document listing the CVEs affecting
104 this distribuition.</entry> 104 this distribuition.</entry>
105 </row> 105 </row>
106
107 <row>
108 <entry><ulink type=""
109 url="https://linux.enea.com/4.0/documentation/html/book-enea-linux-realtime-guide/">Enea
110 Linux Real Time documentation</ulink> and <ulink
111 url="https://rt.wiki.kernel.org/index.php/Main_Page">Real-Time
112 Linux Wiki</ulink></entry>
113
114 <entry>Enea Linux Real-Time Guide and Real-Time Linux Wiki
115 page.</entry>
116 </row>
106 </tbody> 117 </tbody>
107 </tgroup> 118 </tgroup>
108 </table> 119 </table>
@@ -154,4 +165,4 @@
154 </listitem> 165 </listitem>
155 </itemizedlist> 166 </itemizedlist>
156 </section> 167 </section>
157</chapter> \ No newline at end of file 168</chapter>
diff --git a/doc/book-enea-linux-user-guide/doc/real_time_in_enea_linux.xml b/doc/book-enea-linux-user-guide/doc/real_time_in_enea_linux.xml
index 8d7b8d4..fa60f93 100644
--- a/doc/book-enea-linux-user-guide/doc/real_time_in_enea_linux.xml
+++ b/doc/book-enea-linux-user-guide/doc/real_time_in_enea_linux.xml
@@ -11,7 +11,12 @@
11 <title>Addtional packages provided in the RT profile</title> 11 <title>Addtional packages provided in the RT profile</title>
12 12
13 <tgroup cols="3"> 13 <tgroup cols="3">
14 <colspec align="center" /> 14# <colspec align="center" />
15 <colspec colwidth="1*" />
16
17 <colspec colwidth="5*" />
18
19 <colspec colwidth="2*" />
15 20
16 <thead> 21 <thead>
17 <row> 22 <row>
diff --git a/doc/book-enea-linux-user-guide/doc/using_eclipse.xml b/doc/book-enea-linux-user-guide/doc/using_eclipse.xml
index f6c7759..7484db4 100644
--- a/doc/book-enea-linux-user-guide/doc/using_eclipse.xml
+++ b/doc/book-enea-linux-user-guide/doc/using_eclipse.xml
@@ -900,7 +900,7 @@ root 329 0.0 0.2 1864824 2600 ? Ssl 12:47 0:08 /usr/sbin/tcf-agent -d -L- -l0</p
900 <para>In this section you learn to set up Eclipse for KGDB<indexterm> 900 <para>In this section you learn to set up Eclipse for KGDB<indexterm>
901 <primary>KGDB</primary> 901 <primary>KGDB</primary>
902 </indexterm> kernel debugging over the serial port, with examples for 902 </indexterm> kernel debugging over the serial port, with examples for
903 the <literal>raspberrypi3</literal> target. This is only given as an 903 the <literal>intel-corei7-64</literal> target. This is only given as an
904 example, your Enea Linux distribution may contain other targets. The 904 example, your Enea Linux distribution may contain other targets. The
905 corresponding instruction for debugging outside Eclipse is available in 905 corresponding instruction for debugging outside Eclipse is available in
906 Debugging the Linux Kernel (KGDB) from Command Line.<remark>LATER: Merge 906 Debugging the Linux Kernel (KGDB) from Command Line.<remark>LATER: Merge
@@ -934,7 +934,7 @@ root 329 0.0 0.2 1864824 2600 ? Ssl 12:47 0:08 /usr/sbin/tcf-agent -d -L- -l0</p
934 you can find it in the rootfs under the <literal>/boot</literal> 934 you can find it in the rootfs under the <literal>/boot</literal>
935 folder. If you build your own kernel using bitbake, it should be 935 folder. If you build your own kernel using bitbake, it should be
936 available in your build folder. Located in, for example: 936 available in your build folder. Located in, for example:
937 <filename><filename>tmp/work/raspberrypi3_64-enea-linux/linux-raspberrypi/1_4.9.59+gitAUTOINC+meta_machine-r0/image/boot/vmlinux-4.9.59</filename></filename></para> 937 <filename><filename>tmp/work/corei7-64-intel-common-enea-linux/linux-intel-rt/4.14.59+gitAUTOINC+d64aec9793_6a0fa58d9e-r0/linux-corei7-64-intel-common-preempt-rt-build/vmlinux</filename></filename></para>
938 </listitem> 938 </listitem>
939 939
940 <listitem> 940 <listitem>
@@ -1042,7 +1042,7 @@ root 329 0.0 0.2 1864824 2600 ? Ssl 12:47 0:08 /usr/sbin/tcf-agent -d -L- -l0</p
1042 <para>Browse to the location of the <emphasis role="bold">GDB 1042 <para>Browse to the location of the <emphasis role="bold">GDB
1043 binary</emphasis> installed by the cross-compilation toolchain 1043 binary</emphasis> installed by the cross-compilation toolchain
1044 installer, by default: 1044 installer, by default:
1045 <filename>&lt;extsdkdir&gt;/tmp/sysroots/x86_64-linux/usr/bin/&lt;arch&gt;-enea-linux/&lt;arch&gt;-enea-linux-gdb</filename>.</para> 1045 <filename>&lt;extsdkdir&gt;/tmp/sysroots/x86_64/usr/bin/&lt;arch&gt;-enea-linux/&lt;arch&gt;-enea-linux-gdb</filename>.</para>
1046 </listitem> 1046 </listitem>
1047 1047
1048 <listitem> 1048 <listitem>
@@ -1185,7 +1185,7 @@ root 329 0.0 0.2 1864824 2600 ? Ssl 12:47 0:08 /usr/sbin/tcf-agent -d -L- -l0</p
1185 cross-compilation toolchain, from your <emphasis 1185 cross-compilation toolchain, from your <emphasis
1186 role="bold">Sysroot Location</emphasis>. Example:</para> 1186 role="bold">Sysroot Location</emphasis>. Example:</para>
1187 1187
1188 <programlisting>$ &lt;extsdkdir&gt;/tmp/sysroots/x86_64-linux/usr/bin/\ 1188 <programlisting>$ &lt;extsdkdir&gt;/tmp/sysroots/x86_64/usr/bin/\
1189&lt;arch&gt;-enea-linux/&lt;arch&gt;-enea-linux-gdb</programlisting> 1189&lt;arch&gt;-enea-linux/&lt;arch&gt;-enea-linux-gdb</programlisting>
1190 1190
1191 <para>where <filename>&lt;sdkdir&gt;</filename> is e.g. 1191 <para>where <filename>&lt;sdkdir&gt;</filename> is e.g.
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 19ec877..9fde297 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
@@ -12,9 +12,11 @@
12 <section id="build_images"> 12 <section id="build_images">
13 <title>Building Real-Time images</title> 13 <title>Building Real-Time images</title>
14 14
15 <para>Real-Time images use the Intel RT kernel, no additional configuration is needed.</para> 15 <para>Real-Time images use the Intel RT kernel, no additional
16 configuration is needed.</para>
16 17
17 <para><emphasis role="bold">How to Build an Enea Linux RT image</emphasis></para> 18 <para><emphasis role="bold">How to Build an Enea Linux RT
19 image</emphasis></para>
18 20
19 <procedure> 21 <procedure>
20 <step> 22 <step>
@@ -29,14 +31,14 @@
29 <programlisting>$ mkdir enea-linux 31 <programlisting>$ mkdir enea-linux
30$ cd enea-linux 32$ cd enea-linux
31$ repo init -u git@git.enea.com:linux/manifests/el_manifests-rt.git \ 33$ repo init -u git@git.enea.com:linux/manifests/el_manifests-rt.git \
32 -b refs/tags/Enea_Linux_8.0 -m $MACHINE/default.xml 34 -b refs/tags/Enea_Linux_RT_8.0 -m $MACHINE/default.xml
33$ repo sync</programlisting> 35$ repo sync</programlisting>
34 </step> 36 </step>
35 37
36 <step> 38 <step>
37 <para>Source the build environment</para> 39 <para>Source the build environment</para>
38 40
39 <programlisting>$ cd poky 41 <programlisting>$ cd poky
40$ TEMPLATECONF=meta-el-rt/conf/template.&lt;machine&gt; \ 42$ TEMPLATECONF=meta-el-rt/conf/template.&lt;machine&gt; \
41. ./oe-init-build-env &lt;build_dir&gt;</programlisting> 43. ./oe-init-build-env &lt;build_dir&gt;</programlisting>
42 44
@@ -108,14 +110,14 @@ $ cd &lt;build_dir&gt;/tmp/deploy/images/&lt;target&gt;/ # Here are the build b
108 <programlisting>$ mkdir enea-linux 110 <programlisting>$ mkdir enea-linux
109$ cd enea-linux 111$ cd enea-linux
110$ repo init -u git@git.enea.com:linux/manifests/el_manifests-rt.git \ 112$ repo init -u git@git.enea.com:linux/manifests/el_manifests-rt.git \
111 -b refs/tags/Enea_Linux_8.0 -m $MACHINE/default.xml 113 -b refs/tags/Enea_Linux_RT_8.0 -m $MACHINE/default.xml
112$ repo sync</programlisting> 114$ repo sync</programlisting>
113 </step> 115 </step>
114 116
115 <step> 117 <step>
116 <para>Source the build environment</para> 118 <para>Source the build environment</para>
117 119
118 <programlisting>$ cd poky 120 <programlisting>$ cd poky
119$ TEMPLATECONF=meta-el-rt/conf/template.&lt;machine&gt; \ 121$ TEMPLATECONF=meta-el-rt/conf/template.&lt;machine&gt; \
120. ./oe-init-build-env &lt;build_dir&gt;</programlisting> 122. ./oe-init-build-env &lt;build_dir&gt;</programlisting>
121 123
@@ -441,11 +443,10 @@ BBLAYERS ?= " \
441 <title>Adding a Recipe</title> 443 <title>Adding a Recipe</title>
442 444
443 <para>Study the <ulink 445 <para>Study the <ulink
444 url="https://www.yoctoproject.org/docs/2.5/dev-manual/dev-manual.html#new-recipe-single-c-file-package-hello-world"><ulink
445 url="https://www.yoctoproject.org/docs/2.5/dev-manual/dev-manual.html#new-recipe-single-c-file-package-hello-world">Hello 446 url="https://www.yoctoproject.org/docs/2.5/dev-manual/dev-manual.html#new-recipe-single-c-file-package-hello-world">Hello
446 World recipe</ulink></ulink> in the Yocto Project Development Manual. If 447 World recipe</ulink> in the Yocto Project Development Manual. If needed
447 needed replace the example version (2.5) with the Yocto version in your 448 replace the example version (2.5) with the Yocto version in your Enea
448 Enea Linux distribution.</para> 449 Linux distribution.</para>
449 </section> 450 </section>
450 451
451 <section id="config_pkg_recipes"> 452 <section id="config_pkg_recipes">