From eed014249e14a79f26fdbbe24bd7ea4a3b9e83c2 Mon Sep 17 00:00:00 2001 From: Adrian Mangeac Date: Wed, 23 Oct 2019 21:51:34 +0200 Subject: Update according to review comments Change-Id: Ied9626223001932486f0725afed0f7d36c27b5f7 Signed-off-by: Adrian Mangeac --- .../doc/using_eclipse.xml | 51 ++++++++--------- .../doc/using_enea_linux.xml | 66 +++++++++++----------- 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 @@
Installing Oxygen Eclipse IDE - - - Yocto Eclipse Plugins are discontinued and the last Yocto version that provides them - is Yocto 2.5. - - + + Yocto Eclipse Plugins are discontinued, with the last Yocto version that provides them + being Yocto 2.5. + - Installation and configuration of the Eclipse Oxygen IDE should be done following the - Yocto + Configuration of the Eclipse Oxygen IDE should be done following the + Yocto Project Application Development and the Extensible Software Development Kit - (eSDK) documentation, Chapter 5. - Instructions provided in Chapter 5.2.1.1 are no longer valid, so, please follow the - steps below in order to install Eclipse Oxygen: + (eSDK) documentation. + + The installation instructions provided in Chapter 5.2.1.1 are no longer valid, please follow the + steps below in order to install Eclipse Oxygen: - Download Eclipse Oxygen archive from this link, by selecting the correct architecture:Download the - https://www.eclipse.org/downloads/packages/release/oxygen/2/eclipse-ide-cc-developers - (i.e. eclipse-cpp-oxygen-2-linux-gtk-x86_64.tar.gz). + Eclipse Oxygen archive. Make sure to select the correct architecture in the link provided, + e.g. eclipse-cpp-oxygen-2-linux-gtk-x86_64.tar.gz. - Decompress the Eclipse archive in your home directory and start the IDE: + Unzip the Eclipse archive in your home directory and start the IDE: $ tar xf ~/Downloads/eclipse-cpp-oxygen-2-linux-gtk-x86_64.tar.gz -C ~/ - $ ~/eclipse/eclipse + $ ~/eclipse/eclipse @@ -43,21 +42,17 @@ Oxygen. - - - - For compatibility reasons, only use JDK version 1.8 on your host. + + For compatibility reasons, only use JDK version 1.8 on your host. -
- Installing Yocto Plug-ins + Installing Yocto Plugins - To install the Yocto Plugins in Eclipse, follow the instructions in - To install the Yocto Plugins in Eclipse, follow the instructions in the Yocto Project Application Development and the Extensible Software Development Kit (eSDK) 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

- More details on how to configure the cross-compiler can be found + Details on how to configure the cross-compiler can be found in the Yocto - Project Application Development and the Extensible Software Development Kit - (eSDK). + Project Application Development and Extensible Software Development Kit + (eSDK) Manual. 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

Browse button and select a location on the remote target. You need an active TCF connection to the target for the Browse button to - work (see Chapter Setting up a TCF + work (see chapter Setting up a TCF Connection from Eclipse). Note that you need to specify the path including the filename. 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 @@
Building Enea Linux - Enea Linux is made available as sources, this allows for of building - various Enea Linux artifacts and is detailed in the following - sections: + Enea Linux is made available as sources, allowing for the building of + various Enea Linux artifacts detailed in the following sections.
Building the images @@ -34,11 +33,11 @@ $ repo sync Source the build environment - $ cd poky + $ cd poky $ TEMPLATECONF=meta-el-standard/conf/template.<machine> \ . ./oe-init-build-env <build_dir> - Sourcing the build environment is needed everytime a new shell + Sourcing the build environment is needed every time 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. @@ -54,7 +53,7 @@ $ TEMPLATECONF=meta-el-standard/conf/template.<machine> \ - Build Enea Linux image + Build an Enea Linux image # You have already initiated the build environment and are in the <build_dir> $ bitbake <enea-image-name> @@ -73,8 +72,8 @@ $ cd <build_dir>/tmp/deploy/images/<target>/ # Here are the build b booting a physical target, according to how the build environment was set up before running bitbake. - Depending on the number of processors and cores, the amount or - RAM, the speed of your Internet connection and other factors, the + Depending on the number of processors and cores, the amount of + RAM, the speed of your internet connection and other factors, the build process can take several hours the first time you run it. Subsequent builds run much faster since parts of the build are cached. @@ -95,11 +94,11 @@ $ cd <build_dir>/tmp/deploy/images/<target>/ # Here are the build b Building the SDK If you want to rebuild a cross-compilation toolchain to be used by - in application development, use the following steps: + in application development, do the following: - Clone Enea Linux sources using Repo tool. Please refer to + Clone Enea Linux sources using the Repo tool. Please refer to for more details on how to do this. @@ -126,13 +125,13 @@ $ TEMPLATECONF=meta-el-standard/conf/template.<machine> \ The build directory may reside on an NFS mount, but the TMPDIR (<build_dir>/tmp) may not. Either build - all on a local disk, or update TMPDIR in conf/local.conf to point - to a local disk. + all on a local disk, or update TMPDIR in + conf/local.conf to point to a local disk. - Build Enea Linux SDK + Build an Enea Linux SDK # You have already initiated the build environment and are in the <build_dir> $ bitbake <enea-image-name> -c populate_sdk_ext @@ -144,13 +143,13 @@ $ cd <build_dir>/tmp/deploy/sdk/ # Here is the SDK installer script - Generated SDK installer script is by default saved in + The generated SDK installer script is by default saved in <build_dir>/tmp/deploy/sdk, where <build_dir> by default is the current working directory. - Depending on the number of processors and cores, the amount or - RAM, the speed of your Internet connection and other factors, the + Depending on the number of processors and cores, the amount of + RAM, the speed of your internet connection and other factors, the build process can take several hours the first time you run it. Subsequent builds run much faster since parts of the build are cached. @@ -170,13 +169,13 @@ $ cd <build_dir>/tmp/deploy/sdk/ # Here is the SDK installer script - Enea Linux supports multiple booting methods so those will be + Enea Linux supports multiple booting methods which will be described in the following sections.
Booting via PXE - Below you find an example of how to boot Enea Linux in a target + Below is an example of how to boot Enea Linux on a target supporting PXE. The PXE boot is handled by the target BIOS. This requires the setup of DHCP, TFTP and NFS servers on the host. @@ -190,31 +189,31 @@ $ cd <build_dir>/tmp/deploy/sdk/ # Here is the SDK installer script - Host name + Host name. MAC hardware ethernet address (also available in the TFTP - configuration) + configuration). - IP address, (assuming a fixed IP address is used) + IP address (assuming a fixed IP address is used). The TFTP server shall be defined as - next-server + next-server. The relative path in the TFTP server to the PXE file - pxelinux.0 + pxelinux.0. The NFS server IP address and the path to the rootfs on the - NFS server, defined as option root-path + NFS server, defined as option root-path. @@ -228,8 +227,8 @@ $ cd <build_dir>/tmp/deploy/sdk/ # Here is the SDK installer script - For the TFTP server, the TFTP path to the target's pxelinux.0 file - is given in the DHCP Configuration. Examples of files included in the + For the TFTP server, the TFTP path to the target's pxelinux.0 + file is given in the DHCP Configuration. Examples of files included in the TFTP subdirectory indicated by the DHCP configuration are: pxelinux.0 @@ -284,8 +283,7 @@ label device01 Populate the root file system in the NFS directory by - unpacking - enea-image-standard-intel-corei7-64.tar.gz + unpacking enea-image-standard-intel-corei7-64.tar.gz found at <build_dir>/tmp/deploy/images/<target>/. @@ -379,28 +377,28 @@ U-Boot> booti 0x01000000 0x03000000 0x02000000 - Run Win32DiskImager.exe + Run Win32DiskImager.exe. - Select the drive of your SD card + Select the drive of your SD card. Select the image - enea-image-standard-raspberrypi3-64.rpi-sdimg + enea-image-standard-raspberrypi3-64.rpi-sdimg. - Click "Write" and wait for the write to complete + Click "Write" and wait for the write to complete. - Exit the imager and eject the SD Card + Exit the imager and eject the SD Card. - Plug the card into your Raspberry Pi + Plug the card into your Raspberry Pi. -- cgit v1.2.3-54-g00ecf