diff options
author | Scott Rifenbark <scott.m.rifenbark@intel.com> | 2012-06-28 15:02:25 -0700 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2012-06-29 13:31:02 +0100 |
commit | 347424e558a8d6db1c82f3bb1dbbf7b7b574566b (patch) | |
tree | bbbd956d7e1e39e7aeb5695418b376917d28e0fa /documentation/adt-manual/adt-prepare.xml | |
parent | 7a4cc0e8845fbee6a9066e8d83a90bcb8acc96be (diff) | |
download | poky-347424e558a8d6db1c82f3bb1dbbf7b7b574566b.tar.gz |
documentation/adt-manual: Adjustments to Yocto Project term
Changes throughout the manual that either eliminate or change
many of the "Yocto Project" strings. The file structure for
the meta data is now called "source directory." The build
directory is referred as just that - "build directory." Any
where the build system is referred to it is called the
"OpenEmbedded build system."
(From yocto-docs rev: 1210c19f90d4a52042fec12657212ae3e58e13d6)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/adt-manual/adt-prepare.xml')
-rw-r--r-- | documentation/adt-manual/adt-prepare.xml | 54 |
1 files changed, 27 insertions, 27 deletions
diff --git a/documentation/adt-manual/adt-prepare.xml b/documentation/adt-manual/adt-prepare.xml index c3e4f6e987..0cda17846c 100644 --- a/documentation/adt-manual/adt-prepare.xml +++ b/documentation/adt-manual/adt-prepare.xml | |||
@@ -51,8 +51,8 @@ | |||
51 | If you use this method, you just get the cross-toolchain and QEMU - you do not | 51 | If you use this method, you just get the cross-toolchain and QEMU - you do not |
52 | get any of the other mentioned benefits had you run the ADT Installer script.</para></listitem> | 52 | get any of the other mentioned benefits had you run the ADT Installer script.</para></listitem> |
53 | <listitem><para><emphasis>Use the Toolchain from within a Yocto Project Build Tree:</emphasis> | 53 | <listitem><para><emphasis>Use the Toolchain from within a Yocto Project Build Tree:</emphasis> |
54 | If you already have a Yocto Project build tree, you can build the cross-toolchain | 54 | If you already have a build directory, you can build the cross-toolchain |
55 | within tree. | 55 | within that structure. |
56 | However, like the previous method mentioned, you only get the cross-toolchain and QEMU - you | 56 | However, like the previous method mentioned, you only get the cross-toolchain and QEMU - you |
57 | do not get any of the other benefits without taking separate steps.</para></listitem> | 57 | do not get any of the other benefits without taking separate steps.</para></listitem> |
58 | </itemizedlist> | 58 | </itemizedlist> |
@@ -75,22 +75,21 @@ | |||
75 | <ulink url='&YOCTO_DL_URL;/releases'>Index of Releases</ulink>, specifically | 75 | <ulink url='&YOCTO_DL_URL;/releases'>Index of Releases</ulink>, specifically |
76 | at | 76 | at |
77 | <ulink url='&YOCTO_ADTINSTALLER_DL_URL;'></ulink>. | 77 | <ulink url='&YOCTO_ADTINSTALLER_DL_URL;'></ulink>. |
78 | Or, you can use BitBake to generate the tarball inside the existing Yocto Project | 78 | Or, you can use BitBake to generate the tarball inside the existing build directory. |
79 | build tree. | ||
80 | </para> | 79 | </para> |
81 | 80 | ||
82 | <para> | 81 | <para> |
83 | If you use BitBake to generate the ADT Installer tarball, you must | 82 | If you use BitBake to generate the ADT Installer tarball, you must |
84 | <filename>source</filename> the Yocto Project environment setup script | 83 | <filename>source</filename> the environment setup script |
85 | (<filename>oe-init-build-env</filename>) located | 84 | (<filename>oe-init-build-env</filename>) located |
86 | in the Yocto Project file structure before running the <filename>bitbake</filename> | 85 | in the source directory before running the <filename>bitbake</filename> |
87 | command that creates the tarball. | 86 | command that creates the tarball. |
88 | </para> | 87 | </para> |
89 | 88 | ||
90 | <para> | 89 | <para> |
91 | The following example commands download the Yocto Project release tarball, set up the Yocto | 90 | The following example commands download the Yocto Project release tarball, set up the |
92 | Project files structure, set up the environment while also creating the | 91 | source directory, set up the environment while also creating the |
93 | default Yocto Project build tree, | 92 | default build directory, |
94 | and run the <filename>bitbake</filename> command that results in the tarball | 93 | and run the <filename>bitbake</filename> command that results in the tarball |
95 | <filename>~/yocto-project/build/tmp/deploy/sdk/adt_installer.tar.bz2</filename>: | 94 | <filename>~/yocto-project/build/tmp/deploy/sdk/adt_installer.tar.bz2</filename>: |
96 | <literallayout class='monospaced'> | 95 | <literallayout class='monospaced'> |
@@ -151,7 +150,7 @@ | |||
151 | or not to install the emulator QEMU.</para></listitem> | 150 | or not to install the emulator QEMU.</para></listitem> |
152 | <listitem><para><filename>YOCTOADT_NFS_UTIL</filename>: Indicates whether | 151 | <listitem><para><filename>YOCTOADT_NFS_UTIL</filename>: Indicates whether |
153 | or not to install user-mode NFS. | 152 | or not to install user-mode NFS. |
154 | If you plan to use the Yocto Eclipse IDE plug-in against QEMU, | 153 | If you plan to use the Eclipse IDE Yocto plug-in against QEMU, |
155 | you should install NFS. | 154 | you should install NFS. |
156 | <note>To boot QEMU images using our userspace NFS server, you need | 155 | <note>To boot QEMU images using our userspace NFS server, you need |
157 | to be running <filename>portmap</filename> or <filename>rpcbind</filename>. | 156 | to be running <filename>portmap</filename> or <filename>rpcbind</filename>. |
@@ -244,17 +243,17 @@ | |||
244 | poky-eglibc-x86_64-i586-toolchain-gmae-&DISTRO;.tar.bz2 | 243 | poky-eglibc-x86_64-i586-toolchain-gmae-&DISTRO;.tar.bz2 |
245 | </literallayout> | 244 | </literallayout> |
246 | <note><para>As an alternative to steps one and two, you can build the toolchain tarball | 245 | <note><para>As an alternative to steps one and two, you can build the toolchain tarball |
247 | if you have a Yocto Project build tree. | 246 | if you have a build directory. |
248 | If you need GMAE, you should use the <filename>bitbake meta-toolchain-gmae</filename> | 247 | If you need GMAE, you should use the <filename>bitbake meta-toolchain-gmae</filename> |
249 | command. | 248 | command. |
250 | The resulting tarball will support such development. | 249 | The resulting tarball will support such development. |
251 | However, if you are not concerned with GMAE, | 250 | However, if you are not concerned with GMAE, |
252 | you can generate the tarball using <filename>bitbake meta-toolchain</filename>.</para> | 251 | you can generate the tarball using <filename>bitbake meta-toolchain</filename>.</para> |
253 | <para>Use the appropriate <filename>bitbake</filename> command only after you have | 252 | <para>Use the appropriate <filename>bitbake</filename> command only after you have |
254 | sourced the <filename>oe-build-init-env</filename> script located in the Yocto | 253 | sourced the <filename>oe-build-init-env</filename> script located in the source |
255 | Project files. | 254 | directory. |
256 | When the <filename>bitbake</filename> command completes, the tarball will | 255 | When the <filename>bitbake</filename> command completes, the tarball will |
257 | be in <filename>tmp/deploy/sdk</filename> in the Yocto Project build tree. | 256 | be in <filename>tmp/deploy/sdk</filename> in the build directory. |
258 | </para></note></para></listitem> | 257 | </para></note></para></listitem> |
259 | <listitem><para>Make sure you are in the root directory with root privileges and then expand | 258 | <listitem><para>Make sure you are in the root directory with root privileges and then expand |
260 | the tarball. | 259 | the tarball. |
@@ -267,11 +266,11 @@ | |||
267 | </section> | 266 | </section> |
268 | 267 | ||
269 | <section id='using-the-toolchain-from-within-the-build-tree'> | 268 | <section id='using-the-toolchain-from-within-the-build-tree'> |
270 | <title>Using BitBake and the Yocto Project Build Tree</title> | 269 | <title>Using BitBake and the Build Directory</title> |
271 | 270 | ||
272 | <para> | 271 | <para> |
273 | A final way of making the cross-toolchain available is to use BitBake | 272 | A final way of making the cross-toolchain available is to use BitBake |
274 | to generate the toolchain within an existing Yocto Project build tree. | 273 | to generate the toolchain within an existing build directory. |
275 | This method does not install the toolchain into the | 274 | This method does not install the toolchain into the |
276 | <filename>/opt</filename> directory. | 275 | <filename>/opt</filename> directory. |
277 | As with the previous method, if you need to install the target sysroot, you must | 276 | As with the previous method, if you need to install the target sysroot, you must |
@@ -282,12 +281,12 @@ | |||
282 | Follow these steps to generate the toolchain into the build tree: | 281 | Follow these steps to generate the toolchain into the build tree: |
283 | <orderedlist> | 282 | <orderedlist> |
284 | <listitem><para>Source the environment setup script | 283 | <listitem><para>Source the environment setup script |
285 | <filename>oe-init-build-env</filename> located in the Yocto Project | 284 | <filename>oe-init-build-env</filename> located in the source directory. |
286 | files.</para></listitem> | 285 | </para></listitem> |
287 | <listitem><para>At this point, you should be sure that the | 286 | <listitem><para>At this point, you should be sure that the |
288 | <filename>MACHINE</filename> variable | 287 | <filename>MACHINE</filename> variable |
289 | in the <filename>local.conf</filename> file found in the | 288 | in the <filename>local.conf</filename> file found in the |
290 | <filename>conf</filename> directory of the Yocto Project build directory | 289 | <filename>conf</filename> directory of the build directory |
291 | is set for the target architecture. | 290 | is set for the target architecture. |
292 | Comments within the <filename>local.conf</filename> file list the values you | 291 | Comments within the <filename>local.conf</filename> file list the values you |
293 | can use for the <filename>MACHINE</filename> variable. | 292 | can use for the <filename>MACHINE</filename> variable. |
@@ -305,9 +304,9 @@ | |||
305 | after checking or editing the <filename>local.conf</filename> but without | 304 | after checking or editing the <filename>local.conf</filename> but without |
306 | changing out of your working directory.</note> | 305 | changing out of your working directory.</note> |
307 | Once the <filename>bitbake</filename> command finishes, | 306 | Once the <filename>bitbake</filename> command finishes, |
308 | the cross-toolchain is generated and populated within the Yocto Project build tree. | 307 | the cross-toolchain is generated and populated within the build directory. |
309 | You will notice environment setup files for the cross-toolchain in the | 308 | You will notice environment setup files for the cross-toolchain in the |
310 | Yocto Project build tree in the <filename>tmp</filename> directory. | 309 | build directory in the <filename>tmp</filename> directory. |
311 | Setup script filenames contain the strings <filename>environment-setup</filename>. | 310 | Setup script filenames contain the strings <filename>environment-setup</filename>. |
312 | </para></listitem> | 311 | </para></listitem> |
313 | </orderedlist> | 312 | </orderedlist> |
@@ -325,7 +324,7 @@ | |||
325 | then you can find this script in the <filename>&YOCTO_ADTPATH_DIR;</filename> | 324 | then you can find this script in the <filename>&YOCTO_ADTPATH_DIR;</filename> |
326 | directory. | 325 | directory. |
327 | If you installed the toolchain in the build tree, you can find the environment setup | 326 | If you installed the toolchain in the build tree, you can find the environment setup |
328 | script for the toolchain in the Yocto Project build tree's <filename>tmp</filename> directory. | 327 | script for the toolchain in the build directory's <filename>tmp</filename> directory. |
329 | </para> | 328 | </para> |
330 | 329 | ||
331 | <para> | 330 | <para> |
@@ -363,14 +362,15 @@ | |||
363 | </para> | 362 | </para> |
364 | 363 | ||
365 | <para> | 364 | <para> |
366 | The Yocto Project provides basic kernel and filesystem images for several | 365 | The Yocto Project ships basic kernel and filesystem images for several |
367 | architectures (<filename>x86</filename>, <filename>x86-64</filename>, | 366 | architectures (<filename>x86</filename>, <filename>x86-64</filename>, |
368 | <filename>mips</filename>, <filename>powerpc</filename>, and <filename>arm</filename>) | 367 | <filename>mips</filename>, <filename>powerpc</filename>, and <filename>arm</filename>) |
369 | that you can use unaltered in the QEMU emulator. | 368 | that you can use unaltered in the QEMU emulator. |
370 | These kernel images reside in the Yocto Project release | 369 | These kernel images reside in the release |
371 | area - <ulink url='&YOCTO_MACHINES_DL_URL;'></ulink> | 370 | area - <ulink url='&YOCTO_MACHINES_DL_URL;'></ulink> |
372 | and are ideal for experimentation within Yocto Project. | 371 | and are ideal for experimentation using Yocto Project. |
373 | For information on the image types you can build using the Yocto Project, see the | 372 | For information on the image types you can build using the OpenEmbedded build system, |
373 | see the | ||
374 | "<ulink url='&YOCTO_DOCS_REF_URL;#ref-images'>Reference: Images</ulink>" appendix in | 374 | "<ulink url='&YOCTO_DOCS_REF_URL;#ref-images'>Reference: Images</ulink>" appendix in |
375 | The Yocto Project Reference Manual. | 375 | The Yocto Project Reference Manual. |
376 | </para> | 376 | </para> |
@@ -389,7 +389,7 @@ | |||
389 | you can do so one of two ways: | 389 | you can do so one of two ways: |
390 | <itemizedlist> | 390 | <itemizedlist> |
391 | <listitem><para>Modify the <filename>conf/local.conf</filename> configuration in | 391 | <listitem><para>Modify the <filename>conf/local.conf</filename> configuration in |
392 | the Yocto Project build directory and then rebuild the image. | 392 | the build directory and then rebuild the image. |
393 | With this method, you need to modify the <filename>EXTRA_IMAGE_FEATURES</filename> | 393 | With this method, you need to modify the <filename>EXTRA_IMAGE_FEATURES</filename> |
394 | variable to have the value of "tools-debug" before rebuilding the image. | 394 | variable to have the value of "tools-debug" before rebuilding the image. |
395 | Once the image is rebuilt, the <filename>tcf-agent</filename> will be included | 395 | Once the image is rebuilt, the <filename>tcf-agent</filename> will be included |