diff options
| author | Scott Rifenbark <scott.m.rifenbark@intel.com> | 2013-09-19 13:16:53 -0700 |
|---|---|---|
| committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2013-09-22 12:20:49 +0100 |
| commit | f3455db0841e4d2cb94fb6d338e4b9ddc42c8bed (patch) | |
| tree | 4ad1182d5f2e207cc466fd2d648ab8fb7f5a4ec6 /documentation/dev-manual | |
| parent | 9fbaa9b9ec8e1295b51fdbbf42404b66c7557163 (diff) | |
| download | ast2050-yocto-poky-f3455db0841e4d2cb94fb6d338e4b9ddc42c8bed.zip ast2050-yocto-poky-f3455db0841e4d2cb94fb6d338e4b9ddc42c8bed.tar.gz | |
dev-manual: Misc formatting and setup for Kepler support
I went through the "Working Within Eclipse" section and set up
structure to add in the Kepler support and drop the Indigo
support. Along the way, I formatted the entire section to
hit within the 40-character limit exclusive of the links,
which always overrun.
(From yocto-docs rev: 762291589382f7ef71e77f8c92dae2371f3ae6e7)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/dev-manual')
| -rw-r--r-- | documentation/dev-manual/dev-manual-model.xml | 1089 |
1 files changed, 613 insertions, 476 deletions
diff --git a/documentation/dev-manual/dev-manual-model.xml b/documentation/dev-manual/dev-manual-model.xml index efa50b0..3474d05 100644 --- a/documentation/dev-manual/dev-manual-model.xml +++ b/documentation/dev-manual/dev-manual-model.xml @@ -131,7 +131,7 @@ <ulink url='&YOCTO_DOCS_BSP_URL;#creating-a-new-bsp-layer-using-the-yocto-bsp-script'><filename>yocto-bsp</filename></ulink> script</emphasis>: Layers are ideal for isolating and storing work for a given piece of hardware. - A layer is really just a location or area in which you place + A layer is really just a location or area in which you place the recipes and configurations for your BSP. In fact, a BSP is, in itself, a special type of layer. The simplest way to create a new BSP layer that is compliant with the @@ -165,7 +165,7 @@ Romley, sys940x, Sugar Bay, and tlk exist in their own separate layers within the larger <filename>meta-intel</filename> layer.</note> <para>When you set up a layer for a new BSP, you should follow a standard layout. - This layout is described in the + This layout is described in the "<ulink url='&YOCTO_DOCS_BSP_URL;#bsp-filelayout'>Example Filesystem Layout</ulink>" section of the Board Support Package (BSP) Development Guide. In the standard layout, you will notice a suggested structure for recipes and @@ -343,10 +343,10 @@ If you are working in the kernel all the time, you probably would want to set up your own local Git repository of the kernel tree. If you just need to make some patches to the kernel, you can access - temporary kernel source files that were extracted and used + temporary kernel source files that were extracted and used during a build. We will just talk about working with the temporary source code. - For more information on how to get kernel source code onto your + For more information on how to get kernel source code onto your host system, see the "<link linkend='local-kernel-files'>Yocto Project Kernel</link>" bulleted item earlier in the manual. @@ -411,7 +411,7 @@ "<link linkend='local-yp-release'>Yocto Project Release</link>" earlier in this manual. </para></listitem> <listitem><para><emphasis>Establish the temporary kernel source files</emphasis>: - Temporary kernel source files are kept in the + Temporary kernel source files are kept in the <link linkend='build-directory'>Build Directory</link> created by the OpenEmbedded build system when you run BitBake. @@ -474,7 +474,7 @@ Application development involves creating an application that you want to run on your target hardware, which is running a kernel image created using the OpenEmbedded build system. - The Yocto Project provides an + The Yocto Project provides an <ulink url='&YOCTO_DOCS_ADT_URL;#adt-intro-section'>Application Development Toolkit (ADT)</ulink> and stand-alone <ulink url='&YOCTO_DOCS_ADT_URL;#the-cross-development-toolchain'>cross-development toolchains</ulink> @@ -605,26 +605,29 @@ <title>Working Within Eclipse</title> <para> - The Eclipse IDE is a popular development environment and it fully supports - development using the Yocto Project. - <note>This release of the Yocto Project supports both the Juno and Indigo versions - of the Eclipse IDE. - Thus, the following information provides setup information for both versions. + The Eclipse IDE is a popular development environment and it fully + supports development using the Yocto Project. + <note> + This release of the Yocto Project supports both the Kepler + and Juno versions of the Eclipse IDE. + Thus, the following information provides setup information for + both versions. </note> </para> <para> - When you install and configure the Eclipse Yocto Project Plug-in into - the Eclipse IDE, you maximize your Yocto Project experience. - Installing and configuring the Plug-in results in an environment that - has extensions specifically designed to let you more easily develop software. - These extensions allow for cross-compilation, deployment, and execution of - your output into a QEMU emulation session as well as actual target - hardware. + When you install and configure the Eclipse Yocto Project Plug-in + into the Eclipse IDE, you maximize your Yocto Project experience. + Installing and configuring the Plug-in results in an environment + that has extensions specifically designed to let you more easily + develop software. + These extensions allow for cross-compilation, deployment, and + execution of your output into a QEMU emulation session as well as + actual target hardware. You can also perform cross-debugging and profiling. - The environment also supports a suite of tools that allows you to perform - remote profiling, tracing, collection of power data, collection of - latency data, and collection of performance data. + The environment also supports a suite of tools that allows you + to perform remote profiling, tracing, collection of power data, + collection of latency data, and collection of performance data. </para> <para> @@ -638,15 +641,20 @@ <para> To develop within the Eclipse IDE, you need to do the following: <orderedlist> - <listitem><para>Install the optimal version of the Eclipse IDE.</para></listitem> - <listitem><para>Configure the Eclipse IDE.</para></listitem> - <listitem><para>Install the Eclipse Yocto Plug-in.</para></listitem> - <listitem><para>Configure the Eclipse Yocto Plug-in.</para></listitem> + <listitem><para>Install the optimal version of the Eclipse + IDE.</para></listitem> + <listitem><para>Configure the Eclipse IDE. + </para></listitem> + <listitem><para>Install the Eclipse Yocto Plug-in. + </para></listitem> + <listitem><para>Configure the Eclipse Yocto Plug-in. + </para></listitem> </orderedlist> <note> - Do not install Eclipse from your distribution's package repository. - Be sure to install Eclipse from the official Eclipse download site as directed - in the next section. + Do not install Eclipse from your distribution's package + repository. + Be sure to install Eclipse from the official Eclipse + download site as directed in the next section. </note> </para> @@ -654,89 +662,69 @@ <title>Installing the Eclipse IDE</title> <para> - It is recommended that you have the Juno 4.2 version of the - Eclipse IDE installed on your development system. - However, if you currently have the Indigo 3.7.2 version installed and you do - not want to upgrade the IDE, you can configure Indigo to work with the - Yocto Project. + It is recommended that you have the Kepler 4.3 version of + the Eclipse IDE installed on your development system. + However, if you currently have the Juno 4.2 version + installed and you do not want to upgrade the IDE, you can + configure Juno to work with the Yocto Project. See the - "<link linkend='configuring-the-eclipse-ide-indigo'>Configuring the Eclipse IDE (Indigo)</link>" + "<link linkend='configuring-the-eclipse-ide-juno'>Configuring the Eclipse IDE (Juno)</link>" section. </para> <para> - If you do not have the Juno 4.2 Eclipse IDE installed, you can find the tarball at + If you do not have the Kepler 4.3 Eclipse IDE installed, you + can find the tarball at <ulink url='&ECLIPSE_MAIN_URL;'></ulink>. - From that site, choose the Eclipse Classic version particular to your development - host. - This version contains the Eclipse Platform, the Java Development - Tools (JDT), and the Plug-in Development Environment. + From that site, choose the Eclipse Standard 4.3 version + particular to your development host. + This version contains the Eclipse Platform, the Java + Development Tools (JDT), and the Plug-in Development + Environment. </para> <para> - Once you have downloaded the tarball, extract it into a clean - directory. + Once you have downloaded the tarball, extract it into a + clean directory. For example, the following commands unpack and install the downloaded Eclipse IDE tarball into a clean directory using the default name <filename>eclipse</filename>: <literallayout class='monospaced'> $ cd ~ - $ tar -xzvf ~/Downloads/eclipse-SDK-4.2-linux-gtk-x86_64.tar.gz - </literallayout> - </para> - - <para> - If you have the Indigo 3.7.2 Eclipse IDE already installed and you want to use that - version, one issue exists that you need to be aware of regarding the Java - Virtual machine’s garbage collection (GC) process. - The GC process does not clean up the permanent generation - space (PermGen). - This space stores metadata descriptions of classes. - The default value is set too small and it could trigger an - out-of-memory error such as the following: - <literallayout class='monospaced'> - Java.lang.OutOfMemoryError: PermGen space - </literallayout> - </para> - - <para> - This error causes the application to hang. - </para> - - <para> - To fix this issue, you can use the <filename>--vmargs</filename> - option when you start the Indigo 3.7.2 Eclipse IDE - to increase the size of the permanent generation space: - <literallayout class='monospaced'> - eclipse --vmargs --XX:PermSize=256M + $ tar -xzvf ~/Downloads/eclipse-standard-kepler-R-linux-gtk-x86_64.tar.gz </literallayout> </para> </section> - <section id='configuring-the-eclipse-ide-juno'> - <title>Configuring the Eclipse IDE (Juno)</title> + <section id='configuring-the-eclipse-ide-kepler'> + <title>Configuring the Eclipse IDE (Kepler)</title> <para> - This section presents the steps needed to configure the Juno 4.2 Eclipse IDE. - If you are using Indigo 3.7.2, see the - "<link linkend='configuring-the-eclipse-ide-indigo'>Configuring the Eclipse IDE (Indigo)</link>". + This section presents the steps needed to configure the + Kepler 4.3 Eclipse IDE. + If you are using Juno 4.2, see the + "<link linkend='configuring-the-eclipse-ide-juno'>Configuring the Eclipse IDE (Juno)</link>". </para> <para> - Before installing and configuring the Eclipse Yocto Plug-in, you need to configure - the Juno 4.2 Eclipse IDE. + Before installing and configuring the Eclipse Yocto Plug-in, + you need to configure the Kepler 4.3 Eclipse IDE. Follow these general steps: <orderedlist> <listitem><para>Start the Eclipse IDE.</para></listitem> - <listitem><para>Make sure you are in your Workbench and select - "Install New Software" from the "Help" pull-down menu. + <listitem><para>Make sure you are in your Workbench and + select "Install New Software" from the "Help" + pull-down menu.</para></listitem> + <listitem><para>Select + <filename>Juno - &ECLIPSE_JUNO_URL;</filename> + from the "Work with:" pull-down menu. </para></listitem> - <listitem><para>Select <filename>Juno - &ECLIPSE_JUNO_URL;</filename> - from the "Work with:" pull-down menu.</para></listitem> - <listitem><para>Expand the box next to "Linux Tools" and select the - <filename>LTTng - Linux Tracing Toolkit</filename> boxes.</para></listitem> - <listitem><para>Expand the box next to "Mobile and Device Development" and select the - following boxes: + <listitem><para>Expand the box next to "Linux Tools" + and select the + <filename>LTTng - Linux Tracing Toolkit</filename> + boxes.</para></listitem> + <listitem><para>Expand the box next to "Mobile and + Device Development" and select the following boxes: <itemizedlist> <listitem><para><filename>C/C++ Remote Launch</filename></para></listitem> <listitem><para><filename>Remote System Explorer End-user Runtime</filename></para></listitem> @@ -745,70 +733,59 @@ <listitem><para><filename>TCF Remote System Explorer add-in</filename></para></listitem> <listitem><para><filename>TCF Target Explorer</filename></para></listitem> </itemizedlist></para></listitem> - <listitem><para>Expand the box next to "Programming Languages" - and select the <filename>Autotools Support for CDT</filename> - and <filename>C/C++ Development Tools</filename> boxes.</para></listitem> - <listitem><para>Complete the installation and restart the Eclipse IDE.</para></listitem> + <listitem><para>Expand the box next to "Programming + Languages" and select the + <filename>Autotools Support for CDT</filename> + and <filename>C/C++ Development Tools</filename> + boxes.</para></listitem> + <listitem><para>Complete the installation and restart + the Eclipse IDE.</para></listitem> </orderedlist> </para> </section> - <section id='configuring-the-eclipse-ide-indigo'> - <title>Configuring the Eclipse IDE (Indigo)</title> + <section id='configuring-the-eclipse-ide-juno'> + <title>Configuring the Eclipse IDE (Juno)</title> <para> - This section presents the steps needed to configure the Indigo 3.7.2 Eclipse IDE. - If you are using Juno 4.2, see the - "<link linkend='configuring-the-eclipse-ide-juno'>Configuring the Eclipse IDE (Juno)</link>". + This section presents the steps needed to configure the + Juno 4.2 Eclipse IDE. </para> <para> - Before installing and configuring the Eclipse Yocto Plug-in, you need to configure - the Indigo 3.7.2 Eclipse IDE. + Before installing and configuring the Eclipse Yocto Plug-in, + you need to configure the Juno 4.2 Eclipse IDE. Follow these general steps: <orderedlist> <listitem><para>Start the Eclipse IDE.</para></listitem> - <listitem><para>Make sure you are in your Workbench and select - "Install New Software" from the "Help" pull-down menu. - </para></listitem> - <listitem><para>Select <filename>indigo - &ECLIPSE_INDIGO_URL;</filename> - from the "Work with:" pull-down menu.</para></listitem> - <listitem><para>Expand the box next to "Programming Languages" - and select the <filename>Autotools Support for CDT (incubation)</filename> - and <filename>C/C++ Development Tools</filename> boxes.</para></listitem> - <listitem><para>Expand the box next to "Linux Tools" and select the - <filename>LTTng - Linux Tracing Toolkit(incubation)</filename> - boxes.</para></listitem> - <listitem><para>Complete the installation and restart the Eclipse IDE.</para></listitem> - <listitem><para>After the Eclipse IDE restarts and from the Workbench, select - "Install New Software" from the "Help" pull-down menu.</para></listitem> - <listitem><para>Click the - "Available Software Sites" link.</para></listitem> - <listitem><para>Check the box next to - <filename>&ECLIPSE_UPDATES_URL;</filename> - and click "OK".</para></listitem> - <listitem><para>Select <filename>&ECLIPSE_UPDATES_URL;</filename> - from the "Work with:" pull-down menu.</para></listitem> - <listitem><para>Check the box next to <filename>TM and RSE Main Features</filename>. + <listitem><para>Make sure you are in your Workbench and + select "Install New Software" from the "Help" + pull-down menu.</para></listitem> + <listitem><para>Select + <filename>Juno - &ECLIPSE_JUNO_URL;</filename> + from the "Work with:" pull-down menu. </para></listitem> - <listitem><para>Expand the box next to <filename>TM and RSE Optional Add-ons</filename> - and select every item except <filename>RSE Unit Tests</filename> and - <filename>RSE WinCE Services (incubation)</filename>.</para></listitem> - <listitem><para>Complete the installation and restart the Eclipse IDE.</para></listitem> - <listitem><para>If necessary, select - "Install New Software" from the "Help" pull-down menu so you can click the - "Available Software Sites" link again.</para></listitem> - <listitem><para>After clicking "Available Software Sites", check the box next to - <filename>http://download.eclipse.org/tools/cdt/releases/indigo</filename> - and click "OK".</para></listitem> - <listitem><para>Select <filename>&ECLIPSE_INDIGO_CDT_URL;</filename> - from the "Work with:" pull-down menu.</para></listitem> - <listitem><para>Check the box next to <filename>CDT Main Features</filename>. + <listitem><para>Expand the box next to "Linux Tools" + and select the + <filename>LTTng - Linux Tracing Toolkit</filename> boxes. </para></listitem> - <listitem><para>Expand the box next to "CDT Optional Features" - and select <filename>C/C++ Remote Launch</filename> and - <filename>Target Communication Framework (incubation)</filename>.</para></listitem> - <listitem><para>Complete the installation and restart the Eclipse IDE.</para></listitem> + <listitem><para>Expand the box next to "Mobile and + Device Development" and select the following boxes: + <itemizedlist> + <listitem><para><filename>C/C++ Remote Launch</filename></para></listitem> + <listitem><para><filename>Remote System Explorer End-user Runtime</filename></para></listitem> + <listitem><para><filename>Remote System Explorer User Actions</filename></para></listitem> + <listitem><para><filename>Target Management Terminal</filename></para></listitem> + <listitem><para><filename>TCF Remote System Explorer add-in</filename></para></listitem> + <listitem><para><filename>TCF Target Explorer</filename></para></listitem> + </itemizedlist></para></listitem> + <listitem><para>Expand the box next to "Programming + Languages" and select the + <filename>Autotools Support for CDT</filename> + and <filename>C/C++ Development Tools</filename> + boxes.</para></listitem> + <listitem><para>Complete the installation and restart + the Eclipse IDE.</para></listitem> </orderedlist> </para> </section> @@ -817,35 +794,46 @@ <title>Installing or Accessing the Eclipse Yocto Plug-in</title> <para> - You can install the Eclipse Yocto Plug-in into the Eclipse IDE - one of two ways: use the Yocto Project's Eclipse Update site to install the pre-built plug-in, - or build and install the plug-in from the latest source code. - If you do not want to permanently install the plug-in but just want to try it out - within the Eclipse environment, you can import the plug-in project from the - Yocto Project's Source Repositories. + You can install the Eclipse Yocto Plug-in into the Eclipse + IDE one of two ways: use the Yocto Project's Eclipse + Update site to install the pre-built plug-in, or build and + install the plug-in from the latest source code. + If you do not want to permanently install the plug-in but + just want to try it out within the Eclipse environment, + you can import the plug-in project from the Yocto Project's + Source Repositories. </para> <section id='new-software'> <title>Installing the Pre-built Plug-in from the Yocto Project Eclipse Update Site</title> <para> - To install the Eclipse Yocto Plug-in from the update site, - follow these steps: + To install the Eclipse Yocto Plug-in from the update + site, follow these steps: <orderedlist> - <listitem><para>Start up the Eclipse IDE.</para></listitem> - <listitem><para>In Eclipse, select "Install New Software" from the "Help" menu.</para></listitem> - <listitem><para>Click "Add..." in the "Work with:" area.</para></listitem> + <listitem><para>Start up the Eclipse IDE. + </para></listitem> + <listitem><para>In Eclipse, select "Install New + Software" from the "Help" menu. + </para></listitem> + <listitem><para>Click "Add..." in the "Work with:" + area.</para></listitem> <listitem><para>Enter <filename>&ECLIPSE_DL_PLUGIN_URL;</filename> - in the URL field and provide a meaningful name in the "Name" field.</para></listitem> - <listitem><para>Click "OK" to have the entry added to the "Work with:" - drop-down list.</para></listitem> - <listitem><para>Select the entry for the plug-in from the "Work with:" drop-down - list.</para></listitem> - <listitem><para>Check the box next to <filename>Development tools and SDKs for Yocto Linux</filename>. + in the URL field and provide a meaningful name + in the "Name" field.</para></listitem> + <listitem><para>Click "OK" to have the entry added + to the "Work with:" drop-down list. + </para></listitem> + <listitem><para>Select the entry for the plug-in + from the "Work with:" drop-down list. </para></listitem> - <listitem><para>Complete the remaining software installation steps and - then restart the Eclipse IDE to finish the installation of the plug-in. + <listitem><para>Check the box next to + <filename>Development tools and SDKs for Yocto Linux</filename>. + </para></listitem> + <listitem><para>Complete the remaining software + installation steps and then restart the Eclipse + IDE to finish the installation of the plug-in. </para></listitem> </orderedlist> </para> @@ -855,71 +843,87 @@ <title>Installing the Plug-in Using the Latest Source Code</title> <para> - To install the Eclipse Yocto Plug-in from the latest source code, follow these steps: + To install the Eclipse Yocto Plug-in from the latest + source code, follow these steps: <orderedlist> - <listitem><para>Open a shell and create a Git repository with: + <listitem><para>Open a shell and create a Git + repository with: <literallayout class='monospaced'> $ git clone git://git.yoctoproject.org/eclipse-poky yocto-eclipse </literallayout> For this example, the repository is named - <filename>~/yocto-eclipse</filename>.</para></listitem> - <listitem><para>Change to the directory where you set up - the Git repository: + <filename>~/yocto-eclipse</filename>. + </para></listitem> + <listitem><para>Change to the directory where you + set up the Git repository: <literallayout class='monospaced'> $ cd ~/yocto-eclipse </literallayout></para></listitem> - <listitem><para>Be sure you are in the right branch for your Git repository. - For this release set the branch to <filename>&DISTRO_NAME;</filename>: + <listitem><para>Be sure you are in the right branch + for your Git repository. + For this release set the branch to + <filename>&DISTRO_NAME;</filename>: <literallayout class='monospaced'> $ git checkout -b &DISTRO_NAME; origin/&DISTRO_NAME; </literallayout></para></listitem> - <listitem><para>Change to the <filename>scripts</filename> + <listitem><para>Change to the + <filename>scripts</filename> directory within the Git repository: <literallayout class='monospaced'> $ cd scripts </literallayout></para></listitem> - <listitem><para>Set up the local build environment by running the - setup script: + <listitem><para>Set up the local build environment + by running the setup script: <literallayout class='monospaced'> $ ./setup.sh </literallayout></para></listitem> - <listitem><para>When the script finishes execution, it prompts - you with instructions on how to run the - <filename>build.sh</filename> script, which is also in - the <filename>scripts</filename> of the - Git repository created earlier. + <listitem><para>When the script finishes execution, + it prompts you with instructions on how to run + the <filename>build.sh</filename> script, which + is also in the <filename>scripts</filename> of + the Git repository created earlier. </para></listitem> <listitem><para>Run the <filename>build.sh</filename> script as directed. - Be sure to provide the name of the Git branch along with the - Yocto Project release you are using. - Here is an example that uses the <filename>&DISTRO_NAME;</filename> branch: + Be sure to provide the name of the Git branch + along with the Yocto Project release you are + using. + Here is an example that uses the + <filename>&DISTRO_NAME;</filename> branch: <literallayout class='monospaced'> $ ECLIPSE_HOME=/home/scottrif/yocto-eclipse/scripts/eclipse ./build.sh &DISTRO_NAME; &DISTRO_NAME; </literallayout> After running the script, the file <filename>org.yocto.sdk-<release>-<date>-archive.zip</filename> is in the current directory.</para></listitem> - <listitem><para>If necessary, start the Eclipse IDE and be sure you are in the - Workbench.</para></listitem> + <listitem><para>If necessary, start the Eclipse IDE + and be sure you are in the Workbench. + </para></listitem> <listitem><para>Select "Install New Software" from the "Help" pull-down menu. </para></listitem> <listitem><para>Click "Add".</para></listitem> - <listitem><para>Provide anything you want in the "Name" field.</para></listitem> - <listitem><para>Click "Archive" and browse to the ZIP file you built - in step seven. - This ZIP file should not be "unzipped", and must be the - <filename>*archive.zip</filename> file created by running the - <filename>build.sh</filename> script.</para></listitem> - <listitem><para>Click through the "Okay" buttons.</para></listitem> - <listitem><para>Check the box next to the new entry in the installation window and complete - the installation.</para></listitem> - <listitem><para>Restart the Eclipse IDE if necessary.</para></listitem> + <listitem><para>Provide anything you want in the + "Name" field.</para></listitem> + <listitem><para>Click "Archive" and browse to the + ZIP file you built in step seven. + This ZIP file should not be "unzipped", and must + be the <filename>*archive.zip</filename> file + created by running the + <filename>build.sh</filename> script. + </para></listitem> + <listitem><para>Click through the "Okay" buttons. + </para></listitem> + <listitem><para>Check the box next to the new entry + in the installation window and complete + the installation.</para></listitem> + <listitem><para>Restart the Eclipse IDE if + necessary.</para></listitem> </orderedlist> </para> <para> - At this point you should be able to configure the Eclipse Yocto Plug-in as described in the + At this point you should be able to configure the + Eclipse Yocto Plug-in as described in the "<link linkend='configuring-the-eclipse-yocto-plug-in'>Configuring the Eclipse Yocto Plug-in</link>" section.</para> </section> @@ -928,29 +932,37 @@ <title>Importing the Plug-in Project into the Eclipse Environment</title> <para> - Importing the Eclipse Yocto Plug-in project from the Yocto Project source repositories - is useful when you want to try out the latest plug-in from the tip of plug-in's - development tree. - It is important to understand when you import the plug-in you are not installing - it into the Eclipse application. + Importing the Eclipse Yocto Plug-in project from the + Yocto Project source repositories is useful when you + want to try out the latest plug-in from the tip of + plug-in's development tree. + It is important to understand when you import the + plug-in you are not installing it into the Eclipse + application. Rather, you are importing the project and just using it. </para> <para> To import the plug-in project, follow these steps: <orderedlist> - <listitem><para>Open a shell and create a Git repository with: + <listitem><para>Open a shell and create a Git + repository with: <literallayout class='monospaced'> $ git clone git://git.yoctoproject.org/eclipse-poky yocto-eclipse </literallayout> For this example, the repository is named - <filename>~/yocto-eclipse</filename>.</para></listitem> - <listitem><para>In Eclipse, select "Import" from the "File" menu.</para></listitem> - <listitem><para>Expand the "General" box and select "existing projects into workspace" - and then click "Next".</para></listitem> - <listitem><para>Select the root directory and browse to - <filename>~/yocto-eclipse/plugins</filename>.</para></listitem> - <listitem><para>Three plug-ins exist: + <filename>~/yocto-eclipse</filename>. + </para></listitem> + <listitem><para>In Eclipse, select "Import" from + the "File" menu.</para></listitem> + <listitem><para>Expand the "General" box and select + "existing projects into workspace" and then + click "Next".</para></listitem> + <listitem><para>Select the root directory and + browse to + <filename>~/yocto-eclipse/plugins</filename>. + </para></listitem> + <listitem><para>Three plug-ins exist: <filename>org.yocto.bc.ui</filename>, <filename>org.yocto.sdk.ide</filename>, and <filename>org.yocto.sdk.remotetools</filename>. @@ -959,9 +971,11 @@ </para> <para> - The left navigation pane in the Eclipse application shows the default projects. - Right-click on one of these projects and run it as an Eclipse application - to bring up a second instance of Eclipse IDE that has the Yocto Plug-in. + The left navigation pane in the Eclipse application + shows the default projects. + Right-click on one of these projects and run it as an + Eclipse application to bring up a second instance of + Eclipse IDE that has the Yocto Plug-in. </para> </section> </section> @@ -970,20 +984,23 @@ <title>Configuring the Eclipse Yocto Plug-in</title> <para> - Configuring the Eclipse Yocto Plug-in involves setting the Cross - Compiler options and the Target options. - The configurations you choose become the default settings for all projects. + Configuring the Eclipse Yocto Plug-in involves setting the + Cross Compiler options and the Target options. + The configurations you choose become the default settings + for all projects. You do have opportunities to change them later when you configure the project (see the following section). </para> <para> - To start, you need to do the following from within the Eclipse IDE: + To start, you need to do the following from within the + Eclipse IDE: <itemizedlist> - <listitem><para>Choose "Preferences" from the - "Windows" menu to display - the Preferences Dialog</para></listitem> - <listitem><para>Click "Yocto Project ADT"</para></listitem> + <listitem><para>Choose "Preferences" from the + "Windows" menu to display the Preferences Dialog. + </para></listitem> + <listitem><para>Click "Yocto Project ADT". + </para></listitem> </itemizedlist> </para> @@ -991,78 +1008,105 @@ <title>Configuring the Cross-Compiler Options</title> <para> - To configure the Cross Compiler Options, you must select the type of toolchain, - point to the toolchain, specify the sysroot location, and select the target architecture. + To configure the Cross Compiler Options, you must select + the type of toolchain, point to the toolchain, specify + the sysroot location, and select the target + architecture. <itemizedlist> <listitem><para><emphasis>Selecting the Toolchain Type:</emphasis> - Choose between <filename>Standalone pre-built toolchain</filename> - and <filename>Build system derived toolchain</filename> for Cross - Compiler Options. + Choose between + <filename>Standalone pre-built toolchain</filename> + and + <filename>Build system derived toolchain</filename> + for Cross Compiler Options. <itemizedlist> <listitem><para><emphasis> <filename>Standalone Pre-built Toolchain:</filename></emphasis> - Select this mode when you are using a stand-alone cross-toolchain. - For example, suppose you are an application developer and do not + Select this mode when you are using + a stand-alone cross-toolchain. + For example, suppose you are an + application developer and do not need to build a target image. - Instead, you just want to use an architecture-specific toolchain on an - existing kernel and target root filesystem. - </para></listitem> + Instead, you just want to use an + architecture-specific toolchain on + an existing kernel and target root + filesystem.</para></listitem> <listitem><para><emphasis> <filename>Build System Derived Toolchain:</filename></emphasis> - Select this mode if the cross-toolchain has been installed and built - as part of the + Select this mode if the + cross-toolchain has been installed + and built as part of the <link linkend='build-directory'>Build Directory</link>. - When you select <filename>Build system derived toolchain</filename>, + When you select + <filename>Build system derived toolchain</filename>, you are using the toolchain bundled inside the Build Directory. </para></listitem> </itemizedlist> </para></listitem> <listitem><para><emphasis>Point to the Toolchain:</emphasis> - If you are using a stand-alone pre-built toolchain, you should be pointing to the - where it is installed. - If you used the ADT Installer script and accepted the default - installation directory, the toolchain will be installed in - the <filename>&YOCTO_ADTPATH_DIR;</filename> directory. - Sections "<ulink url='&YOCTO_DOCS_ADT_URL;#configuring-and-running-the-adt-installer-script'>Configuring - and Running the ADT Installer Script</ulink>" and + If you are using a stand-alone pre-built + toolchain, you should be pointing to where it is + installed. + If you used the ADT Installer script and + accepted the default installation directory, the + toolchain will be installed in the + <filename>&YOCTO_ADTPATH_DIR;</filename> + directory. + Sections "<ulink url='&YOCTO_DOCS_ADT_URL;#configuring-and-running-the-adt-installer-script'>Configuring and Running the ADT Installer Script</ulink>" + and "<ulink url='&YOCTO_DOCS_ADT_URL;#using-an-existing-toolchain-tarball'>Using a Cross-Toolchain Tarball</ulink>" - in the Yocto Project Application Developer's Guide - describe how to install a stand-alone cross-toolchain.</para> - <para>If you are using a system-derived toolchain, the path you provide - for the <filename>Toolchain Root Location</filename> - field is the <link linkend='build-directory'>Build Directory</link>. - See the "<ulink url='&YOCTO_DOCS_ADT_URL;#using-the-toolchain-from-within-the-build-tree'>Using - BitBake and the Build Directory</ulink>" section in the Yocto Project Application - Developer's Guide for information on how to install - the toolchain into the Build Directory.</para></listitem> + in the Yocto Project Application Developer's + Guide describe how to install a stand-alone + cross-toolchain.</para> + <para>If you are using a system-derived + toolchain, the path you provide for the + <filename>Toolchain Root Location</filename> + field is the + <link linkend='build-directory'>Build Directory</link>. + See the + "<ulink url='&YOCTO_DOCS_ADT_URL;#using-the-toolchain-from-within-the-build-tree'>Using BitBake and the Build Directory</ulink>" + section in the Yocto Project Application + Developer's Guide for information on how to + install the toolchain into the Build + Directory.</para></listitem> <listitem><para><emphasis>Specify the Sysroot Location:</emphasis> - This location is where the root filesystem for the target hardware resides. - If you used the ADT Installer script and accepted the - default installation directory, then the location is + This location is where the root filesystem for + the target hardware resides. + If you used the ADT Installer script and + accepted the default installation directory, + then the location is <filename>/opt/poky/<release></filename>. - Additionally, when you use the ADT Installer script, - the same location is used for - the QEMU user-space tools and the NFS boot process.</para> - <para>If you used either of the other two methods to - install the toolchain or did not accept the ADT Installer - script's default installation directory, then the - location of the sysroot filesystem depends on where you separately - extracted and installed the filesystem.</para> - <para>For information on how to install the toolchain and on how to extract - and install the sysroot filesystem, see the + Additionally, when you use the ADT Installer + script, the same location is used for the QEMU + user-space tools and the NFS boot process. + </para> + <para>If you used either of the other two + methods to install the toolchain or did not + accept the ADT Installer script's default + installation directory, then the location of + the sysroot filesystem depends on where you + separately extracted and installed the + filesystem.</para> + <para>For information on how to install the + toolchain and on how to extract and install the + sysroot filesystem, see the "<ulink url='&YOCTO_DOCS_ADT_URL;#installing-the-adt'>Installing the ADT and Toolchains</ulink>" section. </para></listitem> <listitem><para><emphasis>Select the Target Architecture:</emphasis> - The target architecture is the type of hardware you are - going to use or emulate. - Use the pull-down <filename>Target Architecture</filename> menu to make - your selection. - The pull-down menu should have the supported architectures. - If the architecture you need is not listed in the menu, you - will need to build the image. - See the "<ulink url='&YOCTO_DOCS_QS_URL;#building-image'>Building an Image</ulink>" section - of the Yocto Project Quick Start for more information.</para></listitem> + The target architecture is the type of hardware + you are going to use or emulate. + Use the pull-down + <filename>Target Architecture</filename> menu + to make your selection. + The pull-down menu should have the supported + architectures. + If the architecture you need is not listed in + the menu, you will need to build the image. + See the + "<ulink url='&YOCTO_DOCS_QS_URL;#building-image'>Building an Image</ulink>" + section of the Yocto Project Quick Start for + more information.</para></listitem> </itemizedlist> </para> </section> @@ -1071,38 +1115,53 @@ <title>Configuring the Target Options</title> <para> - You can choose to emulate hardware using the QEMU emulator, or you - can choose to run your image on actual hardware. + You can choose to emulate hardware using the QEMU + emulator, or you can choose to run your image on actual + hardware. <itemizedlist> - <listitem><para><emphasis><filename>QEMU:</filename></emphasis> Select this option if - you will be using the QEMU emulator. - If you are using the emulator, you also need to locate the kernel - and specify any custom options.</para> - <para>If you selected <filename>Build system derived toolchain</filename>, - the target kernel you built will be located in the - Build Directory in <filename>tmp/deploy/images</filename> directory. - If you selected <filename>Standalone pre-built toolchain</filename>, the - pre-built image you downloaded is located - in the directory you specified when you downloaded the image.</para> - <para>Most custom options are for advanced QEMU users to further - customize their QEMU instance. - These options are specified between paired angled brackets. - Some options must be specified outside the brackets. - In particular, the options <filename>serial</filename>, - <filename>nographic</filename>, and <filename>kvm</filename> must all - be outside the brackets. - Use the <filename>man qemu</filename> command to get help on all the options - and their use. + <listitem><para><emphasis><filename>QEMU:</filename></emphasis> + Select this option if you will be using the + QEMU emulator. + If you are using the emulator, you also need to + locate the kernel and specify any custom + options.</para> + <para>If you selected + <filename>Build system derived toolchain</filename>, + the target kernel you built will be located in + the Build Directory in + <filename>tmp/deploy/images</filename> + directory. + If you selected + <filename>Standalone pre-built toolchain</filename>, + the pre-built image you downloaded is located + in the directory you specified when you + downloaded the image.</para> + <para>Most custom options are for advanced QEMU + users to further customize their QEMU instance. + These options are specified between paired + angled brackets. + Some options must be specified outside the + brackets. + In particular, the options + <filename>serial</filename>, + <filename>nographic</filename>, and + <filename>kvm</filename> must all be outside the + brackets. + Use the <filename>man qemu</filename> command + to get help on all the options and their use. The following is an example: <literallayout class='monospaced'> serial ‘<-m 256 -full-screen>’ </literallayout></para> <para> - Regardless of the mode, Sysroot is already defined as part of the - Cross-Compiler Options configuration in the - <filename>Sysroot Location:</filename> field.</para></listitem> - <listitem><para><emphasis><filename>External HW:</filename></emphasis> Select this option - if you will be using actual hardware.</para></listitem> + Regardless of the mode, Sysroot is already + defined as part of the Cross-Compiler Options + configuration in the + <filename>Sysroot Location:</filename> field. + </para></listitem> + <listitem><para><emphasis><filename>External HW:</filename></emphasis> + Select this option if you will be using actual + hardware.</para></listitem> </itemizedlist> </para> @@ -1117,36 +1176,50 @@ <title>Creating the Project</title> <para> - You can create two types of projects: Autotools-based, or Makefile-based. - This section describes how to create Autotools-based projects from within - the Eclipse IDE. - For information on creating Makefile-based projects in a terminal window, see the section + You can create two types of projects: Autotools-based, or + Makefile-based. + This section describes how to create Autotools-based projects + from within the Eclipse IDE. + For information on creating Makefile-based projects in a + terminal window, see the section "<ulink url='&YOCTO_DOCS_ADT_URL;#using-the-command-line'>Using the Command Line</ulink>" in the Yocto Project Application Developer's Guide. </para> <para> - To create a project based on a Yocto template and then display the source code, - follow these steps: + To create a project based on a Yocto template and then display + the source code, follow these steps: <orderedlist> - <listitem><para>Select "Project" from the "File -> New" menu.</para></listitem> - <listitem><para>Double click <filename>CC++</filename>.</para></listitem> - <listitem><para>Double click <filename>C Project</filename> to create the project.</para></listitem> - <listitem><para>Expand <filename>Yocto Project ADT Project</filename>.</para></listitem> + <listitem><para>Select "Project" from the "File -> New" menu. + </para></listitem> + <listitem><para>Double click <filename>CC++</filename>. + </para></listitem> + <listitem><para>Double click <filename>C Project</filename> + to create the project.</para></listitem> + <listitem><para>Expand <filename>Yocto Project ADT Project</filename>. + </para></listitem> <listitem><para>Select <filename>Hello World ANSI C Autotools Project</filename>. - This is an Autotools-based project based on a Yocto template.</para></listitem> - <listitem><para>Put a name in the <filename>Project name:</filename> field. - Do not use hyphens as part of the name.</para></listitem> + This is an Autotools-based project based on a Yocto + template.</para></listitem> + <listitem><para>Put a name in the <filename>Project name:</filename> + field. + Do not use hyphens as part of the name. + </para></listitem> <listitem><para>Click "Next".</para></listitem> - <listitem><para>Add information in the <filename>Author</filename> and - <filename>Copyright notice</filename> fields.</para></listitem> - <listitem><para>Be sure the <filename>License</filename> field is correct.</para></listitem> + <listitem><para>Add information in the + <filename>Author</filename> and + <filename>Copyright notice</filename> fields. + </para></listitem> + <listitem><para>Be sure the <filename>License</filename> + field is correct.</para></listitem> <listitem><para>Click "Finish".</para></listitem> - <listitem><para>If the "open perspective" prompt appears, click "Yes" so that you - in the C/C++ perspective.</para></listitem> - <listitem><para>The left-hand navigation pane shows your project. - You can display your source by double clicking the project's source file. + <listitem><para>If the "open perspective" prompt appears, + click "Yes" so that you in the C/C++ perspective. </para></listitem> + <listitem><para>The left-hand navigation pane shows your + project. + You can display your source by double clicking the + project's source file.</para></listitem> </orderedlist> </para> </section> @@ -1155,38 +1228,47 @@ <title>Configuring the Cross-Toolchains</title> <para> - The earlier section, "<link linkend='configuring-the-eclipse-yocto-plug-in'>Configuring - the Eclipse Yocto Plug-in</link>", sets up the default project - configurations. - You can override these settings for a given project by following these steps: + The earlier section, + "<link linkend='configuring-the-eclipse-yocto-plug-in'>Configuring the Eclipse Yocto Plug-in</link>", + sets up the default project configurations. + You can override these settings for a given project by following + these steps: <orderedlist> - <listitem><para>Select "Change Yocto Project Settings" from the - "Project" menu. - This selection brings up the Yocto Project Settings Dialog - and allows you to make changes specific to an individual project. - </para> - <para>By default, the Cross Compiler Options and Target Options for a project - are inherited from settings you provide using the Preferences - Dialog as described earlier - in the "<link linkend='configuring-the-eclipse-yocto-plug-in'>Configuring the Eclipse - Yocto Plug-in</link>" section. - The Yocto Project Settings Dialog allows you to override - those default settings for a given project.</para></listitem> - <listitem><para>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.</para></listitem> - <listitem><para>Select "Reconfigure Project" from the + <listitem><para>Select "Change Yocto Project Settings" from + the "Project" menu. + This selection brings up the Yocto Project Settings + Dialog and allows you to make changes specific to an + individual project.</para> + <para>By default, the Cross Compiler Options and Target + Options for a project are inherited from settings you + provide using the Preferences Dialog as described + earlier in the + "<link linkend='configuring-the-eclipse-yocto-plug-in'>Configuring the Eclipse Yocto Plug-in</link>" section. + The Yocto Project Settings Dialog allows you to override + those default settings for a given project. + </para></listitem> + <listitem><para>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. + </para></listitem> + <listitem><para>Select "Reconfigure Project" from the "Project" menu. This selection reconfigures the project by running - <filename>autogen.sh</filename> in the workspace for your project. - The script also runs <filename>libtoolize</filename>, <filename>aclocal</filename>, - <filename>autoconf</filename>, <filename>autoheader</filename>, + <filename>autogen.sh</filename> in the workspace for + your project. + The script also runs <filename>libtoolize</filename>, + <filename>aclocal</filename>, + <filename>autoconf</filename>, + <filename>autoheader</filename>, <filename>automake --a</filename>, and <filename>./configure</filename>. Click on the "Console" tab beneath your source code to - see the results of reconfiguring your project.</para></listitem> + see the results of reconfiguring your project. + </para></listitem> </orderedlist> </para> </section> @@ -1195,11 +1277,12 @@ <title>Building the Project</title> <para> - 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 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 "Project" menu. - The console should update and you can note the cross-compiler you are using. + The console should update and you can note the cross-compiler + you are using. </para> </section> @@ -1207,23 +1290,26 @@ <title>Starting QEMU in User-Space NFS Mode</title> <para> - To start the QEMU emulator from within Eclipse, follow these steps: + To start the QEMU emulator from within Eclipse, follow these + steps: <orderedlist> - <listitem><para>Expose and select "External Tools" from + <listitem><para>Expose and select "External Tools" from the "Run" menu. Your image should appear as a selectable menu item. </para></listitem> - <listitem><para>Select your image from the menu to launch the - emulator in a new window.</para></listitem> - <listitem><para>If needed, enter your host root password in the shell window at the prompt. - This sets up a <filename>Tap 0</filename> connection needed for running in user-space - NFS mode.</para></listitem> + <listitem><para>Select your image from the menu to launch + the emulator in a new window.</para></listitem> + <listitem><para>If needed, enter your host root password in + the shell window at the prompt. + This sets up a <filename>Tap 0</filename> connection + needed for running in user-space NFS mode. + </para></listitem> <listitem><para>Wait for QEMU to launch.</para></listitem> - <listitem><para>Once QEMU launches, you can begin operating within that - environment. + <listitem><para>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 <filename>ifconfig</filename> command. - </para></listitem> + for the user-space NFS by using the + <filename>ifconfig</filename> command.</para></listitem> </orderedlist> </para> </section> @@ -1232,38 +1318,45 @@ <title>Deploying and Debugging the Application</title> <para> - Once the QEMU emulator is running the image, you can deploy - your application using the Eclipse IDE and use then use + Once the QEMU emulator is running the image, you can deploy + your application using the Eclipse IDE and use then use the emulator to perform debugging. Follow these steps to deploy the application. <orderedlist> - <listitem><para>Select "Debug Configurations..." from the - "Run" menu.</para></listitem> - <listitem><para>In the left area, expand <filename>C/C++Remote Application</filename>.</para></listitem> - <listitem><para>Locate your project and select it to bring up a new - tabbed view in the Debug Configurations Dialog.</para></listitem> - <listitem><para>Enter the absolute path into which you want to deploy - the application. - Use the "Remote Absolute File Path for C/C++Application:" field. - For example, enter <filename>/usr/bin/<programname></filename>.</para></listitem> - <listitem><para>Click on the "Debugger" tab to see the cross-tool debugger - you are using.</para></listitem> + <listitem><para>Select "Debug Configurations..." from the + "Run" menu.</para></listitem> + <listitem><para>In the left area, expand + <filename>C/C++Remote Application</filename>. + </para></listitem> + <listitem><para>Locate your project and select it to bring + up a new tabbed view in the Debug Configurations Dialog. + </para></listitem> + <listitem><para>Enter the absolute path into which you want + to deploy the application. + Use the "Remote Absolute File Path for + C/C++Application:" field. + For example, enter + <filename>/usr/bin/<programname></filename>. + </para></listitem> + <listitem><para>Click on the "Debugger" tab to see the + cross-tool debugger you are using.</para></listitem> <listitem><para>Click on the "Main" tab.</para></listitem> <listitem><para>Create a new connection to the QEMU instance by clicking on "new".</para></listitem> - <listitem><para>Select <filename>TCF</filename>, which means Target Communication - Framework.</para></listitem> + <listitem><para>Select <filename>TCF</filename>, which means + Target Communication Framework.</para></listitem> <listitem><para>Click "Next".</para></listitem> - <listitem><para>Clear out the "host name" field and enter the IP Address - determined earlier.</para></listitem> + <listitem><para>Clear out the "host name" field and enter + the IP Address determined earlier.</para></listitem> <listitem><para>Click "Finish" to close the New Connections Dialog.</para></listitem> - <listitem><para>Use the drop-down menu now in the + <listitem><para>Use the drop-down menu now in the "Connection" field and pick the IP Address you entered. </para></listitem> <listitem><para>Click "Run" to bring up a login screen and login.</para></listitem> - <listitem><para>Accept the debug perspective.</para></listitem> + <listitem><para>Accept the debug perspective. + </para></listitem> </orderedlist> </para> </section> @@ -1272,107 +1365,135 @@ <title>Running User-Space Tools</title> <para> - As mentioned earlier in the manual, several tools exist that enhance - your development experience. - 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. + As mentioned earlier in the manual, several tools exist that + enhance your development experience. + 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. </para> <para> - Once you pick a tool, you need to configure it for the remote target. + Once you pick a tool, you need to configure it for the remote + target. Every tool needs to have the connection configured. - You must select an existing TCF-based RSE connection to the remote target. + You must select an existing TCF-based RSE connection to the + remote target. If one does not exist, click "New" to create one. </para> <para> Here are some specifics about the remote tools: <itemizedlist> - <listitem><para><emphasis><filename>OProfile</filename>:</emphasis> Selecting this tool causes - the <filename>oprofile-server</filename> on the remote target to launch on - the local host machine. - The <filename>oprofile-viewer</filename> must be installed on the local host machine and the - <filename>oprofile-server</filename> must be installed on the remote target, - respectively, in order to use. - You must compile and install the <filename>oprofile-viewer</filename> from the source code - on your local host machine. - Furthermore, in order to convert the target's sample format data into a form that the - host can use, you must have OProfile version 0.9.4 or - greater installed on the host.</para> + <listitem><para><emphasis><filename>OProfile</filename>:</emphasis> + Selecting this tool causes the + <filename>oprofile-server</filename> on the remote + target to launch on the local host machine. + The <filename>oprofile-viewer</filename> must be + installed on the local host machine and the + <filename>oprofile-server</filename> must be installed + on the remote target, respectively, in order to use. + You must compile and install the + <filename>oprofile-viewer</filename> from the source + code on your local host machine. + Furthermore, in order to convert the target's sample + format data into a form that the host can use, you must + have OProfile version 0.9.4 or greater installed on the + host.</para> <para>You can locate both the viewer and server from <ulink url='&YOCTO_GIT_URL;/cgit/cgit.cgi/oprofileui/'></ulink>. You can also find more information on setting up and using this tool in the "<ulink url='&YOCTO_DOCS_PROF_URL;#profile-manual-oprofile'>OProfile</ulink>" - section of the Yocto Project Profiling and Tracing Manual. - <note>The <filename>oprofile-server</filename> is installed by default on - the <filename>core-image-sato-sdk</filename> image.</note></para></listitem> + section of the Yocto Project Profiling and Tracing + Manual. + <note>The <filename>oprofile-server</filename> is + installed by default on the + <filename>core-image-sato-sdk</filename> image.</note> + </para></listitem> <listitem><para><emphasis><filename>Lttng2.0 ust trace import</filename>:</emphasis> Selecting this tool transfers the remote target's - <filename>Lttng</filename> tracing data back to the local host machine - and uses the Lttng Eclipse plug-in to graphically - display the output. - For information on how to use Lttng to trace an application, + <filename>Lttng</filename> tracing data back to the + local host machine and uses the Lttng Eclipse plug-in + to graphically display the output. + For information on how to use Lttng to trace an + application, see <ulink url='http://lttng.org/documentation'></ulink> - and the - "<ulink url='&YOCTO_DOCS_PROF_URL;#lttng-linux-trace-toolkit-next-generation'>LTTng (Linux Trace Toolkit, next generation)</ulink>" - section, which is in the Yocto Project Profiling and Tracing Manual. - <note>Do not use <filename>Lttng-user space (legacy)</filename> tool. + and the + "<ulink url='&YOCTO_DOCS_PROF_URL;#lttng-linux-trace-toolkit-next-generation'>LTTng (Linux Trace Toolkit, next generation)</ulink>" + section, which is in the Yocto Project Profiling and + Tracing Manual. + <note>Do not use + <filename>Lttng-user space (legacy)</filename> tool. This tool no longer has any upstream support.</note> </para> - <para>Before you use the <filename>Lttng2.0 ust trace import</filename> tool, + <para>Before you use the + <filename>Lttng2.0 ust trace import</filename> tool, you need to setup the Lttng Eclipse plug-in and create a Tracing project. Do the following: <orderedlist> - <listitem><para>Select "Open Perspective" from the - "Window" menu and then select "Tracing".</para></listitem> - <listitem><para>Click "OK" to change the Eclipse perspective - into the Tracing perspective.</para></listitem> - <listitem><para>Create a new Tracing project by selecting - "Project" from the "File -> New" menu.</para></listitem> - <listitem><para>Choose "Tracing Project" from the - "Tracing" menu. + <listitem><para>Select "Open Perspective" from the + "Window" menu and then select "Tracing". + </para></listitem> + <listitem><para>Click "OK" to change the Eclipse + perspective into the Tracing perspective. </para></listitem> - <listitem><para>Generate your tracing data on the remote target. + <listitem><para>Create a new Tracing project by + selecting "Project" from the "File -> New" menu. </para></listitem> - <listitem><para>Select "Lttng2.0 ust trace import" from - the "Yocto Project Tools" menu to + <listitem><para>Choose "Tracing Project" from the + "Tracing" menu. + </para></listitem> + <listitem><para>Generate your tracing data on the + remote target.</para></listitem> + <listitem><para>Select "Lttng2.0 ust trace import" + from the "Yocto Project Tools" menu to start the data import process.</para></listitem> - <listitem><para>Specify your remote connection name.</para></listitem> - <listitem><para>For the Ust directory path, specify the location of - your remote tracing data. - Make sure the location ends with <filename>ust</filename> (e.g. - <filename>/usr/mysession/ust</filename>).</para></listitem> - <listitem><para>Click "OK" to complete the import process. - The data is now in the local tracing project you created.</para></listitem> - <listitem><para>Right click on the data and then use the menu to - Select "Generic CTF Trace" from the - "Trace Type... -> Common Trace Format" menu to map - the tracing type.</para></listitem> - <listitem><para>Right click the mouse and select "Open" - to bring up the Eclipse Lttng Trace Viewer so you - view the tracing data.</para></listitem> + <listitem><para>Specify your remote connection name. + </para></listitem> + <listitem><para>For the Ust directory path, specify + the location of your remote tracing data. + Make sure the location ends with + <filename>ust</filename> (e.g. + <filename>/usr/mysession/ust</filename>). + </para></listitem> + <listitem><para>Click "OK" to complete the import + process. + The data is now in the local tracing project + you created.</para></listitem> + <listitem><para>Right click on the data and then use + the menu to Select "Generic CTF Trace" from the + "Trace Type... -> Common Trace Format" menu to + map the tracing type.</para></listitem> + <listitem><para>Right click the mouse and select + "Open" to bring up the Eclipse Lttng Trace + Viewer so you view the tracing data. + </para></listitem> </orderedlist></para></listitem> - <listitem><para><emphasis><filename>PowerTOP</filename>:</emphasis> Selecting this tool runs - PowerTOP on the remote target machine and displays the results in a - new view called PowerTOP.</para> - <para>The "Time to gather data(sec):" field is the time passed in seconds before data - is gathered from the remote target for analysis.</para> - <para>The "show pids in wakeups list:" field corresponds to the - <filename>-p</filename> argument - passed to <filename>PowerTOP</filename>.</para></listitem> + <listitem><para><emphasis><filename>PowerTOP</filename>:</emphasis> + Selecting this tool runs PowerTOP on the remote target + machine and displays the results in a new view called + PowerTOP.</para> + <para>The "Time to gather data(sec):" field is the time + passed in seconds before data is gathered from the + remote target for analysis.</para> + <para>The "show pids in wakeups list:" field corresponds + to the <filename>-p</filename> argument passed to + <filename>PowerTOP</filename>.</para></listitem> <listitem><para><emphasis><filename>LatencyTOP and Perf</filename>:</emphasis> LatencyTOP identifies system latency, while - Perf monitors the system's performance counter registers. - Selecting either of these tools causes an RSE terminal view to appear - from which you can run the tools. - Both tools refresh the entire screen to display results while they run. - For more information on setting up and using <filename>perf</filename>, - see the + Perf monitors the system's performance counter + registers. + Selecting either of these tools causes an RSE terminal + view to appear from which you can run the tools. + Both tools refresh the entire screen to display results + while they run. + For more information on setting up and using + <filename>perf</filename>, see the "<ulink url='&YOCTO_DOCS_PROF_URL;#profile-manual-perf'>perf</ulink>" - section in the Yocto Project Profiling and Tracing Manual. + section in the Yocto Project Profiling and Tracing + Manual. For information on LatencyTOP, see the <ulink url='https://latencytop.org/'>LatencyTOP</ulink> website. @@ -1385,37 +1506,43 @@ <title>Customizing an Image Using a BitBake Commander Project and Hob</title> <para> - Within the Eclipse IDE, you can create a Yocto BitBake Commander project, - edit the <link linkend='metadata'>Metadata</link>, and then use - <ulink url='&YOCTO_HOME_URL;/tools-resources/projects/hob'>Hob</ulink> to build a customized - image all within one IDE. + Within the Eclipse IDE, you can create a Yocto BitBake Commander + project, edit the <link linkend='metadata'>Metadata</link>, and + then use + <ulink url='&YOCTO_HOME_URL;/tools-resources/projects/hob'>Hob</ulink> to build a customized image all within one IDE. </para> <section id='creating-the-yocto-bitbake-commander-project'> <title>Creating the Yocto BitBake Commander Project</title> <para> - To create a Yocto BitBake Commander project, follow these steps: + To create a Yocto BitBake Commander project, follow these + steps: <orderedlist> - <listitem><para>Select "Other" from the - "Window -> Open Perspective" menu - and then choose "Bitbake Commander".</para></listitem> + <listitem><para>Select "Other" from the + "Window -> Open Perspective" menu + and then choose "Bitbake Commander". + </para></listitem> <listitem><para>Click "OK" to change the perspective to Bitbake Commander.</para></listitem> <listitem><para>Select "Project" from the "File -> New" menu to create a new Yocto Bitbake Commander project.</para></listitem> - <listitem><para>Choose "New Yocto Project" from the - "Yocto Project Bitbake Commander" menu and click + <listitem><para>Choose "New Yocto Project" from the + "Yocto Project Bitbake Commander" menu and click "Next".</para></listitem> - <listitem><para>Enter the Project Name and choose the Project Location. - The Yocto project's Metadata files will be put under the directory + <listitem><para>Enter the Project Name and choose the + Project Location. + The Yocto project's Metadata files will be put under + the directory <filename><project_location>/<project_name></filename>. If that directory does not exist, you need to check - the "Clone from Yocto Git Repository" box, which would execute a - <filename>git clone</filename> command to get the project's Metadata files. + the "Clone from Yocto Git Repository" box, which + would execute a <filename>git clone</filename> + command to get the project's Metadata files. </para></listitem> - <listitem><para>Select <filename>Finish</filename> to create the project.</para></listitem> + <listitem><para>Select <filename>Finish</filename> to + create the project.</para></listitem> </orderedlist> </para> </section> @@ -1424,32 +1551,38 @@ <title>Editing the Metadata</title> <para> - After you create the Yocto Bitbake Commander project, you can modify the - <link linkend='metadata'>Metadata</link> files - by opening them in the project. - When editing recipe files (<filename>.bb</filename> files), you can view BitBake - variable values and information by hovering the mouse pointer over the variable name and + After you create the Yocto Bitbake Commander project, you + can modify the <link linkend='metadata'>Metadata</link> + files by opening them in the project. + When editing recipe files (<filename>.bb</filename> files), + you can view BitBake variable values and information by + hovering the mouse pointer over the variable name and waiting a few seconds. </para> <para> To edit the Metadata, follow these steps: <orderedlist> - <listitem><para>Select your Yocto Bitbake Commander project.</para></listitem> - <listitem><para>Select "BitBake Recipe" from the - "File -> New -> Yocto BitBake Commander" menu + <listitem><para>Select your Yocto Bitbake Commander + project.</para></listitem> + <listitem><para>Select "BitBake Recipe" from the + "File -> New -> Yocto BitBake Commander" menu to open a new recipe wizard.</para></listitem> - <listitem><para>Point to your source by filling in the "SRC_URL" field. + <listitem><para>Point to your source by filling in the + "SRC_URL" field. For example, you can add a recipe to your <link linkend='source-directory'>Source Directory</link> by defining "SRC_URL" as follows: <literallayout class='monospaced'> ftp://ftp.gnu.org/gnu/m4/m4-1.4.9.tar.gz </literallayout></para></listitem> - <listitem><para>Click "Populate" to calculate the archive md5, sha256, - license checksum values and to auto-generate the recipe filename.</para></listitem> - <listitem><para>Fill in the "Description" field.</para></listitem> - <listitem><para>Be sure values for all required fields exist.</para></listitem> + <listitem><para>Click "Populate" to calculate the + archive md5, sha256, license checksum values and to + auto-generate the recipe filename.</para></listitem> + <listitem><para>Fill in the "Description" field. + </para></listitem> + <listitem><para>Be sure values for all required + fields exist.</para></listitem> <listitem><para>Click "Finish".</para></listitem> </orderedlist> </para> @@ -1459,20 +1592,24 @@ <title>Building and Customizing the Image Using Hob</title> <para> - To build and customize the image using Hob from within the + To build and customize the image using Hob from within the Eclipse IDE, follow these steps: <orderedlist> - <listitem><para>Select your Yocto Bitbake Commander project.</para></listitem> + <listitem><para>Select your Yocto Bitbake Commander + project.</para></listitem> <listitem><para>Select "Launch Hob" from the "Project" menu.</para></listitem> - <listitem><para>Enter the + <listitem><para>Enter the <link linkend='build-directory'>Build Directory</link> - where you want to put your final images.</para></listitem> - <listitem><para>Click "OK" to launch Hob.</para></listitem> - <listitem><para>Use Hob to customize and build your own images. + where you want to put your final images. + </para></listitem> + <listitem><para>Click "OK" to launch Hob. + </para></listitem> + <listitem><para>Use Hob to customize and build your own + images. For information on Hob, see the - <ulink url='&YOCTO_HOME_URL;/tools-resources/projects/hob'>Hob Project Page</ulink> on the - Yocto Project website.</para></listitem> + <ulink url='&YOCTO_HOME_URL;/tools-resources/projects/hob'>Hob Project Page</ulink> + on the Yocto Project website.</para></listitem> </orderedlist> </para> </section> @@ -1508,7 +1645,7 @@ support development using actual hardware. For example, the area might contain <filename>.hddimg</filename> files that combine the - kernel image with the filesystem, boot loaders, and + kernel image with the filesystem, boot loaders, and so forth. Be sure to get the files you need for your particular development process.</para> @@ -1879,9 +2016,9 @@ <para> For a better understanding of Hob, see the project page at - <ulink url='&YOCTO_HOME_URL;/tools-resources/projects/hob'></ulink> + <ulink url='&YOCTO_HOME_URL;/tools-resources/projects/hob'></ulink> on the Yocto Project website. - If you follow the "Documentation" link from the Hob page, you will + If you follow the "Documentation" link from the Hob page, you will find a short introductory training video on Hob. The following lists some features of Hob: <itemizedlist> @@ -1893,9 +2030,9 @@ <listitem><para>You can set the <ulink url='&YOCTO_DOCS_REF_URL;#var-MACHINE'><filename>MACHINE</filename></ulink> for which you are building the image.</para></listitem> - <listitem><para>You can modify various policy settings such as the + <listitem><para>You can modify various policy settings such as the package format with which to build, - the parallelism BitBake uses, whether or not to build an + the parallelism BitBake uses, whether or not to build an external toolchain, and which host to build against. </para></listitem> <listitem><para>You can manage |
