diff --git a/documentation/dev-manual/dev-manual-model.xml b/documentation/dev-manual/dev-manual-model.xml index 255a814981..fd0d156494 100644 --- a/documentation/dev-manual/dev-manual-model.xml +++ b/documentation/dev-manual/dev-manual-model.xml @@ -668,8 +668,8 @@ The Eclipse IDE is a popular development environment and it fully supports development using the Yocto Project. - This release of the Yocto Project supports both the Kepler - and Juno versions of the Eclipse IDE. + This release of the Yocto Project supports both the Luna + and Kepler versions of the Eclipse IDE. Thus, the following information provides setup information for both versions. @@ -722,19 +722,20 @@ Installing the Eclipse IDE - It is recommended that you have the Kepler 4.3.2 version of - the Eclipse IDE installed on your development system. - However, if you currently have the Juno 4.2 version + It is recommended that you have the Luna SR2 (4.4.2) + version of the Eclipse IDE installed on your development + system. + However, if you currently have the Kepler 4.3.2 version installed and you do not want to upgrade the IDE, you can - configure Juno to work with the Yocto Project. + configure Kepler to work with the Yocto Project. - If you do not have the Kepler 4.3.2 Eclipse IDE installed, - you can find the tarball at + If you do not have the Luna SR2 (4.4.2) Eclipse IDE + installed, you can find the tarball at . - From that site, choose the Eclipse Standard 4.3.2 version - particular to your development host. + From that site, choose the appropriate download from the + "Eclipse IDE for C/C++ Developers". This version contains the Eclipse Platform, the Java Development Tools (JDT), and the Plug-in Development Environment. @@ -748,7 +749,7 @@ using the default name eclipse: $ cd ~ - $ $ tar -xzvf ~/Downloads/eclipse-standard-kepler-SR2-linux-gtk-x86_64.tar.gz + $ tar -xzvf ~/Downloads/eclipse-cpp-luna-SR2-linux-gtk-x86_64.tar.gz @@ -771,24 +772,37 @@ select "Install New Software" from the "Help" pull-down menu. Select - Kepler - &ECLIPSE_KEPLER_URL; + Luna - &ECLIPSE_LUNA_URL; from the "Work with:" pull-down menu. - For Juno, select - Juno - &ECLIPSE_JUNO_URL; + For Kepler, select + Kepler - &ECLIPSE_KEPLER_URL; Expand the box next to "Linux Tools" and select the - LTTng - Linux Tracing Toolkit - boxes. + Linux Tools LTTng Tracer Control, + Linux Tools LTTng Userspace Analysis, + and + LTTng Kernel Analysis boxes. + If these selections do not appear in the list, + that means the items are already installed. + + For Kepler, select + LTTng - Linux Tracing Toolkit + box. + + Expand the box next to "Mobile and - Device Development" and select the following boxes: + Device Development" and select the following boxes. + Again, if any of the following items are not + available for selection, that means the items are + already installed: C/C++ Remote Launch (Requires RSE Remote System Explorer) Remote System Explorer End-user Runtime Remote System Explorer User Actions - Target Management Terminal + Target Management Terminal (Core SDK) TCF Remote System Explorer add-in TCF Target Explorer @@ -796,7 +810,10 @@ Languages" and select the C/C++ Autotools Support and C/C++ Development Tools - boxes. + boxes. + For Luna, these items do not appear on the list + as they are already installed. + Complete the installation and restart the Eclipse IDE. @@ -828,12 +845,12 @@ Click "Add..." in the "Work with:" area. Enter - &ECLIPSE_DL_PLUGIN_URL;/kepler + &ECLIPSE_DL_PLUGIN_URL;/luna in the URL field and provide a meaningful name in the "Name" field. - If you are using Juno, use - &ECLIPSE_DL_PLUGIN_URL;/juno + If you are using Kepler, use + &ECLIPSE_DL_PLUGIN_URL;/kepler in the URL field. Click "OK" to have the entry added @@ -851,6 +868,11 @@ Complete the remaining software installation steps and then restart the Eclipse IDE to finish the installation of the plug-in. + + You can click "OK" when prompted about + installing software that contains unsigned + content. + @@ -870,17 +892,25 @@ Use the Oracle JDK. If you don't have that, go to - and download the appropriate tarball - for your development system and + and download the latest appropriate + Java SE Development Kit tarball for + your development system and extract it into your home directory. In the shell you are going to do your work, export the location of - the Oracle Java as follows: + the Oracle Java. + The previous step creates a new folder + for the extracted software. + You need to use the following + export command + and provide the specific location: - export PATH=~/jdk1.7.0_40/bin:$PATH - - + export PATH=~/extracted_jdk_location/bin:$PATH + + + + In the same shell, create a Git repository with: @@ -888,53 +918,69 @@ $ git clone git://git.yoctoproject.org/eclipse-poky - Be sure to checkout the specific - plug-in branch. - For example, if you are using Kepler, do the + Be sure to checkout the correct + tag. + For example, if you are using Luna, do the following: - $ git checkout kepler + $ git checkout luna/yocto-1.8 + This puts you in a detached HEAD state, which + is fine since you are only going to be building + and not developing. + + If you are building kepler, checkout the + kepler/yocto-1.8 + branch. + Change to the scripts directory within the Git repository: $ cd scripts - + + Set up the local build environment by running the setup script: $ ./setup.sh - + + When the script finishes execution, it prompts you with instructions on how to run the build.sh script, which is also in the scripts - directory of - the Git repository created earlier. + directory of the Git repository created + earlier. - Run the build.sh script - as directed. - Be sure to provide the name of the Git branch - along with the Yocto Project release you are - using. + Run the build.sh + script as directed. + Be sure to provide the tag name, documentation + branch, and a release name. Here is an example that uses the - &DISTRO_NAME; branch: + luna/yocto-1.8 tag, the + master documentation + branch, and + &DISTRO_NAME; for the + release name: - $ ECLIPSE_HOME=/home/scottrif/eclipse-poky/scripts/eclipse ./build.sh &DISTRO_NAME; &DISTRO_NAME; + $ ECLIPSE_HOME=/home/scottrif/eclipse-poky/scripts/eclipse ./build.sh luna/yocto-1.8 master &DISTRO_NAME; 2>&1 | tee -a build.log After running the script, the file org.yocto.sdk-release-date-archive.zip - is in the current directory. + is in the current directory. + If necessary, start the Eclipse IDE and be sure you are in the Workbench. - Select "Install New Software" from the "Help" pull-down menu. + Select "Install New Software" from + the "Help" pull-down menu. Click "Add". Provide anything you want in the - "Name" field. + "Name" field. + Click "Archive" and browse to the ZIP file you built in step eight. This ZIP file should not be "unzipped", and must @@ -942,13 +988,24 @@ created by running the build.sh script. - Click through the "Okay" buttons. + Click the "OK" button. + + Check the boxes that appear in + the installation window to install the + Yocto Project ADT Plug-in, + Yocto Project Bitbake Commander Plug-in, + and the + Yocto Project Documentation plug-in. + + Finish the installation by clicking + through the appropriate buttons. + You can click "OK" when prompted about + installing software that contains unsigned + content. - Check the boxes - in the installation window and complete - the installation. Restart the Eclipse IDE if - necessary. + necessary. + @@ -977,9 +1034,10 @@ Eclipse IDE: Choose "Preferences" from the - "Windows" menu to display the Preferences Dialog. + "Window" menu to display the Preferences Dialog. - Click "Yocto Project ADT". + Click "Yocto Project ADT" to display + the configuration screen. @@ -1055,10 +1113,13 @@ the target hardware resides. If you used the ADT Installer script and accepted the default installation directory, - then the location is - /opt/poky/&DISTRO;/sysroots. + then the location in your home directory + in a folder named + test-yocto/target_arch. Additionally, when you use the ADT Installer - script, the same location is used for the QEMU + script, the + /opt/poky/&DISTRO;/sysroots + location is used for the QEMU user-space tools and the NFS boot process. If you used either of the other two @@ -1183,7 +1244,7 @@ Double click C Project to create the project. - Expand Yocto Project ADT Project. + Expand Yocto Project ADT Autotools Project. Select Hello World ANSI C Autotools Project. This is an Autotools-based project based on a Yocto @@ -1236,14 +1297,9 @@ Make your configurations for the project and click "OK". - If you are running the Juno version of Eclipse, you can - skip down to the next section where you build the - project. - If you are not working with Juno, you need to reconfigure the - project as described in the next step. - Select "Reconfigure Project" from the - "Project" menu. + Right-click in the navigation pane and + select "Reconfigure Project" from the pop-up menu. This selection reconfigures the project by running autogen.sh in the workspace for your project. @@ -1264,9 +1320,7 @@ Building the Project - To build the project in Juno, right click on the project in - the navigator pane and select "Build Project". - If you are not running Juno, select "Build Project" from the + To build the project select "Build Project" from the "Project" menu. The console should update and you can note the cross-compiler you are using. @@ -1290,7 +1344,8 @@ Your image should appear as a selectable menu item. Select your image from the menu to launch - the emulator in a new window. + the emulator in a new window. + If needed, enter your host root password in the shell window at the prompt. This sets up a Tap 0 connection @@ -1299,9 +1354,10 @@ Wait for QEMU to launch. Once QEMU launches, you can begin operating within that environment. - For example, you could determine the IP Address - for the user-space NFS by using the - ifconfig command. + One useful task at this point would be to determine the + IP Address for the user-space NFS by using the + ifconfig command. + @@ -1345,7 +1401,7 @@ Use the drop-down menu now in the "Connection" field and pick the IP Address you entered. - Click "Run" to bring up a login screen + Click "Debug" to bring up a login screen and login. Accept the debug perspective. @@ -1362,7 +1418,7 @@ These tools are aids in developing and debugging applications and images. You can run these user-space tools from within the Eclipse - IDE through the "YoctoTools" menu. + IDE through the "YoctoProjectTools" menu. @@ -1403,7 +1459,7 @@ installed by default on the core-image-sato-sdk image. - Lttng2.0 ust trace import: + Lttng2.0 trace import: Selecting this tool transfers the remote target's Lttng tracing data back to the local host machine and uses the Lttng Eclipse plug-in @@ -1420,13 +1476,15 @@ This tool no longer has any upstream support. Before you use the - Lttng2.0 ust trace import tool, + Lttng2.0 trace import tool, you need to setup the Lttng Eclipse plug-in and create a Tracing project. Do the following: Select "Open Perspective" from the - "Window" menu and then select "Tracing". + "Window" menu and then select "Other..." to + bring up a menu of other perspectives. + Choose "Tracing". Click "OK" to change the Eclipse perspective into the Tracing perspective. @@ -1435,11 +1493,14 @@ selecting "Project" from the "File -> New" menu. Choose "Tracing Project" from the - "Tracing" menu. + "Tracing" menu and click "Next". + + Provide a name for your tracing + project and click "Finish". Generate your tracing data on the remote target. - Select "Lttng2.0 ust trace import" + Select "Lttng2.0 trace import" from the "Yocto Project Tools" menu to start the data import process. Specify your remote connection name. @@ -1487,129 +1548,33 @@ section in the Yocto Project Profiling and Tracing Manual. + SystemTap: + Systemtap is a tool that lets you create and reuse + scripts to examine the activities of a live Linux + system. + You can easily extract, filter, and summarize data + that helps you diagnose complex performance or + functional problems. + For more information on setting up and using + SystemTap, see the + SystemTap Documentation. + + yocto-bsp: + The yocto-bsp tool lets you + quickly set up a Board Support Package (BSP) layer. + The tool requires a Metadata location, build location, + BSP name, BSP output location, and a kernel + architecture. + For more information on the + yocto-bsp tool outside of Eclipse, + see the + "Creating a new BSP Layer Using the yocto-bsp Script" + section in the Yocto Project Board Support Package + (BSP) Developer's Guide. + - -
- Customizing an Image Using a BitBake Commander Project and Hob - - - Within the Eclipse IDE, you can create a Yocto BitBake Commander - project, edit the Metadata, and - then use - Hob to build a customized image all within one IDE. - - -
- Creating the Yocto BitBake Commander Project - - - To create a Yocto BitBake Commander project, follow these - steps: - - Select "Other" from the - "Window -> Open Perspective" menu - and then choose "Bitbake Commander". - - Click "OK" to change the perspective to - Bitbake Commander. - Select "Project" from the "File -> New" - menu to create a new Yocto - Bitbake Commander project. - Choose "New Yocto Project" from the - "Yocto Project Bitbake Commander" menu and click - "Next". - Enter the Project Name and choose the - Project Location. - The Yocto project's Metadata files will be put under - the directory - project_location/project_name. - If that directory does not exist, you need to check - the "Clone from Yocto Git Repository" box, which - would execute a git clone - command to get the project's Metadata files. - - Do not specify your BitBake Commander project - location as your Eclipse workspace. - Doing so causes an error indicating that the - current project overlaps the location of - another project. - This error occurs even if no such project exits. - - Select Finish to - create the project. - - -
- -
- Editing the Metadata - - - After you create the Yocto Bitbake Commander project, you - can modify the Metadata - files by opening them in the project. - When editing recipe files (.bb files), - you can view BitBake variable values and information by - hovering the mouse pointer over the variable name and - waiting a few seconds. - - - - To edit the Metadata, follow these steps: - - Select your Yocto Bitbake Commander - project. - Select "BitBake Recipe" from the - "File -> New -> Yocto BitBake Commander" menu - to open a new recipe wizard. - Point to your source by filling in the - "SRC_URL" field. - For example, you can add a recipe to your - Source Directory - by defining "SRC_URL" as follows: - - ftp://ftp.gnu.org/gnu/m4/m4-1.4.9.tar.gz - - Click "Populate" to calculate the - archive md5, sha256, license checksum values and to - auto-generate the recipe filename. - Fill in the "Description" field. - - Be sure values for all required - fields exist. - Click "Finish". - - -
- -
- Building and Customizing the Image Using Hob - - - To build and customize the image using Hob from within the - Eclipse IDE, follow these steps: - - Select your Yocto Bitbake Commander - project. - Select "Launch Hob" from the "Project" - menu. - Enter the - Build Directory - where you want to put your final images. - - Click "OK" to launch Hob. - - Use Hob to customize and build your own - images. - For information on Hob, see the - Hob Project Page - on the Yocto Project website. - - -
-