summaryrefslogtreecommitdiffstats
path: root/documentation/poky-ref-manual
diff options
context:
space:
mode:
Diffstat (limited to 'documentation/poky-ref-manual')
-rw-r--r--documentation/poky-ref-manual/development.xml138
1 files changed, 69 insertions, 69 deletions
diff --git a/documentation/poky-ref-manual/development.xml b/documentation/poky-ref-manual/development.xml
index 7a39c96c7a..0fd9adbe4b 100644
--- a/documentation/poky-ref-manual/development.xml
+++ b/documentation/poky-ref-manual/development.xml
@@ -114,12 +114,12 @@
114 <para> 114 <para>
115 Do the following to install the Yocto plug-in into the Eclipse IDE: 115 Do the following to install the Yocto plug-in into the Eclipse IDE:
116 <orderedlist> 116 <orderedlist>
117 <listitem>Select the "Help -> Install New Software" item.</listitem> 117 <listitem><para>Select the "Help -> Install New Software" item.</para></listitem>
118 <listitem>In the "Work with:" area click "Add..." and enter the URL for 118 <listitem><para>In the "Work with:" area click "Add..." and enter the URL for
119 the Yocto plug-in, which is 119 the Yocto plug-in, which is
120 <ulink url='http://www.yoctoproject.org/downloads/eclipse-plugin/'></ulink></listitem> 120 <ulink url='http://www.yoctoproject.org/downloads/eclipse-plugin/'></ulink></para></listitem>
121 <listitem>Finish out the installation of the update similar to any other 121 <listitem><para>Finish out the installation of the update similar to any other
122 Eclipse plug-in.</listitem> 122 Eclipse plug-in.</para></listitem>
123 </orderedlist> 123 </orderedlist>
124 </para> 124 </para>
125 </section> 125 </section>
@@ -166,11 +166,11 @@
166 The following steps show how to create a Yocto autotools-based project using a given template: 166 The following steps show how to create a Yocto autotools-based project using a given template:
167 </para> 167 </para>
168 <orderedlist> 168 <orderedlist>
169 <listitem>Select "File -> New -> Project" to start the wizard.</listitem> 169 <listitem><para>Select "File -> New -> Project" to start the wizard.</para></listitem>
170 <listitem>Expand "C/C++" and select "C Project".</listitem> 170 <listitem><para>Expand "C/C++" and select "C Project".</para></listitem>
171 <listitem>Click "Next" and select a template (e.g. "Hello World ANSI C Project").</listitem> 171 <listitem><para>Click "Next" and select a template (e.g. "Hello World ANSI C Project").</para></listitem>
172 <listitem>Complete the steps to create the new Yocto autotools-based project using 172 <listitem><para>Complete the steps to create the new Yocto autotools-based project using
173 your chosen template.</listitem> 173 your chosen template.</para></listitem>
174 </orderedlist> 174 </orderedlist>
175 <para> 175 <para>
176 By default, the project uses the Yocto preferences settings as defined using the procedure in 176 By default, the project uses the Yocto preferences settings as defined using the procedure in
@@ -179,38 +179,38 @@
179 you need to reconfigure the Yocto plug-in through the menu selection by doing the following: 179 you need to reconfigure the Yocto plug-in through the menu selection by doing the following:
180 </para> 180 </para>
181 <orderedlist> 181 <orderedlist>
182 <listitem>Select the "Project -> Invoke Yocto Tools -> Reconfigure Yocto" menu item.</listitem> 182 <listitem><para>Select the "Project -> Invoke Yocto Tools -> Reconfigure Yocto" menu item.</para></listitem>
183 <listitem>Complete the dialogue to specify the specific toolchain and QEMU setup information.</listitem> 183 <listitem><para>Complete the dialogue to specify the specific toolchain and QEMU setup information.</para></listitem>
184 </orderedlist> 184 </orderedlist>
185 <para> 185 <para>
186 To build the project follow these steps: 186 To build the project follow these steps:
187 </para> 187 </para>
188 <orderedlist> 188 <orderedlist>
189 <listitem>Select "Project -> Reconfigure Project" to trigger the 189 <listitem><para>Select "Project -> Reconfigure Project" to trigger the
190 <filename>autogen.sh</filename> command.</listitem> 190 <filename>autogen.sh</filename> command.</para></listitem>
191 <listitem>Select "Project -> Build" to build the project.</listitem> 191 <listitem><para>Select "Project -> Build" to build the project.</para></listitem>
192 </orderedlist> 192 </orderedlist>
193 <para> 193 <para>
194 To start QEMU follow these steps: 194 To start QEMU follow these steps:
195 </para> 195 </para>
196 <orderedlist> 196 <orderedlist>
197 <listitem>Select "Run -> External Tools" and see if there is 197 <listitem><para>Select "Run -> External Tools" and see if there is
198 a QEMU instance for the desired target. 198 a QEMU instance for the desired target.
199 If one exists, click on the instance to start QEMU. 199 If one exists, click on the instance to start QEMU.
200 If your target does not exist, click "External Tools Configuration" and 200 If your target does not exist, click "External Tools Configuration" and
201 you should find an instance of QEMU for your architecture 201 you should find an instance of QEMU for your architecture
202 under the entry under "Program".</listitem> 202 under the entry under "Program".</para></listitem>
203 <listitem>Wait for the boot to complete.</listitem> 203 <listitem><para>Wait for the boot to complete.</para></listitem>
204 </orderedlist> 204 </orderedlist>
205 <para> 205 <para>
206 To deploy your project and start debugging follow these steps: 206 To deploy your project and start debugging follow these steps:
207 </para> 207 </para>
208 <orderedlist> 208 <orderedlist>
209 <listitem>Highlight your project in the project explorer.</listitem> 209 <listitem><para>Highlight your project in the project explorer.</para></listitem>
210 <listitem>Select "Run -> Debug Configurations" to bring up your remote debugging configuration 210 <listitem><para>Select "Run -> Debug Configurations" to bring up your remote debugging configuration
211 in the right-hand window.</listitem> 211 in the right-hand window.</para></listitem>
212 <listitem>Expand “C/C++ Remote Application”.</listitem> 212 <listitem><para>Expand “C/C++ Remote Application”.</para></listitem>
213 <listitem>Select "projectname_ gdb_target-poky-linux". 213 <listitem><para>Select "projectname_ gdb_target-poky-linux".
214 You need to be sure there is an entry for the remote target. 214 You need to be sure there is an entry for the remote target.
215 If no entry exists, click "New..." to bring up the wizard. 215 If no entry exists, click "New..." to bring up the wizard.
216 Use the wizard to select TCF and enter the IP address of you remote target in the 216 Use the wizard to select TCF and enter the IP address of you remote target in the
@@ -219,8 +219,8 @@
219 “Remote Absolute File Path for C/C++ Application” field the absolute path for the program on 219 “Remote Absolute File Path for C/C++ Application” field the absolute path for the program on
220 the remote target. 220 the remote target.
221 By default, the program deploys into the remote target. 221 By default, the program deploys into the remote target.
222 If you don't want this behavior then check “Skip download to target path”.</listitem> 222 If you don't want this behavior then check “Skip download to target path”.</para></listitem>
223 <listitem>Click "Debug” to start the remote debugging session.</listitem> 223 <listitem><para>Click "Debug” to start the remote debugging session.</para></listitem>
224 </orderedlist> 224 </orderedlist>
225 </section> 225 </section>
226 226
@@ -239,11 +239,11 @@
239 <para> 239 <para>
240 Here are some specifics about the remote tools: 240 Here are some specifics about the remote tools:
241 <itemizedlist> 241 <itemizedlist>
242 <listitem>OProfile: Selecting this tool causes the oprofile-server on the remote 242 <listitem><para>OProfile: Selecting this tool causes the oprofile-server on the remote
243 target to launch on the local host machine. The oprofile-viewer 243 target to launch on the local host machine. The oprofile-viewer
244 must be installed on the local host machine and the oprofile-server must be 244 must be installed on the local host machine and the oprofile-server must be
245 installed on the remote target, respectively, in order to use .</listitem> 245 installed on the remote target, respectively, in order to use .</para></listitem>
246 <listitem>lttng: Selecting this tool runs "usttrace" on the remote target, transfers 246 <listitem><para>lttng: Selecting this tool runs "usttrace" on the remote target, transfers
247 the output data back to the local host machine and uses "lttv-gui" to graphically 247 the output data back to the local host machine and uses "lttv-gui" to graphically
248 display the output. The "lttv-gui" must be installed on the 248 display the output. The "lttv-gui" must be installed on the
249 local host machine to use this tool. 249 local host machine to use this tool.
@@ -257,9 +257,9 @@
257 </para> 257 </para>
258 <para> 258 <para>
259 "Argument" is passed to "usttrace" running on the remote target. 259 "Argument" is passed to "usttrace" running on the remote target.
260 </para> 260 </para></para>
261 </listitem> 261 </listitem>
262 <listitem>powertop: Selecting this tool runs "powertop" on the 262 <listitem><para>powertop: Selecting this tool runs "powertop" on the
263 remote target machine and displays the results in a new view called "powertop". 263 remote target machine and displays the results in a new view called "powertop".
264 <para> 264 <para>
265 "Time to gather data(sec):" is the time passed in seconds before data is 265 "Time to gather data(sec):" is the time passed in seconds before data is
@@ -268,13 +268,13 @@
268 <para> 268 <para>
269 "show pids in wakeups list:" corresponds to the <filename>-p</filename> 269 "show pids in wakeups list:" corresponds to the <filename>-p</filename>
270 argument passed to "powertop". 270 argument passed to "powertop".
271 </para> 271 </para></para>
272 </listitem> 272 </listitem>
273 <listitem>latencytop and perf: "latencytop" identifies 273 <listitem><para>latencytop and perf: "latencytop" identifies
274 system latency, while "perf" monitors the system's performance 274 system latency, while "perf" monitors the system's performance
275 counter registers. Selecting either of these tools causes an RSE 275 counter registers. Selecting either of these tools causes an RSE
276 terminal view to appear from which you can run the tools. Both tools refresh the 276 terminal view to appear from which you can run the tools. Both tools refresh the
277 entire screen to display results while they run.</listitem> 277 entire screen to display results while they run.</para></listitem>
278 </itemizedlist> 278 </itemizedlist>
279 </para> 279 </para>
280 </section> 280 </section>
@@ -317,16 +317,16 @@
317 <para> 317 <para>
318 Follow these steps to set up the plug-in: 318 Follow these steps to set up the plug-in:
319 <orderedlist> 319 <orderedlist>
320 <listitem>Extract the tarball for the toolchain into / as root. 320 <listitem><para>Extract the tarball for the toolchain into / as root.
321 The toolchain will be installed into <filename>/opt/poky</filename>.</listitem> 321 The toolchain will be installed into <filename>/opt/poky</filename>.</para></listitem>
322 <listitem>To use the plug-in, first open or create an existing project. 322 <listitem><para>To use the plug-in, first open or create an existing project.
323 If you are creating a new project, the "C GTK+" 323 If you are creating a new project, the "C GTK+"
324 project type will allow itself to be cross-compiled. 324 project type will allow itself to be cross-compiled.
325 However, you should be aware that this type uses "glade" for the UI.</listitem> 325 However, you should be aware that this type uses "glade" for the UI.</para></listitem>
326 <listitem>To activate the plug-in, select "Edit -> Preferences" and then choose 326 <listitem><para>To activate the plug-in, select "Edit -> Preferences" and then choose
327 "General" from the left hand side. 327 "General" from the left hand side.
328 Choose the "Installed plug-ins" tab, scroll down to "Poky SDK" and 328 Choose the "Installed plug-ins" tab, scroll down to "Poky SDK" and
329 check the box.</listitem> 329 check the box.</para></listitem>
330 </orderedlist> 330 </orderedlist>
331 The plug-in is now activated but not configured. 331 The plug-in is now activated but not configured.
332 </para> 332 </para>
@@ -338,29 +338,29 @@
338 SDK icon from the left hand side. 338 SDK icon from the left hand side.
339 You need to define the following options: 339 You need to define the following options:
340 <itemizedlist> 340 <itemizedlist>
341 <listitem>SDK root: If you use an external toolchain you need to set 341 <listitem><para>SDK root: If you use an external toolchain you need to set
342 SDK root, which is the root directory of the SDK's sysroot. 342 SDK root, which is the root directory of the SDK's sysroot.
343 For an i586 SDK directory is <filename>/opt/poky/</filename>. 343 For an i586 SDK directory is <filename>/opt/poky/</filename>.
344 This directory will contain "bin", "include", "var" and so forth under your 344 This directory will contain "bin", "include", "var" and so forth under your
345 selected target architecture subdirectory 345 selected target architecture subdirectory
346 <filename>/opt/poky/sysroot/i586-poky-linux/</filename>. 346 <filename>/opt/poky/sysroot/i586-poky-linux/</filename>.
347 The cross-compile tools you need are in 347 The cross-compile tools you need are in
348 <filename>/opt/poky/sysroot/i586-pokysdk-linux/</filename>.</listitem> 348 <filename>/opt/poky/sysroot/i586-pokysdk-linux/</filename>.</para></listitem>
349 <listitem>Poky root: If you have a local Poky build tree, you need to 349 <listitem><para>Poky root: If you have a local Poky build tree, you need to
350 set the Poky root, which is the root directory of the poky build tree. 350 set the Poky root, which is the root directory of the poky build tree.
351 If you build your i586 target architecture under the subdirectory of 351 If you build your i586 target architecture under the subdirectory of
352 <filename>build_x86</filename> within your Poky tree, the Poky root directory 352 <filename>build_x86</filename> within your Poky tree, the Poky root directory
353 should be <filename>$&lt;poky_tree&gt;/build_x86/</filename>.</listitem> 353 should be <filename>$&lt;poky_tree&gt;/build_x86/</filename>.</para></listitem>
354 <listitem>Target Architecture: This is the cross compile triplet, 354 <listitem><para>Target Architecture: This is the cross compile triplet,
355 for example, "i586-poky-linux". 355 for example, "i586-poky-linux".
356 This target triplet is the prefix extracted from the set up script file's name. 356 This target triplet is the prefix extracted from the set up script file's name.
357 For example, if the script file name is 357 For example, if the script file name is
358 <filename>/opt/poky/environment-setup-i586-poky-linux</filename> then the extracted target 358 <filename>/opt/poky/environment-setup-i586-poky-linux</filename> then the extracted target
359 triplet is "i586-poky-linux".</listitem> 359 triplet is "i586-poky-linux".</para></listitem>
360 <listitem>Kernel: Use the file chooser to select the kernel used with QEMU.</listitem> 360 <listitem><para>Kernel: Use the file chooser to select the kernel used with QEMU.</para></listitem>
361 <listitem>Root filesystem: Use the file chooser to select the root 361 <listitem><para>Root filesystem: Use the file chooser to select the root
362 filesystem directory. This directory is where you use "poky-extract-sdk" to extract the 362 filesystem directory. This directory is where you use "poky-extract-sdk" to extract the
363 poky-image-sdk tarball.</listitem> 363 poky-image-sdk tarball.</para></listitem>
364 </itemizedlist> 364 </itemizedlist>
365 </para> 365 </para>
366 </section> 366 </section>
@@ -370,25 +370,25 @@
370 The steps in this section show how to cross-compile a project, deploy it into 370 The steps in this section show how to cross-compile a project, deploy it into
371 QEMU, run a debugger against it and then perform a system-wide profile. 371 QEMU, run a debugger against it and then perform a system-wide profile.
372 <orderedlist> 372 <orderedlist>
373 <listitem>Choose "Build -> Run Configure" or "Build -> Run Autogenerate" to run 373 <listitem><para>Choose "Build -> Run Configure" or "Build -> Run Autogenerate" to run
374 "configure" or "autogen", respectively for the project. 374 "configure" or "autogen", respectively for the project.
375 Either command passes command-line arguments to instruct the 375 Either command passes command-line arguments to instruct the
376 cross-compile.</listitem> 376 cross-compile.</para></listitem>
377 <listitem>Choose "Build -> Build Project" to build and compile the project. 377 <listitem><para>Choose "Build -> Build Project" to build and compile the project.
378 If you have previously built the project in the same tree without using 378 If you have previously built the project in the same tree without using
379 the cross-compiler you might find that your project fails to link. 379 the cross-compiler you might find that your project fails to link.
380 If this is the case, simply select "Build -> Clean Project" to remove the 380 If this is the case, simply select "Build -> Clean Project" to remove the
381 old binaries. 381 old binaries.
382 After you clean the project you can then try building it again.</listitem> 382 After you clean the project you can then try building it again.</para></listitem>
383 <listitem>Choose "Tools -> Start QEMU" to start QEMU. 383 <listitem><para>Choose "Tools -> Start QEMU" to start QEMU.
384 After QEMU starts any error messages will appear in the message view. 384 After QEMU starts any error messages will appear in the message view.
385 Once Poky has fully booted within QEMU you can deploy the project 385 Once Poky has fully booted within QEMU you can deploy the project
386 into it.</listitem> 386 into it.</para></listitem>
387 <listitem>Once the project is built and you have QEMU running choose 387 <listitem><para>Once the project is built and you have QEMU running choose
388 "Tools -> Deploy" to install the package into a temporary 388 "Tools -> Deploy" to install the package into a temporary
389 directory and then copy it using "rsync" over SSH into the target. 389 directory and then copy it using "rsync" over SSH into the target.
390 A progress bar and appropriate messages appear in the message view.</listitem> 390 A progress bar and appropriate messages appear in the message view.</para></listitem>
391 <listitem>To debug a program installed onto the target choose 391 <listitem><para>To debug a program installed onto the target choose
392 "Tools -> Debug remote". 392 "Tools -> Debug remote".
393 Choosing this menu item causes prompts to appear to define the local binary 393 Choosing this menu item causes prompts to appear to define the local binary
394 for debugging and also for the command line used to run on the target. 394 for debugging and also for the command line used to run on the target.
@@ -402,16 +402,16 @@
402 target program. 402 target program.
403 You should define any breakpoints or watchpoints at this point in the process since you might not 403 You should define any breakpoints or watchpoints at this point in the process since you might not
404 be able to interrupt the execution later. 404 be able to interrupt the execution later.
405 To stop the debugger on the target choose "Tools -> Stop debugger".</listitem> 405 To stop the debugger on the target choose "Tools -> Stop debugger".</para></listitem>
406 <listitem>It is also possible to execute a command in the target over SSH. 406 <listitem><para>It is also possible to execute a command in the target over SSH.
407 Doing so causes the appropriate environment to be established for execution. 407 Doing so causes the appropriate environment to be established for execution.
408 To execute a command choose "Choose Tools -> Run remote". 408 To execute a command choose "Choose Tools -> Run remote".
409 This selection opens a terminal with the SSH command inside.</listitem> 409 This selection opens a terminal with the SSH command inside.</para></listitem>
410 <listitem>To perform a system-wide profile against the system running in QEMU choose 410 <listitem><para>To perform a system-wide profile against the system running in QEMU choose
411 "Tools -> Profile remote". 411 "Tools -> Profile remote".
412 This choice starts up "OProfileUI" with the appropriate parameters to 412 This choice starts up "OProfileUI" with the appropriate parameters to
413 connect to the server running inside QEMU and also supplies the path 413 connect to the server running inside QEMU and also supplies the path
414 for debug information necessary to get a useful profile.</listitem> 414 for debug information necessary to get a useful profile.</para></listitem>
415 </orderedlist> 415 </orderedlist>
416 </para> 416 </para>
417 </section> 417 </section>
@@ -521,9 +521,9 @@
521 This command opens a terminal with a shell prompt within the Poky 521 This command opens a terminal with a shell prompt within the Poky
522 environment. Consequently, the following occurs: 522 environment. Consequently, the following occurs:
523 <itemizedlist> 523 <itemizedlist>
524 <listitem>The PATH variable includes the cross toolchain.</listitem> 524 <listitem><para>The PATH variable includes the cross toolchain.</para></listitem>
525 <listitem>The pkgconfig variables find the correct <filename>.pc</filename> files.</listitem> 525 <listitem><para>The pkgconfig variables find the correct <filename>.pc</filename> files.</para></listitem>
526 <listitem>"configure" finds the Poky site files as well as any other necessary files.</listitem> 526 <listitem><para>"configure" finds the Poky site files as well as any other necessary files.</para></listitem>
527 </itemizedlist> 527 </itemizedlist>
528 Within this environment, you can run "configure" or "compile" commands as if they 528 Within this environment, you can run "configure" or "compile" commands as if they
529 were being run by Poky itself. 529 were being run by Poky itself.
@@ -732,14 +732,14 @@ tmp/sysroots/&lt;host-arch&lt;/usr/bin/&lt;target-abi&gt;-gdb
732 These steps show how to build the custom directory of files: 732 These steps show how to build the custom directory of files:
733 </para> 733 </para>
734 <orderedlist> 734 <orderedlist>
735 <listitem>Install the package (<filename>foo</filename> in this case) to 735 <listitem><para>Install the package (<filename>foo</filename> in this case) to
736 <filename>tmp/rootfs</filename>: 736 <filename>tmp/rootfs</filename>:
737 <programlisting> 737 <programlisting>
738tmp/sysroots/i686-linux/usr/bin/opkg-cl -f \ 738tmp/sysroots/i686-linux/usr/bin/opkg-cl -f \
739tmp/work/&lt;target-abi&gt;/poky-image-sato-1.0-r0/temp/opkg.conf -o \ 739tmp/work/&lt;target-abi&gt;/poky-image-sato-1.0-r0/temp/opkg.conf -o \
740tmp/rootfs/ update 740tmp/rootfs/ update
741 </programlisting></listitem> 741 </programlisting></para></listitem>
742 <listitem>Install the debugging information: 742 <listitem><para>Install the debugging information:
743 <programlisting> 743 <programlisting>
744tmp/sysroots/i686-linux/usr/bin/opkg-cl -f \ 744tmp/sysroots/i686-linux/usr/bin/opkg-cl -f \
745tmp/work/&lt;target-abi&gt;/poky-image-sato-1.0-r0/temp/opkg.conf \ 745tmp/work/&lt;target-abi&gt;/poky-image-sato-1.0-r0/temp/opkg.conf \
@@ -748,7 +748,7 @@ tmp/work/&lt;target-abi&gt;/poky-image-sato-1.0-r0/temp/opkg.conf \
748tmp/sysroots/i686-linux/usr/bin/opkg-cl -f \ 748tmp/sysroots/i686-linux/usr/bin/opkg-cl -f \
749tmp/work/&lt;target-abi&gt;/poky-image-sato-1.0-r0/temp/opkg.conf \ 749tmp/work/&lt;target-abi&gt;/poky-image-sato-1.0-r0/temp/opkg.conf \
750-o tmp/rootfs install foo-dbg 750-o tmp/rootfs install foo-dbg
751 </programlisting></listitem> 751 </programlisting></para></listitem>
752 </orderedlist> 752 </orderedlist>
753 753
754 </section> 754 </section>