diff options
Diffstat (limited to 'documentation/adt-manual/adt-eclipse.xml')
-rw-r--r-- | documentation/adt-manual/adt-eclipse.xml | 234 |
1 files changed, 129 insertions, 105 deletions
diff --git a/documentation/adt-manual/adt-eclipse.xml b/documentation/adt-manual/adt-eclipse.xml index 4dd90f52fd..f7f772e322 100644 --- a/documentation/adt-manual/adt-eclipse.xml +++ b/documentation/adt-manual/adt-eclipse.xml | |||
@@ -7,7 +7,7 @@ | |||
7 | The Eclipse IDE is a popular development environment and it fully supports | 7 | The Eclipse IDE is a popular development environment and it fully supports |
8 | development using Yocto Project. | 8 | development using Yocto Project. |
9 | When you install and configure the Eclipse Yocto Project Plug-in into | 9 | When you install and configure the Eclipse Yocto Project Plug-in into |
10 | the Eclipse IDE you maximize your Yocto Project design experience. | 10 | the Eclipse IDE, you maximize your Yocto Project design experience. |
11 | Installing and configuring the Plug-in results in an environment that | 11 | Installing and configuring the Plug-in results in an environment that |
12 | has extensions specifically designed to let you more easily develop software. | 12 | has extensions specifically designed to let you more easily develop software. |
13 | These extensions allow for cross-compilation and deployment and execution of | 13 | These extensions allow for cross-compilation and deployment and execution of |
@@ -40,7 +40,7 @@ | |||
40 | <para> | 40 | <para> |
41 | It is recommended that you have the Indigo 3.7 version of the | 41 | It is recommended that you have the Indigo 3.7 version of the |
42 | Eclipse IDE installed on your development system. | 42 | Eclipse IDE installed on your development system. |
43 | If you don’t have this version you can find it at | 43 | If you don’t have this version, you can find it at |
44 | <ulink url='http://www.eclipse.org/downloads'></ulink>. | 44 | <ulink url='http://www.eclipse.org/downloads'></ulink>. |
45 | From that site, choose the Eclipse Classic version. | 45 | From that site, choose the Eclipse Classic version. |
46 | This version contains the Eclipse Platform, the Java Development | 46 | This version contains the Eclipse Platform, the Java Development |
@@ -66,7 +66,8 @@ | |||
66 | This error causes the application to hang. | 66 | This error causes the application to hang. |
67 | </para> | 67 | </para> |
68 | <para> | 68 | <para> |
69 | To fix this issue you can use the ‐‐vmargs option when you start | 69 | To fix this issue, you can use the <filename>‐‐vmargs</filename> |
70 | option when you start | ||
70 | Eclipse to increase the size of the permanent generation space: | 71 | Eclipse to increase the size of the permanent generation space: |
71 | <literallayout class='monospaced'> | 72 | <literallayout class='monospaced'> |
72 | eclipse ‐‐vmargs ‐‐XX:PermSize=256M | 73 | eclipse ‐‐vmargs ‐‐XX:PermSize=256M |
@@ -77,34 +78,37 @@ | |||
77 | <section id='installing-required-plug-ins-and-the-eclipse-yocto-plug-in'> | 78 | <section id='installing-required-plug-ins-and-the-eclipse-yocto-plug-in'> |
78 | <title>Installing Required Plug-ins and the Eclipse Yocto Plug-in</title> | 79 | <title>Installing Required Plug-ins and the Eclipse Yocto Plug-in</title> |
79 | <para> | 80 | <para> |
80 | Before installing the Yocto Plug-in you need to be sure that the | 81 | Before installing the Yocto Plug-in, you need to be sure that the |
81 | CDT 8.0, RSE 3.2, and Autotools plug-ins are all installed in the | 82 | <filename>CDT 8.0</filename>, <filename>RSE 3.2</filename>, and |
83 | <filename>Autotools</filename> plug-ins are all installed in the | ||
82 | following order. | 84 | following order. |
83 | After installing these three plug-ins, you can install the | 85 | After installing these three plug-ins, you can install the |
84 | Eclipse Yocto Plug-in. | 86 | <filename>Eclipse Yocto</filename> plug-in. |
85 | Use the following URLs for the plug-ins: | 87 | Use the following URLs for the plug-ins: |
86 | <orderedlist> | 88 | <orderedlist> |
87 | <listitem><para><emphasis>CDT 8.0</emphasis> – | 89 | <listitem><para><emphasis>CDT 8.0</emphasis> – |
88 | <ulink url='http://download.eclipse.org/tools/cdt/releases/indigo/'></ulink>: | 90 | <ulink url='http://download.eclipse.org/tools/cdt/releases/indigo/'></ulink>: |
89 | For CDT main features select the checkbox so you get all items. | 91 | For <filename>CDT main features</filename>, select the checkbox so you get all items. |
90 | For CDT optional features expand the selections and check | 92 | For <filename>CDT optional features</filename> expand the selections and check |
91 | “C/C++ Remote Launch”.</para></listitem> | 93 | <filename>C/C++ Remote Launch</filename>.</para></listitem> |
92 | <listitem><para><emphasis>RSE 3.2</emphasis> – | 94 | <listitem><para><emphasis>RSE 3.2</emphasis> – |
93 | <ulink url='http://download.eclipse.org/tm/updates/3.2'></ulink>: | 95 | <ulink url='http://download.eclipse.org/tm/updates/3.2'></ulink>: |
94 | Check the box next to “TM and RSE Main Features” so you select all | 96 | Check the box next to <filename>TM and RSE Main Features</filename> so you select all |
95 | those items. | 97 | those items. |
96 | Note that all items in the main features depend on 3.2.1 version. | 98 | Note that all items in the main features depend on 3.2.1 version. |
97 | Expand the items under “TM and RSE Uncategorized 3.2.1” and | 99 | Expand the items under <filename>TM and RSE Uncategorized 3.2.1</filename> and |
98 | select the following: “Remote System Explorer End-User Runtime”, | 100 | select the following: <filename>Remote System Explorer End-User Runtime</filename>, |
99 | “Remote System Explorer Extended SDK”, “Remote System Explorer User Actions”, | 101 | <filename>Remote System Explorer Extended SDK</filename>, |
100 | “RSE Core”, “RSE Terminals UI”, and “Target Management Terminal”.</para></listitem> | 102 | <filename>Remote System Explorer User Actions</filename>, |
103 | <filename>RSE Core</filename>, <filename>RSE Terminals UI</filename>, | ||
104 | and <filename>Target Management Terminal</filename>.</para></listitem> | ||
101 | <listitem><para><emphasis>Autotools</emphasis> – | 105 | <listitem><para><emphasis>Autotools</emphasis> – |
102 | <ulink url='http://download.eclipse.org/technology/linuxtools/update/'></ulink>: | 106 | <ulink url='http://download.eclipse.org/technology/linuxtools/update/'></ulink>: |
103 | Expand the items under “Linux Tools” and select “Autotools support for | 107 | Expand the items under “Linux Tools” and select “Autotools support for |
104 | CDT (Incubation)”.</para></listitem> | 108 | CDT (Incubation)”.</para></listitem> |
105 | <listitem><para><emphasis>Yocto Plug-in</emphasis> – | 109 | <listitem><para><emphasis>Yocto Plug-in</emphasis> – |
106 | <ulink url='http://www.yoctoproject.org/downloads/eclipse-plugin/1.0'></ulink>: | 110 | <ulink url='http://www.yoctoproject.org/downloads/eclipse-plugin/1.0'></ulink>: |
107 | Check the box next to “Development tools & SDKs for Yocto Linux” | 111 | Check the box next to <filename>Development tools & SDKs for Yocto Linux</filename> |
108 | to select all the items.</para></listitem> | 112 | to select all the items.</para></listitem> |
109 | </orderedlist> | 113 | </orderedlist> |
110 | </para> | 114 | </para> |
@@ -112,9 +116,11 @@ | |||
112 | Follow these general steps to install a plug-in: | 116 | Follow these general steps to install a plug-in: |
113 | <orderedlist> | 117 | <orderedlist> |
114 | <listitem><para>From within the Eclipse IDE select the | 118 | <listitem><para>From within the Eclipse IDE select the |
115 | “Install New Software” item from the “Help” menu.</para></listitem> | 119 | <filename>Install New Software</filename> item from the <filename>Help</filename> |
116 | <listitem><para>Click “Add…” in the “Work with:” area.</para></listitem> | 120 | menu.</para></listitem> |
117 | <listitem><para>Enter the URL for the repository and leave the “Name” | 121 | <listitem><para>Click <filename>Add…</filename> in the |
122 | <filename>Work with:</filename> area.</para></listitem> | ||
123 | <listitem><para>Enter the URL for the repository and leave the <filename>Name</filename> | ||
118 | field blank.</para></listitem> | 124 | field blank.</para></listitem> |
119 | <listitem><para>Check the boxes next to the software you need to | 125 | <listitem><para>Check the boxes next to the software you need to |
120 | install and then complete the installation. | 126 | install and then complete the installation. |
@@ -132,42 +138,46 @@ | |||
132 | the Target Options. | 138 | the Target Options. |
133 | These settings are the default settings for all projects. | 139 | These settings are the default settings for all projects. |
134 | You do have opportunities to change them later if you choose to when | 140 | You do have opportunities to change them later if you choose to when |
135 | you configure the project. | 141 | you configure the project (see the following section). |
136 | See “Configuring the Cross Toolchain” section later in the manual. | ||
137 | </para> | 142 | </para> |
138 | <para> | 143 | <para> |
139 | To start, you need to do the following from within the Eclipse IDE: | 144 | To start, you need to do the following from within the Eclipse IDE: |
140 | <itemizedlist> | 145 | <itemizedlist> |
141 | <listitem><para>Choose Windows -> Preferences to display | 146 | <listitem><para>Choose <filename>Windows -> Preferences</filename> to display |
142 | the Preferences Dialog</para></listitem> | 147 | the Preferences Dialog</para></listitem> |
143 | <listitem><para>Click “Yocto SDK”</para></listitem> | 148 | <listitem><para>Click <filename>Yocto SDK</filename></para></listitem> |
144 | </itemizedlist> | 149 | </itemizedlist> |
145 | </para> | 150 | </para> |
146 | 151 | ||
147 | <section id='configuring-the-cross-compiler-options'> | 152 | <section id='configuring-the-cross-compiler-options'> |
148 | <title>Configuring the Cross-Compiler Options</title> | 153 | <title>Configuring the Cross-Compiler Options</title> |
149 | <para> | 154 | <para> |
150 | Choose between ‘Stand-alone Prebuilt Toolchain’ and ‘Build System Derived Toolchain’ for Cross | 155 | Choose between <filename>Stand-alone Prebuilt Toolchain</filename> |
156 | and <filename>Build System Derived Toolchain</filename> for Cross | ||
151 | Compiler Options. | 157 | Compiler Options. |
152 | <itemizedlist> | 158 | <itemizedlist> |
153 | <listitem><para><emphasis>Stand-alone Prebuilt Toolchain</emphasis> – Select this mode | 159 | <listitem><para><emphasis><filename>Stand-alone Prebuilt Toolchain</filename></emphasis> – |
160 | Select this mode | ||
154 | when you are not concerned with building a target image or you do not have | 161 | when you are not concerned with building a target image or you do not have |
155 | a Yocto Project build tree on your development system. | 162 | a Yocto Project build tree on your development system. |
156 | For example, suppose you are an application developer and do not | 163 | For example, suppose you are an application developer and do not |
157 | need to build a target image. | 164 | need to build a target image. |
158 | Instead, you just want to use an architecture-specific toolchain on an | 165 | Instead, you just want to use an architecture-specific toolchain on an |
159 | existing kernel and target root filesystem. | 166 | existing kernel and target root filesystem. |
160 | When you use Stand-alone Prebuilt Toolchain you are using the toolchain installed | 167 | When you use <filename>Stand-alone Prebuilt Toolchain</filename> |
168 | you are using the toolchain installed | ||
161 | in the <filename>/opt/poky</filename> directory.</para></listitem> | 169 | in the <filename>/opt/poky</filename> directory.</para></listitem> |
162 | <listitem><para><emphasis>Build System Derived Toolchain</emphasis> – Select this mode | 170 | <listitem><para><emphasis><filename>Build System Derived Toolchain</filename></emphasis> – |
171 | Select this mode | ||
163 | if you are building images for target hardware or your | 172 | if you are building images for target hardware or your |
164 | development environment already has a Yocto Project build tree. | 173 | development environment already has a Yocto Project build tree. |
165 | In this case you likely already have a Yocto Project build tree installed on | 174 | In this case, you likely already have a Yocto Project build tree on |
166 | your system or you (or someone else) will be building one. | 175 | your system or you (or someone else) will be building one. |
167 | When you select Build System Derived Toolchain you are using the toolchain bundled | 176 | When you select <filename>Build System Derived Toolchain</filename> |
177 | you are using the toolchain bundled | ||
168 | inside the Yocto Project build tree. | 178 | inside the Yocto Project build tree. |
169 | If you use this mode you must also supply the Yocto Project build directory | 179 | If you use this mode, you must also supply the Yocto Project build directory |
170 | in the Preferences Dialog.</para></listitem> | 180 | in the <filename>Preferences Dialog</filename>.</para></listitem> |
171 | </itemizedlist> | 181 | </itemizedlist> |
172 | </para> | 182 | </para> |
173 | </section> | 183 | </section> |
@@ -179,24 +189,26 @@ | |||
179 | target hardware is created on the development system by the ADT Installer. | 189 | target hardware is created on the development system by the ADT Installer. |
180 | The QEMU user-space tools, the | 190 | The QEMU user-space tools, the |
181 | NFS boot process and the cross-toolchain all use the sysroot location | 191 | NFS boot process and the cross-toolchain all use the sysroot location |
182 | regardless of wheather you select (Stand-alone Prebuilt Toolchain or Build System Derived Toolchain). | 192 | regardless of whether you select |
193 | (<filename>Stand-alone Prebuilt Toolchain</filename> or | ||
194 | <filename>Build System Derived Toolchain</filename>). | ||
183 | </para> | 195 | </para> |
184 | </section> | 196 | </section> |
185 | 197 | ||
186 | <section id='selecting-the-target-architecture'> | 198 | <section id='selecting-the-target-architecture'> |
187 | <title>Selecting the Target Architecture</title> | 199 | <title>Selecting the Target Architecture</title> |
188 | <para> | 200 | <para> |
189 | Use the pull-down Target Architecture menu and select the | 201 | Use the pull-down <filename>Target Architecture</filename> menu and select the |
190 | target architecture. | 202 | target architecture. |
191 | </para> | 203 | </para> |
192 | <para> | 204 | <para> |
193 | The Target Architecture is the type of hardware you are | 205 | The target architecture is the type of hardware you are |
194 | going to use or emulate. | 206 | going to use or emulate. |
195 | This pull-down menu should have the supported architectures. | 207 | This pull-down menu should have the supported architectures. |
196 | If the architecture you need is not listed in the menu then you | 208 | If the architecture you need is not listed in the menu then you |
197 | will need to re-visit | 209 | will need to re-visit |
198 | <xref linkend='adt-prepare'> | 210 | <xref linkend='adt-prepare'> |
199 | “Preparing to Use the Application Development Toolkit (ADT)”</xref> | 211 | Preparing to Use the Application Development Toolkit (ADT)</xref> |
200 | section earlier in this document. | 212 | section earlier in this document. |
201 | </para> | 213 | </para> |
202 | </section> | 214 | </section> |
@@ -207,16 +219,17 @@ | |||
207 | You can choose to emulate hardware using the QEMU emulator, or you | 219 | You can choose to emulate hardware using the QEMU emulator, or you |
208 | can choose to use actual hardware. | 220 | can choose to use actual hardware. |
209 | <itemizedlist> | 221 | <itemizedlist> |
210 | <listitem><para><emphasis>External HW</emphasis> – Select this option | 222 | <listitem><para><emphasis><filename>External HW</filename></emphasis> – Select this option |
211 | if you will be using actual hardware.</para></listitem> | 223 | if you will be using actual hardware.</para></listitem> |
212 | <listitem><para><emphasis>QEMU</emphasis> – Select this option if | 224 | <listitem><para><emphasis><filename>QEMU</filename></emphasis> – Select this option if |
213 | you will be using the QEMU emulator. | 225 | you will be using the QEMU emulator. |
214 | If you are using the emulator you also need to locate the Kernel | 226 | If you are using the emulator, you also need to locate the kernel |
215 | and specify any custom options.</para> | 227 | and specify any custom options.</para> |
216 | <para>If you select Build System Derived Toolchain the target kernel you built | 228 | <para>If you select <filename>Build System Derived Toolchain</filename>, |
217 | will be located in the | 229 | the target kernel you built will be located in the |
218 | Yocto Project build tree in <filename>tmp/deploy/images</filename> directory. | 230 | Yocto Project build tree in <filename>tmp/deploy/images</filename> directory. |
219 | If you select Stand-alone Prebuilt Toolchain the pre-built kernel you downloaded is located | 231 | If you select <filename>Stand-alone Prebuilt Toolchain</filename>, the |
232 | pre-built kernel you downloaded is located | ||
220 | in the directory you specified when you downloaded the image.</para> | 233 | in the directory you specified when you downloaded the image.</para> |
221 | <para>Most custom options are for advanced QEMU users to further | 234 | <para>Most custom options are for advanced QEMU users to further |
222 | customize their QEMU instance. | 235 | customize their QEMU instance. |
@@ -238,7 +251,7 @@ | |||
238 | </itemizedlist> | 251 | </itemizedlist> |
239 | </para> | 252 | </para> |
240 | <para> | 253 | <para> |
241 | Click the “OK” button to save your plug-in configurations. | 254 | Click the <filename>OK</filename> button to save your plug-in configurations. |
242 | </para> | 255 | </para> |
243 | </section> | 256 | </section> |
244 | </section> | 257 | </section> |
@@ -251,27 +264,28 @@ | |||
251 | This section describes how to create autotools-based projects from within | 264 | This section describes how to create autotools-based projects from within |
252 | the Eclipse IDE. | 265 | the Eclipse IDE. |
253 | For information on creating projects in a terminal window see | 266 | For information on creating projects in a terminal window see |
254 | <xref linkend='using-the-command-line'> “Using the Command Line”</xref> | 267 | <xref linkend='using-the-command-line'>Using the Command Line</xref> |
255 | section. | 268 | section. |
256 | </para> | 269 | </para> |
257 | <para> | 270 | <para> |
258 | To create a project based on a Yocto template and then display the source code, | 271 | To create a project based on a Yocto template and then display the source code, |
259 | follow these steps: | 272 | follow these steps: |
260 | <orderedlist> | 273 | <orderedlist> |
261 | <listitem><para>Select File -> New -> Project.</para></listitem> | 274 | <listitem><para>Select <filename>File -> New -> Project</filename>.</para></listitem> |
262 | <listitem><para>Double click “CC++”.</para></listitem> | 275 | <listitem><para>Double click <filename>CC++</filename>.</para></listitem> |
263 | <listitem><para>Double click “C Project” to create the project.</para></listitem> | 276 | <listitem><para>Double click <filename>C Project</filename> to create the project.</para></listitem> |
264 | <listitem><para>Double click “Yocto SDK Project”.</para></listitem> | 277 | <listitem><para>Double click <filename>Yocto SDK Project</filename>.</para></listitem> |
265 | <listitem><para>Select “Hello World ANSI C Autotools Project”. | 278 | <listitem><para>Select <filename>Hello World ANSI C Autotools Project</filename>. |
266 | This is an Autotools-based project based on a Yocto Project template.</para></listitem> | 279 | This is an Autotools-based project based on a Yocto Project template.</para></listitem> |
267 | <listitem><para>Put a name in the “Project name:” field.</para></listitem> | 280 | <listitem><para>Put a name in the <filename>Project name:</filename> field.</para></listitem> |
268 | <listitem><para>Click “Next”.</para></listitem> | 281 | <listitem><para>Click <filename>Next</filename>.</para></listitem> |
269 | <listitem><para>Add information in the “Author” field.</para></listitem> | 282 | <listitem><para>Add information in the <filename>Author</filename> field.</para></listitem> |
270 | <listitem><para>Use “GNU General Public License v2.0” for the License.</para></listitem> | 283 | <listitem><para>Use <filename>GNU General Public License v2.0</filename> |
271 | <listitem><para>Click “Finish”.</para></listitem> | 284 | for the License.</para></listitem> |
272 | <listitem><para>Answer ‘Yes” to the open perspective prompt.</para></listitem> | 285 | <listitem><para>Click <filename>Finish</filename>.</para></listitem> |
286 | <listitem><para>Answer <filename>Yes</filename> to the open perspective prompt.</para></listitem> | ||
273 | <listitem><para>In the Project Explorer expand your project.</para></listitem> | 287 | <listitem><para>In the Project Explorer expand your project.</para></listitem> |
274 | <listitem><para>Expand ‘src’.</para></listitem> | 288 | <listitem><para>Expand <filename>src</filename>.</para></listitem> |
275 | <listitem><para>Double click on your source file and the code appears | 289 | <listitem><para>Double click on your source file and the code appears |
276 | in the window. | 290 | in the window. |
277 | This is the template.</para></listitem> | 291 | This is the template.</para></listitem> |
@@ -283,20 +297,23 @@ | |||
283 | <title>Configuring the Cross-Toolchains</title> | 297 | <title>Configuring the Cross-Toolchains</title> |
284 | <para> | 298 | <para> |
285 | The previous section, <xref linkend='configuring-the-cross-compiler-options'> | 299 | The previous section, <xref linkend='configuring-the-cross-compiler-options'> |
286 | “Configuring the Cross-Compiler Options”</xref>, set up the default project | 300 | Configuring the Cross-Compiler Options</xref>, set up the default project |
287 | configurations. | 301 | configurations. |
288 | You can change these settings for a given project by following these steps: | 302 | You can change these settings for a given project by following these steps: |
289 | <orderedlist> | 303 | <orderedlist> |
290 | <listitem><para>Select Project -> Invoke Yocto Tools -> Reconfigure Yocto. | 304 | <listitem><para>Select <filename>Project -> Invoke Yocto Tools -> Reconfigure Yocto</filename> - |
291 | This brings up the project's Yocto Settings Dialog. | 305 | This selection brings up the project's <filename>Yocto Settings</filename> Dialog. |
292 | Settings are inherited from the default project configuration. | 306 | Settings are inherited from the default project configuration. |
293 | The information in this dialogue is identical to that chosen earlier | 307 | The information in this dialog is identical to that chosen earlier |
294 | for the Cross Compiler Option (Stand-alone Prebuilt Toolchain or Build System Derived Toolchain), | 308 | for the <filename>Cross Compiler Option</filename> |
295 | the Target Architecture, and the Target Options. | 309 | (<filename>Stand-alone Prebuilt Toolchain</filename> or |
310 | <filename>Build System Derived Toolchain</filename>), | ||
311 | the <filename>Target Architecture</filename>, and the | ||
312 | <filename>Target Options</filename>. | ||
296 | The settings are inherited from the Yocto Plug-in configuration performed | 313 | The settings are inherited from the Yocto Plug-in configuration performed |
297 | after installing the plug-in.</para></listitem> | 314 | after installing the plug-in.</para></listitem> |
298 | <listitem><para>Select Project -> Reconfigure Project. | 315 | <listitem><para><filename>Select Project -> Reconfigure Project</filename> - |
299 | This runs the <filename>autogen.sh</filename> in the workspace for your project. | 316 | This selection runs the <filename>autogen.sh</filename> in the workspace for your project. |
300 | The script runs <filename>libtoolize</filename>, <filename>aclocal</filename>, | 317 | The script runs <filename>libtoolize</filename>, <filename>aclocal</filename>, |
301 | <filename>autoconf</filename>, <filename>autoheader</filename>, | 318 | <filename>autoconf</filename>, <filename>autoheader</filename>, |
302 | <filename>automake ‐‐a</filename>, and | 319 | <filename>automake ‐‐a</filename>, and |
@@ -308,7 +325,7 @@ | |||
308 | <section id='building-the-project'> | 325 | <section id='building-the-project'> |
309 | <title>Building the Project</title> | 326 | <title>Building the Project</title> |
310 | <para> | 327 | <para> |
311 | To build the project, select Project -> Build Project. | 328 | To build the project, select <filename>Project -> Build Project</filename>. |
312 | The console should update and you can note the cross-compiler you are using. | 329 | The console should update and you can note the cross-compiler you are using. |
313 | </para> | 330 | </para> |
314 | </section> | 331 | </section> |
@@ -318,19 +335,20 @@ | |||
318 | <para> | 335 | <para> |
319 | To start the QEMU emulator from within Eclipse, follow these steps: | 336 | To start the QEMU emulator from within Eclipse, follow these steps: |
320 | <orderedlist> | 337 | <orderedlist> |
321 | <listitem><para>Select Run -> External Tools -> External Tools Configurations... | 338 | <listitem><para>Select <filename>Run -> External Tools -> External Tools Configurations...</filename> |
322 | This selection brings up the External Tools Configurations Dialogue.</para></listitem> | 339 | - This selection brings up the <filename>External Tools Configurations</filename> Dialog.</para></listitem> |
323 | <listitem><para>Go to the left navigation area and expand ‘Program’. | 340 | <listitem><para>Go to the left navigation area and expand <filename>Program</filename>. |
324 | You should find the image listed. | 341 | You should find the image listed. |
325 | For example, qemu-x86_64-poky-linux.</para></listitem> | 342 | For example, <filename>qemu-x86_64-poky-linux</filename>.</para></listitem> |
326 | <listitem><para>Click on the image. | 343 | <listitem><para>Click on the image. |
327 | This brings up a new environment in the main area of the External | 344 | This brings up a new environment in the main area of the |
328 | Tools Configurations Dialogue. | 345 | <filename>External Tools Configurations</filename> Dialog. |
329 | The Main tab is selected.</para></listitem> | 346 | The Main tab is selected.</para></listitem> |
330 | <listitem><para>Click “Run” next. | 347 | <listitem><para>Click <filename>Run</filename> next. |
331 | This brings up a shell window.</para></listitem> | 348 | This brings up a shell window.</para></listitem> |
332 | <listitem><para>Enter your host root password in the shell window at the prompt. | 349 | <listitem><para>Enter your host root password in the shell window at the prompt. |
333 | This sets up a Tap 0 connection needed for running in user-space NFS mode.</para></listitem> | 350 | This sets up a <filename>Tap 0</filename> connection needed for running in user-space |
351 | NFS mode.</para></listitem> | ||
334 | <listitem><para>Wait for QEMU to launch.</para></listitem> | 352 | <listitem><para>Wait for QEMU to launch.</para></listitem> |
335 | <listitem><para>Once QEMU launches you need to determine the IP Address | 353 | <listitem><para>Once QEMU launches you need to determine the IP Address |
336 | for the user-space NFS. | 354 | for the user-space NFS. |
@@ -343,30 +361,33 @@ | |||
343 | <section id='deploying-and-debugging-the-application'> | 361 | <section id='deploying-and-debugging-the-application'> |
344 | <title>Deploying and Debugging the Application</title> | 362 | <title>Deploying and Debugging the Application</title> |
345 | <para> | 363 | <para> |
346 | Once QEMU is running you can deploy your application and use the emulator | 364 | Once QEMU is running, you can deploy your application and use the emulator |
347 | to perform debugging. | 365 | to perform debugging. |
348 | Follow these steps to deploy the application. | 366 | Follow these steps to deploy the application. |
349 | <orderedlist> | 367 | <orderedlist> |
350 | <listitem><para>Select Run -> Debug Configurations...</para></listitem> | 368 | <listitem><para>Select <filename>Run -> Debug Configurations...</filename></para></listitem> |
351 | <listitem><para>In the left area expand “C/C++Remote Application”.</para></listitem> | 369 | <listitem><para>In the left area expand <filename>C/C++Remote Application</filename>.</para></listitem> |
352 | <listitem><para>Locate your project and select it to bring up a new | 370 | <listitem><para>Locate your project and select it to bring up a new |
353 | tabbed view in the Debug Configurations dialogue.</para></listitem> | 371 | tabbed view in the <filename>Debug Configurations</filename> Dialog.</para></listitem> |
354 | <listitem><para>Enter the absolute path into which you want to deploy | 372 | <listitem><para>Enter the absolute path into which you want to deploy |
355 | the application. | 373 | the application. |
356 | Use the Remote Absolute File Path for C/C++Application:. | 374 | Use the <filename>Remote Absolute File Path</filename> for <filename>C/C++Application:</filename>. |
357 | For example, enter <filename>/usr/bin/<programname></filename>.</para></listitem> | 375 | For example, enter <filename>/usr/bin/<programname></filename>.</para></listitem> |
358 | <listitem><para>Click on the Debugger tab to see the cross-tool debugger | 376 | <listitem><para>Click on the <filename>Debugger</filename> tab to see the cross-tool debugger |
359 | you are using.</para></listitem> | 377 | you are using.</para></listitem> |
360 | <listitem><para>Create a new connection to the QEMU instance | 378 | <listitem><para>Create a new connection to the QEMU instance |
361 | by clicking on “new”.</para></listitem> | 379 | by clicking on <filename>new</filename>.</para></listitem> |
362 | <listitem><para>Select “TCF, which means Target Communication Framework.</para></listitem> | 380 | <listitem><para>Select <filename>TCF</filename>, which means Target Communication |
363 | <listitem><para>Click “Next”.</para></listitem> | 381 | Framework.</para></listitem> |
364 | <listitem><para>Clear out the “host name” field and enter the IP Address | 382 | <listitem><para>Click <filename>Next</filename>.</para></listitem> |
383 | <listitem><para>Clear out the <filename>host name</filename> field and enter the IP Address | ||
365 | determined earlier.</para></listitem> | 384 | determined earlier.</para></listitem> |
366 | <listitem><para>Click Finish to close the new connections dialogue.</para></listitem> | 385 | <listitem><para>Click <filename>Finish</filename> to close the new connections |
367 | <listitem><para>Use the drop-down menu now in the “Connection” field and pick | 386 | Dialog.</para></listitem> |
387 | <listitem><para>Use the drop-down menu now in the <filename>Connection</filename> field and pick | ||
368 | the IP Address you entered.</para></listitem> | 388 | the IP Address you entered.</para></listitem> |
369 | <listitem><para>Click “Debug” to bring up a login screen and login.</para></listitem> | 389 | <listitem><para>Click <filename>Debug</filename> to bring up a login screen |
390 | and login.</para></listitem> | ||
370 | <listitem><para>Accept the debug perspective.</para></listitem> | 391 | <listitem><para>Accept the debug perspective.</para></listitem> |
371 | </orderedlist> | 392 | </orderedlist> |
372 | </para> | 393 | </para> |
@@ -379,49 +400,52 @@ | |||
379 | your development experience. | 400 | your development experience. |
380 | These tools are aids in developing and debugging applications and images. | 401 | These tools are aids in developing and debugging applications and images. |
381 | You can run these user-space tools from within the Yocto Eclipse | 402 | You can run these user-space tools from within the Yocto Eclipse |
382 | Plug-in through the Window -> YoctoTools menu. | 403 | Plug-in through the <filename>Window -> YoctoTools</filename> menu. |
383 | </para> | 404 | </para> |
384 | <para> | 405 | <para> |
385 | Once you pick a tool you need to configure it for the remote target. | 406 | Once you pick a tool, you need to configure it for the remote target. |
386 | Every tool needs to have the connection configured. | 407 | Every tool needs to have the connection configured. |
387 | You must select an existing TCF-based RSE connection to the remote target. | 408 | You must select an existing TCF-based RSE connection to the remote target. |
388 | If one does not exist, click "New" to create one. | 409 | If one does not exist, click <filename>New</filename> to create one. |
389 | </para> | 410 | </para> |
390 | <para> | 411 | <para> |
391 | Here are some specifics about the remote tools: | 412 | Here are some specifics about the remote tools: |
392 | <itemizedlist> | 413 | <itemizedlist> |
393 | <listitem><para><emphasis>OProfile:</emphasis> Selecting this tool causes | 414 | <listitem><para><emphasis><filename>OProfile</filename>:</emphasis> Selecting this tool causes |
394 | the oprofile-server on the remote target to launch on the local host machine. | 415 | the <filename>oprofile-server</filename> on the remote target to launch on |
395 | The oprofile-viewer must be installed on the local host machine and the | 416 | the local host machine. |
396 | oprofile-server must be installed on the remote target, respectively, in order | 417 | The <filename>oprofile-viewer</filename> must be installed on the local host machine and the |
397 | to use. | 418 | <filename>oprofile-server</filename> must be installed on the remote target, |
419 | respectively, in order to use. | ||
398 | You can locate both the viewer and server from | 420 | You can locate both the viewer and server from |
399 | <ulink url='http://git.yoctoproject.org/cgit/cgit.cgi/oprofileui/'></ulink>. | 421 | <ulink url='http://git.yoctoproject.org/cgit/cgit.cgi/oprofileui/'></ulink>. |
400 | You need to compile and install the oprofile-viewer from the source code | 422 | You need to compile and install the <filename>oprofile-viewer</filename> from the source code |
401 | on your local host machine. | 423 | on your local host machine. |
402 | The oprofile-server is installed by default in the image.</para></listitem> | 424 | The <filename>oprofile-server</filename> is installed by default in the image.</para></listitem> |
403 | <listitem><para><emphasis>Lttng-ust:</emphasis> Selecting this tool runs | 425 | <listitem><para><emphasis><filename>Lttng-ust</filename>:</emphasis> Selecting this tool runs |
404 | <filename>usttrace</filename> on the remote target, transfers the output data back to the | 426 | <filename>usttrace</filename> on the remote target, transfers the output data back to the |
405 | local host machine and uses <filename>lttv-gui</filename> to graphically display the output. | 427 | local host machine and uses <filename>lttv-gui</filename> to graphically display the output. |
406 | The <filename>lttv-gui</filename> must be installed on the local host machine to use this tool. | 428 | The <filename>lttv-gui</filename> must be installed on the local host machine to use this tool. |
407 | For information on how to use <filename>lttng</filename> to trace an application, see | 429 | For information on how to use <filename>lttng</filename> to trace an application, see |
408 | <ulink url='http://lttng.org/files/ust/manual/ust.html'></ulink>.</para> | 430 | <ulink url='http://lttng.org/files/ust/manual/ust.html'></ulink>.</para> |
409 | <para>For "Application" you must supply the absolute path name of the | 431 | <para>For <filename>Application</filename>, you must supply the absolute path name of the |
410 | application to be traced by user mode lttng. | 432 | application to be traced by user mode <filename>lttng</filename>. |
411 | For example, typing <filename>/path/to/foo</filename> triggers | 433 | For example, typing <filename>/path/to/foo</filename> triggers |
412 | <filename>usttrace /path/to/foo</filename> on the remote target to trace the | 434 | <filename>usttrace /path/to/foo</filename> on the remote target to trace the |
413 | program <filename>/path/to/foo</filename>.</para> | 435 | program <filename>/path/to/foo</filename>.</para> |
414 | <para>"Argument" is passed to <filename>usttrace</filename> | 436 | <para><filename>Argument</filename> is passed to <filename>usttrace</filename> |
415 | running on the remote target.</para></listitem> | 437 | running on the remote target.</para></listitem> |
416 | <listitem><para><emphasis>PowerTOP:</emphasis> Selecting this tool runs | 438 | <listitem><para><emphasis><filename>PowerTOP</filename>:</emphasis> Selecting this tool runs |
417 | "PowerTOP" on the remote target machine and displays the results in a | 439 | <filename>powertop</filename> on the remote target machine and displays the results in a |
418 | new view called "powertop".</para> | 440 | new view called <filename>powertop</filename>.</para> |
419 | <para>"Time to gather data(sec):" is the time passed in seconds before data | 441 | <para><filename>Time to gather data(sec):</filename> is the time passed in seconds before data |
420 | is gathered from the remote target for analysis.</para> | 442 | is gathered from the remote target for analysis.</para> |
421 | <para>"show pids in wakeups list:" corresponds to the <filename>-p</filename> argument | 443 | <para><filename>show pids in wakeups list:</filename> corresponds to the |
444 | <filename>-p</filename> argument | ||
422 | passed to <filename>powertop</filename>.</para></listitem> | 445 | passed to <filename>powertop</filename>.</para></listitem> |
423 | <listitem><para><emphasis>LatencyTOP and Perf:</emphasis> "LatencyTOP" | 446 | <listitem><para><emphasis><filename>LatencyTOP and Perf</filename>:</emphasis> |
424 | identifies system latency, while <filename>perf</filename> monitors the system's | 447 | <filename>latencytop</filename> identifies system latency, while |
448 | <filename>perf</filename> monitors the system's | ||
425 | performance counter registers. | 449 | performance counter registers. |
426 | Selecting either of these tools causes an RSE terminal view to appear | 450 | Selecting either of these tools causes an RSE terminal view to appear |
427 | from which you can run the tools. | 451 | from which you can run the tools. |