diff options
author | Scott Rifenbark <scott.m.rifenbark@intel.com> | 2011-08-15 07:38:02 -0700 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2011-08-20 17:52:00 -0700 |
commit | d5d0f08c3232c1d27194b8380b924a5dd2c245e5 (patch) | |
tree | d4b4f8c8f6a3245e5128ea15e269575b2a0e1d09 /documentation | |
parent | b29e5ba4306c5fee0605b03a89016f263ff903ba (diff) | |
download | poky-d5d0f08c3232c1d27194b8380b924a5dd2c245e5.tar.gz |
documentation/adt-manual/adt-prepare.xml: edit pass for new termninology
Also added some general punctuation edits.
(From yocto-docs rev: e9a689655c6e88e735944084e5dda32800a6e6ca)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
-rw-r--r-- | documentation/adt-manual/adt-prepare.xml | 81 |
1 files changed, 43 insertions, 38 deletions
diff --git a/documentation/adt-manual/adt-prepare.xml b/documentation/adt-manual/adt-prepare.xml index 1abc9537f2..68bbbf75e3 100644 --- a/documentation/adt-manual/adt-prepare.xml +++ b/documentation/adt-manual/adt-prepare.xml | |||
@@ -13,22 +13,25 @@ | |||
13 | 13 | ||
14 | <para> | 14 | <para> |
15 | This section describes how to be sure you meet these requirements. | 15 | This section describes how to be sure you meet these requirements. |
16 | Througout this section two important terms are used: | 16 | Throughout this section two important terms are used: |
17 | <itemizedlist> | 17 | <itemizedlist> |
18 | <listitem><para><emphasis>Yocto Project Source Tree:</emphasis> | 18 | <listitem><para><emphasis>The Yocto Project Files:</emphasis> |
19 | This term refers to the directory structure created as a result of downloading | 19 | This term refers to the directory structure created as a result of downloading |
20 | and unpacking a Yocto Project release tarball. | 20 | and unpacking a Yocto Project release tarball or setting up a Git repository |
21 | The Yocto Project source tree contains BitBake, Documentation, Meta-data and | 21 | by cloning <filename>git://git.yoctoproject.org/poky</filename>. |
22 | other files. | 22 | The Yocto Project files contain BitBake, Documentation, metadata and |
23 | The name of the top-level directory of the Yocto Project source tree | 23 | other files that all support the development environment. |
24 | The name of the top-level directory of the Yocto Project files | ||
24 | is derived from the Yocto Project release tarball. | 25 | is derived from the Yocto Project release tarball. |
25 | For example, downloading and unpacking <filename>poky-bernard-5.0.1.tar.bz2</filename> | 26 | For example, downloading and unpacking <filename>poky-bernard-5.0.1.tar.bz2</filename> |
26 | results in a Yocto Project source tree whose Yocto Project source directory is named | 27 | results in a Yocto Project source tree whose Yocto Project source directory is named |
27 | <filename>poky-bernard-5.0.1</filename>.</para></listitem> | 28 | <filename>poky-bernard-5.0.1</filename>. |
29 | If you create a Git repository then you can name the repository anything you like. | ||
30 | </para></listitem> | ||
28 | <listitem><para><emphasis>Yocto Project Build Tree:</emphasis> | 31 | <listitem><para><emphasis>Yocto Project Build Tree:</emphasis> |
29 | This term refers to the area where you run your builds. | 32 | This term refers to the area where Yocto Project builds images. |
30 | The area is created when you source the Yocto Project setup environment script | 33 | The area is created when you source the Yocto Project setup environment script |
31 | that is found in the Yocto Project source directory | 34 | that is found in the Yocto Project files area. |
32 | (e.g. <filename>poky-init-build-env</filename>). | 35 | (e.g. <filename>poky-init-build-env</filename>). |
33 | You can create the Yocto Project build tree anywhere you want on your | 36 | You can create the Yocto Project build tree anywhere you want on your |
34 | development system. | 37 | development system. |
@@ -65,10 +68,10 @@ | |||
65 | <listitem><para><emphasis>Use an Existing Toolchain Tarball:</emphasis> | 68 | <listitem><para><emphasis>Use an Existing Toolchain Tarball:</emphasis> |
66 | Using this method you select and download an architecture-specific | 69 | Using this method you select and download an architecture-specific |
67 | toolchain tarball and then hand-install the toolchain. | 70 | toolchain tarball and then hand-install the toolchain. |
68 | If you use this method you just get the cross-toolchain and QEMU - you do not | 71 | If you use this method, you just get the cross-toolchain and QEMU - you do not |
69 | get any of the other mentioned benefits had you run the ADT Installer script.</para></listitem> | 72 | get any of the other mentioned benefits had you run the ADT Installer script.</para></listitem> |
70 | <listitem><para><emphasis>Use the Toolchain from Within a Yocto Project Build Tree:</emphasis> | 73 | <listitem><para><emphasis>Use the Toolchain from within a Yocto Project Build Tree:</emphasis> |
71 | If you already have a Yocto Project build tree you can install the cross-toolchain | 74 | If you already have a Yocto Project build tree, you can install the cross-toolchain |
72 | using that tree. | 75 | using that tree. |
73 | However, like the previous method mentioned, you only get the cross-toolchain and QEMU - you | 76 | However, like the previous method mentioned, you only get the cross-toolchain and QEMU - you |
74 | do not get any of the other benefits without taking separate steps.</para></listitem> | 77 | do not get any of the other benefits without taking separate steps.</para></listitem> |
@@ -79,7 +82,7 @@ | |||
79 | <title>Using the ADT Installer</title> | 82 | <title>Using the ADT Installer</title> |
80 | 83 | ||
81 | <para> | 84 | <para> |
82 | To run the ADT Installer you need to first get the ADT Installer tarball and then run the ADT | 85 | To run the ADT Installer, you need to first get the ADT Installer tarball and then run the ADT |
83 | Installer Script. | 86 | Installer Script. |
84 | </para> | 87 | </para> |
85 | 88 | ||
@@ -96,12 +99,12 @@ | |||
96 | <para> | 99 | <para> |
97 | If you use BitBake to generate the ADT Installer tarball, you must | 100 | If you use BitBake to generate the ADT Installer tarball, you must |
98 | source the Yocto Project environment setup script located in the Yocto Project | 101 | source the Yocto Project environment setup script located in the Yocto Project |
99 | source directory before running the BitBake command that creates the tarball. | 102 | files before running the BitBake command that creates the tarball. |
100 | </para> | 103 | </para> |
101 | 104 | ||
102 | <para> | 105 | <para> |
103 | The following example commands download the Yocto Project release tarball, create the Yocto | 106 | The following example commands download the Yocto Project release tarball, set up the Yocto |
104 | Project source tree, set up the environment while also creating the Yocto Project build tree, | 107 | Project files, set up the environment while also creating the Yocto Project build tree, |
105 | and finally run the BitBake command that results in the tarball | 108 | and finally run the BitBake command that results in the tarball |
106 | <filename>~/yocto-project/build/tmp/deploy/sdk/adt_installer.tar.bz2</filename>: | 109 | <filename>~/yocto-project/build/tmp/deploy/sdk/adt_installer.tar.bz2</filename>: |
107 | <literallayout class='monospaced'> | 110 | <literallayout class='monospaced'> |
@@ -121,7 +124,7 @@ | |||
121 | <title>Configuring and Running the ADT Installer Script</title> | 124 | <title>Configuring and Running the ADT Installer Script</title> |
122 | 125 | ||
123 | <para> | 126 | <para> |
124 | Before running the ADT Installer script you need to unpack the tarball. | 127 | Before running the ADT Installer script, you need to unpack the tarball. |
125 | You can unpack the tarball in any directory you wish. | 128 | You can unpack the tarball in any directory you wish. |
126 | Unpacking it creates the directory <filename>adt-installer</filename>, | 129 | Unpacking it creates the directory <filename>adt-installer</filename>, |
127 | which contains the ADT Installer script and its configuration file. | 130 | which contains the ADT Installer script and its configuration file. |
@@ -161,9 +164,9 @@ | |||
161 | you should install NFS. | 164 | you should install NFS. |
162 | <note> | 165 | <note> |
163 | To boot QEMU images using our userspace NFS server, you need | 166 | To boot QEMU images using our userspace NFS server, you need |
164 | to be running portmap or rpcbind. | 167 | to be running <filename>portmap</filename> or <filename>rpcbind</filename>. |
165 | If you are running rpcbind, you will also need to add the -i | 168 | If you are running <filename>rpcbind</filename>, you will also need to add the |
166 | option when rpcbind starts up. | 169 | <filename>-i</filename> option when <filename>rpcbind</filename> starts up. |
167 | Please make sure you understand the security implications of doing this. | 170 | Please make sure you understand the security implications of doing this. |
168 | Your firewall settings may also have to be modified to allow | 171 | Your firewall settings may also have to be modified to allow |
169 | NFS booting to work. | 172 | NFS booting to work. |
@@ -180,7 +183,8 @@ | |||
180 | For example, if you downloaded both <filename>minimal</filename> and | 183 | For example, if you downloaded both <filename>minimal</filename> and |
181 | <filename>sato-sdk</filename> images by setting <filename>YOCTOADT_ROOTFS_<arch></filename> | 184 | <filename>sato-sdk</filename> images by setting <filename>YOCTOADT_ROOTFS_<arch></filename> |
182 | to "minimal sato-sdk", then <filename>YOCTOADT_ROOTFS_<arch></filename> | 185 | to "minimal sato-sdk", then <filename>YOCTOADT_ROOTFS_<arch></filename> |
183 | must be set to either "minimal" or "sato-sdk". | 186 | must be set to either <filename>minimal</filename> or |
187 | <filename>sato-sdk</filename>. | ||
184 | </para></listitem> | 188 | </para></listitem> |
185 | <listitem><para><filename>YOCTOADT_TARGET_SYSROOT_LOC_<arch></filename> - The | 189 | <listitem><para><filename>YOCTOADT_TARGET_SYSROOT_LOC_<arch></filename> - The |
186 | location on the development host where the target sysroot will be created. | 190 | location on the development host where the target sysroot will be created. |
@@ -204,7 +208,7 @@ | |||
204 | </note> | 208 | </note> |
205 | 209 | ||
206 | <para> | 210 | <para> |
207 | Once the installer begins to run you are asked whether you want to run in | 211 | Once the installer begins to run, you are asked whether you want to run in |
208 | interactive or silent mode. | 212 | interactive or silent mode. |
209 | If you want to closely monitor the installation then choose “I” for interactive | 213 | If you want to closely monitor the installation then choose “I” for interactive |
210 | mode rather than “S” for silent mode. | 214 | mode rather than “S” for silent mode. |
@@ -227,9 +231,9 @@ | |||
227 | <section id='using-an-existing-toolchain-tarball'> | 231 | <section id='using-an-existing-toolchain-tarball'> |
228 | <title>Using a Cross-Toolchain Tarball</title> | 232 | <title>Using a Cross-Toolchain Tarball</title> |
229 | <para> | 233 | <para> |
230 | If you want to simply install the cross-toolchain by hand you can do so by using an existing | 234 | If you want to simply install the cross-toolchain by hand, you can do so by using an existing |
231 | cross-toolchain tarball. | 235 | cross-toolchain tarball. |
232 | If you install the cross-toolchain by hand you will have to set up the target sysroot separately. | 236 | If you install the cross-toolchain by hand, you will have to set up the target sysroot separately. |
233 | </para> | 237 | </para> |
234 | 238 | ||
235 | <para> | 239 | <para> |
@@ -238,28 +242,29 @@ | |||
238 | <listitem><para>Go to | 242 | <listitem><para>Go to |
239 | <ulink url='http://autobuilder.yoctoproject.org/downloads/yocto-1.0/toolchain'></ulink> | 243 | <ulink url='http://autobuilder.yoctoproject.org/downloads/yocto-1.0/toolchain'></ulink> |
240 | and find the folder that matches your host development system | 244 | and find the folder that matches your host development system |
241 | (i.e. 'i686' for 32-bit machines or 'x86_64' for 64-bit machines).</para> | 245 | (i.e. <filename>i686</filename> for 32-bit machines or |
246 | <filename>x86_64</filename> for 64-bit machines).</para> | ||
242 | </listitem> | 247 | </listitem> |
243 | <listitem><para>Go into that folder and download the toolchain tarball whose name | 248 | <listitem><para>Go into that folder and download the toolchain tarball whose name |
244 | includes the appropriate target architecture. | 249 | includes the appropriate target architecture. |
245 | For example, if your host development system is an Intel-based 64-bit system and | 250 | For example, if your host development system is an Intel-based 64-bit system and |
246 | you are going to use your cross-toolchain for an arm target go into the | 251 | you are going to use your cross-toolchain for an arm target, go into the |
247 | <filename>x86_64</filename> folder and download the following tarball: | 252 | <filename>x86_64</filename> folder and download the following tarball: |
248 | <literallayout class='monospaced'> | 253 | <literallayout class='monospaced'> |
249 | yocto-eglibc-x86_64-arm-toolchain-gmae-1.0.tar.bz2 | 254 | yocto-eglibc-x86_64-arm-toolchain-gmae-1.0.tar.bz2 |
250 | </literallayout> | 255 | </literallayout> |
251 | <note> | 256 | <note> |
252 | Alternatively you can build the toolchain tarball if you have a Yocto Project build tree. | 257 | Alternatively, you can build the toolchain tarball if you have a Yocto Project build tree. |
253 | Use the <filename>bitbake meta-toolchain</filename> command after you have | 258 | Use the <filename>bitbake meta-toolchain</filename> command after you have |
254 | sourced the <filename>poky-build-init script</filename> located in the Yocto Project | 259 | sourced the <filename>poky-build-init script</filename> located in the Yocto Project |
255 | source directory. | 260 | files. |
256 | When the <filename>bitbake</filename> command completes the toolchain tarball will | 261 | When the <filename>bitbake</filename> command completes, the toolchain tarball will |
257 | be in <filename>tmp/deploy/sdk</filename> in the Yocto Project build tree. | 262 | be in <filename>tmp/deploy/sdk</filename> in the Yocto Project build tree. |
258 | </note></para></listitem> | 263 | </note></para></listitem> |
259 | <listitem><para>Make sure you are in the root directory and then expand | 264 | <listitem><para>Make sure you are in the root directory and then expand |
260 | the tarball. | 265 | the tarball. |
261 | The tarball expands into <filename>/opt/poky/$SDKVERSION</filename>. | 266 | The tarball expands into <filename>/opt/poky/$SDKVERSION</filename>. |
262 | Once the tarball in unpacked the cross-toolchain is installed. | 267 | Once the tarball in unpacked, the cross-toolchain is installed. |
263 | You will notice environment setup files for the cross-toolchain in the directory. | 268 | You will notice environment setup files for the cross-toolchain in the directory. |
264 | </para></listitem> | 269 | </para></listitem> |
265 | </orderedlist> | 270 | </orderedlist> |
@@ -274,14 +279,13 @@ | |||
274 | Follow these steps: | 279 | Follow these steps: |
275 | <orderedlist> | 280 | <orderedlist> |
276 | <listitem><para>Source the environment setup script located in the Yocto Project | 281 | <listitem><para>Source the environment setup script located in the Yocto Project |
277 | source directory. | 282 | files. |
278 | The script has the string <filename>init-build-env</filename> | 283 | The script has the string <filename>init-build-env</filename> |
279 | as part of the name.</para></listitem> | 284 | as part of the name.</para></listitem> |
280 | <listitem><para>At this point you should be sure that the | 285 | <listitem><para>At this point you should be sure that the |
281 | <filename>MACHINE</filename> variable | 286 | <filename>MACHINE</filename> variable |
282 | in the <filename>local.conf</filename> file is set for the target architecture. | 287 | in the <filename>local.conf</filename> file is set for the target architecture. |
283 | You can find the <filename>local.conf</filename> file in the Yocto Project source | 288 | You can find the <filename>local.conf</filename> file in the Yocto Project files. |
284 | directory. | ||
285 | Comments within the <filename>local.conf</filename> file list the values you | 289 | Comments within the <filename>local.conf</filename> file list the values you |
286 | can use for the <filename>MACHINE</filename> variable. | 290 | can use for the <filename>MACHINE</filename> variable. |
287 | <note>You can populate the build tree with the cross-toolchains for more | 291 | <note>You can populate the build tree with the cross-toolchains for more |
@@ -291,7 +295,7 @@ | |||
291 | <listitem><para>Run <filename>bitbake meta-ide-support</filename> to complete the | 295 | <listitem><para>Run <filename>bitbake meta-ide-support</filename> to complete the |
292 | cross-toolchain installation. | 296 | cross-toolchain installation. |
293 | <note>If you change your working directory after you source the environment | 297 | <note>If you change your working directory after you source the environment |
294 | setup script and before you run the BitBake command the command will not work. | 298 | setup script and before you run the BitBake command, the command will not work. |
295 | Be sure to run the BitBake command immediately after checking or editing the | 299 | Be sure to run the BitBake command immediately after checking or editing the |
296 | <filename>local.conf</filename> but without changing your working directory.</note> | 300 | <filename>local.conf</filename> but without changing your working directory.</note> |
297 | Once BitBake finishes, the cross-toolchain is installed. | 301 | Once BitBake finishes, the cross-toolchain is installed. |
@@ -307,12 +311,12 @@ | |||
307 | <section id='setting-up-the-environment'> | 311 | <section id='setting-up-the-environment'> |
308 | <title>Setting Up the Environment</title> | 312 | <title>Setting Up the Environment</title> |
309 | <para> | 313 | <para> |
310 | Before you can use the cross-toolchain you need to set up the toolchain environment by | 314 | Before you can use the cross-toolchain, you need to set up the toolchain environment by |
311 | sourcing the environment setup script. | 315 | sourcing the environment setup script. |
312 | If you used the ADT Installer or used an existing ADT tarball to install the ADT, | 316 | If you used the ADT Installer or used an existing ADT tarball to install the ADT, |
313 | then you can find this script in the <filename>/opt/poky/$SDKVERSION</filename> | 317 | then you can find this script in the <filename>/opt/poky/$SDKVERSION</filename> |
314 | directory. | 318 | directory. |
315 | If you used BitBake and the Yocto Project Build Tree to install the cross-toolchain | 319 | If you used BitBake and the Yocto Project Build Tree to install the cross-toolchain, |
316 | then you can find the environment setup scripts in in the Yocto Project build tree | 320 | then you can find the environment setup scripts in in the Yocto Project build tree |
317 | in the <filename>tmp</filename> directory. | 321 | in the <filename>tmp</filename> directory. |
318 | </para> | 322 | </para> |
@@ -341,8 +345,9 @@ | |||
341 | <ulink url='http://www.yoctoproject.org/docs/yocto-quick-start/yocto-project-qs.html'></ulink>. | 345 | <ulink url='http://www.yoctoproject.org/docs/yocto-quick-start/yocto-project-qs.html'></ulink>. |
342 | <note> | 346 | <note> |
343 | Yocto Project provides basic kernels and filesystem images for several | 347 | Yocto Project provides basic kernels and filesystem images for several |
344 | architectures (x86, x86-64, mips, powerpc, and arm) that you can use | 348 | architectures (<filename>x86</filename>, <filename>x86-64</filename>, |
345 | unaltered in the QEMU emulator. | 349 | <filename>mips</filename>, <filename>powerpc</filename>, and <filename>arm</filename>) |
350 | that you can use unaltered in the QEMU emulator. | ||
346 | These kernels and filesystem images reside in the Yocto Project release | 351 | These kernels and filesystem images reside in the Yocto Project release |
347 | area - <ulink url='http://autobuilder.yoctoproject.org/downloads/yocto-1.0/machines/'></ulink> | 352 | area - <ulink url='http://autobuilder.yoctoproject.org/downloads/yocto-1.0/machines/'></ulink> |
348 | and are ideal for experimentation within Yocto Project. | 353 | and are ideal for experimentation within Yocto Project. |