summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAdrian Mangeac <Adrian.Mangeac@enea.com>2019-10-23 21:51:34 +0200
committerAdrian Mangeac <Adrian.Mangeac@enea.com>2019-10-23 22:04:14 +0200
commiteed014249e14a79f26fdbbe24bd7ea4a3b9e83c2 (patch)
tree2e7c7c412eb65b354baf49d4c0c62ae16bd0e117
parent1bcaf44cb47ba6315465846ad3834a888cf56b85 (diff)
downloadel_releases-standard-eed014249e14a79f26fdbbe24bd7ea4a3b9e83c2.tar.gz
Update according to review comments
Change-Id: Ied9626223001932486f0725afed0f7d36c27b5f7 Signed-off-by: Adrian Mangeac <Adrian.Mangeac@enea.com>
-rw-r--r--doc/book-enea-linux-user-guide/doc/using_eclipse.xml51
-rw-r--r--doc/book-enea-linux-user-guide/doc/using_enea_linux.xml66
2 files changed, 55 insertions, 62 deletions
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 077935a..a8b2934 100644
--- a/doc/book-enea-linux-user-guide/doc/using_eclipse.xml
+++ b/doc/book-enea-linux-user-guide/doc/using_eclipse.xml
@@ -5,35 +5,34 @@
5 <section id="install_eclipse"> 5 <section id="install_eclipse">
6 <title>Installing Oxygen Eclipse IDE</title> 6 <title>Installing Oxygen Eclipse IDE</title>
7 7
8 <para> 8 <note>
9 <note> 9 <para>Yocto Eclipse Plugins are discontinued, with the last Yocto version that provides them
10 Yocto Eclipse Plugins are discontinued and the last Yocto version that provides them 10 being Yocto 2.5.</para>
11 is Yocto 2.5. 11 </note>
12 </note>
13 </para>
14 12
15 <para>Installation and configuration of the Eclipse Oxygen IDE should be done following the 13 <para>Configuration of the Eclipse Oxygen IDE should be done following the
16 <ulink url="http://www.yoctoproject.org/docs/2.5/sdk-manual/sdk-manual.html#adt-eclipse">Yocto 14 <ulink url="http://www.yoctoproject.org/docs/2.5/sdk-manual/sdk-manual.html#adt-eclipse">Yocto
17 Project Application Development and the Extensible Software Development Kit 15 Project Application Development and the Extensible Software Development Kit
18 (eSDK)</ulink> documentation, Chapter 5. 16 (eSDK)</ulink> documentation.</para>
19 Instructions provided in Chapter 5.2.1.1 are no longer valid, so, please follow the 17
20 steps below in order to install Eclipse Oxygen: 18 <para>The installation instructions provided in Chapter 5.2.1.1 are no longer valid, please follow the
19 steps below in order to install Eclipse Oxygen:
21 </para> 20 </para>
22 21
23 <orderedlist> 22 <orderedlist>
24 <listitem> 23 <listitem>
25 <para>Download Eclipse Oxygen archive from this link, by selecting the correct architecture:<ulink 24 <para>Download the <ulink
26 url="https://www.eclipse.org/downloads/packages/release/oxygen/2/eclipse-ide-cc-developers"> 25 url="https://www.eclipse.org/downloads/packages/release/oxygen/2/eclipse-ide-cc-developers">
27 https://www.eclipse.org/downloads/packages/release/oxygen/2/eclipse-ide-cc-developers</ulink> 26 Eclipse Oxygen archive</ulink>. Make sure to select the correct architecture in the link provided,
28 (i.e. <filename>eclipse-cpp-oxygen-2-linux-gtk-x86_64.tar.gz</filename>). 27 e.g. <filename>eclipse-cpp-oxygen-2-linux-gtk-x86_64.tar.gz</filename>.
29 </para> 28 </para>
30 </listitem> 29 </listitem>
31 30
32 <listitem> 31 <listitem>
33 <para>Decompress the Eclipse archive in your home directory and start the IDE: 32 <para>Unzip the Eclipse archive in your home directory and start the IDE:
34 <programlisting> 33 <programlisting>
35 $ tar xf ~/Downloads/eclipse-cpp-oxygen-2-linux-gtk-x86_64.tar.gz -C ~/ 34 $ tar xf ~/Downloads/eclipse-cpp-oxygen-2-linux-gtk-x86_64.tar.gz -C ~/
36 $ ~/eclipse/eclipse 35 $ ~/eclipse/eclipse
37 </programlisting> 36 </programlisting>
38 </para> 37 </para>
39 </listitem> 38 </listitem>
@@ -43,21 +42,17 @@
43 Oxygen. 42 Oxygen.
44 </para> 43 </para>
45 </listitem> 44 </listitem>
46
47 </orderedlist> 45 </orderedlist>
48 46
49 <para> 47 <note>
50 <note> 48 <para>For compatibility reasons, only use JDK version 1.8 on your host.</para>
51 For compatibility reasons, only use JDK version 1.8 on your host.
52 </note> 49 </note>
53 </para>
54 </section> 50 </section>
55 51
56 <section id="install_yocto"> 52 <section id="install_yocto">
57 <title>Installing Yocto Plug-ins</title> 53 <title>Installing Yocto Plugins</title>
58 54
59 <para>To install the Yocto Plugins in Eclipse, follow the instructions in 55 <para>To install the Yocto Plugins in Eclipse, follow the instructions in the <ulink
60 <ulink
61 url="http://www.yoctoproject.org/docs/2.5/sdk-manual/sdk-manual.html#oxygen-setting-up-the-eclipse-ide"> 56 url="http://www.yoctoproject.org/docs/2.5/sdk-manual/sdk-manual.html#oxygen-setting-up-the-eclipse-ide">
62 Yocto Project Application Development and the Extensible Software Development Kit 57 Yocto Project Application Development and the Extensible Software Development Kit
63 (eSDK)</ulink> documentation, Chapter 5.2.1.3. 58 (eSDK)</ulink> documentation, Chapter 5.2.1.3.
@@ -217,11 +212,11 @@ root 329 0.0 0.2 1864824 2600 ? Ssl 12:47 0:08 /usr/sbin/tcf-agent -d -L- -l0</p
217 </orderedlist> 212 </orderedlist>
218 213
219 <tip> 214 <tip>
220 <para>More details on how to configure the cross-compiler can be found 215 <para>Details on how to configure the cross-compiler can be found
221 in the <ulink 216 in the <ulink
222 url="http://www.yoctoproject.org/docs/2.5/sdk-manual/sdk-manual.html">Yocto 217 url="http://www.yoctoproject.org/docs/2.5/sdk-manual/sdk-manual.html">Yocto
223 Project Application Development and the Extensible Software Development Kit 218 Project Application Development and Extensible Software Development Kit
224 (eSDK)</ulink>. 219 (eSDK) Manual</ulink>.
225 </para> 220 </para>
226 221
227 <para>There is also a good cheat sheet available in Eclipse, under 222 <para>There is also a good cheat sheet available in Eclipse, under
@@ -672,7 +667,7 @@ root 329 0.0 0.2 1864824 2600 ? Ssl 12:47 0:08 /usr/sbin/tcf-agent -d -L- -l0</p
672 role="bold">Browse</emphasis> button and select a location on 667 role="bold">Browse</emphasis> button and select a location on
673 the remote target. You need an active TCF connection to the 668 the remote target. You need an active TCF connection to the
674 target for the <emphasis role="bold">Browse</emphasis> button to 669 target for the <emphasis role="bold">Browse</emphasis> button to
675 work (see Chapter <emphasis role="bold">Setting up a TCF 670 work (see chapter <emphasis role="bold">Setting up a TCF
676 Connection from Eclipse</emphasis>). Note that you need to 671 Connection from Eclipse</emphasis>). Note that you need to
677 specify the path including the filename.</para> 672 specify the path including the filename.</para>
678 </listitem> 673 </listitem>
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 fbd6d28..44dcf0c 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,8 @@
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, this allows for of building 8 <para>Enea Linux is made available as sources, allowing for the building of
9 various Enea Linux artifacts and is detailed in the following 9 various Enea Linux artifacts detailed in the following sections.</para>
10 sections:</para>
11 10
12 <section id="build_images"> 11 <section id="build_images">
13 <title>Building the images</title> 12 <title>Building the images</title>
@@ -34,11 +33,11 @@ $ repo sync</programlisting>
34 <step> 33 <step>
35 <para>Source the build environment</para> 34 <para>Source the build environment</para>
36 35
37 <programlisting>$ cd poky 36 <programlisting>$ cd poky
38$ TEMPLATECONF=meta-el-standard/conf/template.&lt;machine&gt; \ 37$ TEMPLATECONF=meta-el-standard/conf/template.&lt;machine&gt; \
39. ./oe-init-build-env &lt;build_dir&gt;</programlisting> 38. ./oe-init-build-env &lt;build_dir&gt;</programlisting>
40 39
41 <para>Sourcing the build environment is needed everytime a new shell 40 <para>Sourcing the build environment is needed every time a new shell
42 is used. However, sourcing using the <literal>TEMPLATECONF</literal> 41 is used. However, sourcing using the <literal>TEMPLATECONF</literal>
43 is only needed the first time around. After the first time, it is 42 is only needed the first time around. After the first time, it is
44 enough to source the build directory created before.</para> 43 enough to source the build directory created before.</para>
@@ -54,7 +53,7 @@ $ TEMPLATECONF=meta-el-standard/conf/template.&lt;machine&gt; \
54 </step> 53 </step>
55 54
56 <step> 55 <step>
57 <para>Build Enea Linux image</para> 56 <para>Build an Enea Linux image</para>
58 57
59 <programlisting># You have already initiated the build environment and are in the &lt;build_dir&gt; 58 <programlisting># You have already initiated the build environment and are in the &lt;build_dir&gt;
60$ bitbake &lt;enea-image-name&gt; 59$ bitbake &lt;enea-image-name&gt;
@@ -73,8 +72,8 @@ $ cd &lt;build_dir&gt;/tmp/deploy/images/&lt;target&gt;/ # Here are the build b
73 booting a physical target, according to how the build environment 72 booting a physical target, according to how the build environment
74 was set up before running bitbake.</para> 73 was set up before running bitbake.</para>
75 74
76 <para>Depending on the number of processors and cores, the amount or 75 <para>Depending on the number of processors and cores, the amount of
77 RAM, the speed of your Internet connection and other factors, the 76 RAM, the speed of your internet connection and other factors, the
78 build process can take several hours the first time you run it. 77 build process can take several hours the first time you run it.
79 Subsequent builds run much faster since parts of the build are 78 Subsequent builds run much faster since parts of the build are
80 cached.</para> 79 cached.</para>
@@ -95,11 +94,11 @@ $ cd &lt;build_dir&gt;/tmp/deploy/images/&lt;target&gt;/ # Here are the build b
95 <title>Building the SDK</title> 94 <title>Building the SDK</title>
96 95
97 <para>If you want to rebuild a cross-compilation toolchain to be used by 96 <para>If you want to rebuild a cross-compilation toolchain to be used by
98 in application development, use the following steps:</para> 97 in application development, do the following:</para>
99 98
100 <procedure> 99 <procedure>
101 <step> 100 <step>
102 <para>Clone Enea Linux sources using Repo tool. Please refer to 101 <para>Clone Enea Linux sources using the Repo tool. Please refer to
103 <xref linkend="getting_sources" /> for more details on how to do 102 <xref linkend="getting_sources" /> for more details on how to do
104 this.</para> 103 this.</para>
105 104
@@ -126,13 +125,13 @@ $ TEMPLATECONF=meta-el-standard/conf/template.&lt;machine&gt; \
126 <para>The build directory may reside on an NFS mount, but the 125 <para>The build directory may reside on an NFS mount, but the
127 <literal>TMPDIR</literal> 126 <literal>TMPDIR</literal>
128 (<literal>&lt;build_dir&gt;/tmp</literal>) may not. Either build 127 (<literal>&lt;build_dir&gt;/tmp</literal>) may not. Either build
129 all on a local disk, or update TMPDIR in conf/local.conf to point 128 all on a local disk, or update <literal>TMPDIR</literal> in
130 to a local disk.</para> 129 <literal>conf/local.conf</literal> to point to a local disk.</para>
131 </note> 130 </note>
132 </step> 131 </step>
133 132
134 <step> 133 <step>
135 <para>Build Enea Linux SDK</para> 134 <para>Build an Enea Linux SDK</para>
136 135
137 <programlisting># You have already initiated the build environment and are in the &lt;build_dir&gt; 136 <programlisting># You have already initiated the build environment and are in the &lt;build_dir&gt;
138$ bitbake &lt;enea-image-name&gt; -c populate_sdk_ext 137$ bitbake &lt;enea-image-name&gt; -c populate_sdk_ext
@@ -144,13 +143,13 @@ $ cd &lt;build_dir&gt;/tmp/deploy/sdk/ # Here is the SDK installer script</prog
144 long, you need to move your build to obtain a shorter path.</para> 143 long, you need to move your build to obtain a shorter path.</para>
145 </note> 144 </note>
146 145
147 <para>Generated SDK installer script is by default saved in 146 <para>The generated SDK installer script is by default saved in
148 <literal>&lt;build_dir&gt;/tmp/deploy/sdk</literal>, where 147 <literal>&lt;build_dir&gt;/tmp/deploy/sdk</literal>, where
149 <literal>&lt;build_dir&gt;</literal> by default is the current 148 <literal>&lt;build_dir&gt;</literal> by default is the current
150 working directory.</para> 149 working directory.</para>
151 150
152 <para>Depending on the number of processors and cores, the amount or 151 <para>Depending on the number of processors and cores, the amount of
153 RAM, the speed of your Internet connection and other factors, the 152 RAM, the speed of your internet connection and other factors, the
154 build process can take several hours the first time you run it. 153 build process can take several hours the first time you run it.
155 Subsequent builds run much faster since parts of the build are 154 Subsequent builds run much faster since parts of the build are
156 cached.</para> 155 cached.</para>
@@ -170,13 +169,13 @@ $ cd &lt;build_dir&gt;/tmp/deploy/sdk/ # Here is the SDK installer script</prog
170 the artifacts availalbe, you may proceed to booting Enea Linux on 169 the artifacts availalbe, you may proceed to booting Enea Linux on
171 target.</para> 170 target.</para>
172 171
173 <para>Enea Linux supports multiple booting methods so those will be 172 <para>Enea Linux supports multiple booting methods which will be
174 described in the following sections.</para> 173 described in the following sections.</para>
175 174
176 <section id="enea-linux-x86-pxe"> 175 <section id="enea-linux-x86-pxe">
177 <title>Booting via PXE</title> 176 <title>Booting via PXE</title>
178 177
179 <para>Below you find an example of how to boot Enea Linux in a target 178 <para>Below is an example of how to boot Enea Linux on a target
180 supporting PXE. The PXE boot is handled by the target BIOS.</para> 179 supporting PXE. The PXE boot is handled by the target BIOS.</para>
181 180
182 <para>This requires the setup of DHCP, TFTP and NFS servers on the host. 181 <para>This requires the setup of DHCP, TFTP and NFS servers on the host.
@@ -190,31 +189,31 @@ $ cd &lt;build_dir&gt;/tmp/deploy/sdk/ # Here is the SDK installer script</prog
190 189
191 <itemizedlist spacing="compact"> 190 <itemizedlist spacing="compact">
192 <listitem> 191 <listitem>
193 <para>Host name</para> 192 <para>Host name.</para>
194 </listitem> 193 </listitem>
195 194
196 <listitem> 195 <listitem>
197 <para>MAC hardware ethernet address (also available in the TFTP 196 <para>MAC hardware ethernet address (also available in the TFTP
198 configuration)</para> 197 configuration).</para>
199 </listitem> 198 </listitem>
200 199
201 <listitem> 200 <listitem>
202 <para>IP address, (assuming a fixed IP address is used)</para> 201 <para>IP address (assuming a fixed IP address is used).</para>
203 </listitem> 202 </listitem>
204 203
205 <listitem> 204 <listitem>
206 <para>The TFTP server shall be defined as 205 <para>The TFTP server shall be defined as
207 <literal>next-server</literal></para> 206 <literal>next-server</literal>.</para>
208 </listitem> 207 </listitem>
209 208
210 <listitem> 209 <listitem>
211 <para>The relative path in the TFTP server to the PXE file 210 <para>The relative path in the TFTP server to the PXE file
212 <filename><literal>pxelinux.0</literal></filename></para> 211 <filename>pxelinux.0</filename>.</para>
213 </listitem> 212 </listitem>
214 213
215 <listitem> 214 <listitem>
216 <para>The NFS server IP address and the path to the rootfs on the 215 <para>The NFS server IP address and the path to the rootfs on the
217 NFS server, defined as <literal>option root-path</literal></para> 216 NFS server, defined as <literal>option root-path</literal>.</para>
218 </listitem> 217 </listitem>
219 </itemizedlist> 218 </itemizedlist>
220 219
@@ -228,8 +227,8 @@ $ cd &lt;build_dir&gt;/tmp/deploy/sdk/ # Here is the SDK installer script</prog
228 option root-path "192.168.2.20:/export/intel-corei7-64_rootfs"; 227 option root-path "192.168.2.20:/export/intel-corei7-64_rootfs";
229}</programlisting> 228}</programlisting>
230 229
231 <para>For the TFTP server, the TFTP path to the target's pxelinux.0 file 230 <para>For the TFTP server, the TFTP path to the target's <filename>pxelinux.0</filename>
232 is given in the DHCP Configuration. Examples of files included in the 231 file is given in the DHCP Configuration. Examples of files included in the
233 TFTP subdirectory indicated by the DHCP configuration are:</para> 232 TFTP subdirectory indicated by the DHCP configuration are:</para>
234 233
235 <programlisting>pxelinux.0 234 <programlisting>pxelinux.0
@@ -284,8 +283,7 @@ label device01
284 283
285 <listitem> 284 <listitem>
286 <para>Populate the root file system in the NFS directory by 285 <para>Populate the root file system in the NFS directory by
287 unpacking 286 unpacking <filename>enea-image-standard-intel-corei7-64.tar.gz</filename>
288 <filename>enea-image-standard-intel-corei7-64.tar.gz</filename>
289 found at 287 found at
290 <filename>&lt;build_dir&gt;/tmp/deploy/images/&lt;target&gt;/</filename>.</para> 288 <filename>&lt;build_dir&gt;/tmp/deploy/images/&lt;target&gt;/</filename>.</para>
291 </listitem> 289 </listitem>
@@ -379,28 +377,28 @@ U-Boot&gt; booti 0x01000000 0x03000000 0x02000000</programlisting>
379 </listitem> 377 </listitem>
380 378
381 <listitem> 379 <listitem>
382 <para>Run <filename>Win32DiskImager.exe</filename></para> 380 <para>Run <filename>Win32DiskImager.exe</filename>.</para>
383 </listitem> 381 </listitem>
384 382
385 <listitem> 383 <listitem>
386 <para>Select the drive of your SD card</para> 384 <para>Select the drive of your SD card.</para>
387 </listitem> 385 </listitem>
388 386
389 <listitem> 387 <listitem>
390 <para>Select the image 388 <para>Select the image
391 <filename><filename>enea-image-standard-raspberrypi3-64.rpi-sdimg</filename></filename></para> 389 <filename>enea-image-standard-raspberrypi3-64.rpi-sdimg</filename>.</para>
392 </listitem> 390 </listitem>
393 391
394 <listitem> 392 <listitem>
395 <para>Click "Write" and wait for the write to complete</para> 393 <para>Click "Write" and wait for the write to complete.</para>
396 </listitem> 394 </listitem>
397 395
398 <listitem> 396 <listitem>
399 <para>Exit the imager and eject the SD Card</para> 397 <para>Exit the imager and eject the SD Card.</para>
400 </listitem> 398 </listitem>
401 399
402 <listitem> 400 <listitem>
403 <para>Plug the card into your Raspberry Pi</para> 401 <para>Plug the card into your Raspberry Pi.</para>
404 </listitem> 402 </listitem>
405 </orderedlist> 403 </orderedlist>
406 404