diff options
Diffstat (limited to 'documentation')
-rw-r--r-- | documentation/yocto-project-qs/yocto-project-qs.xml | 167 |
1 files changed, 82 insertions, 85 deletions
diff --git a/documentation/yocto-project-qs/yocto-project-qs.xml b/documentation/yocto-project-qs/yocto-project-qs.xml index ff96ceb8e5..ccc5cd6057 100644 --- a/documentation/yocto-project-qs/yocto-project-qs.xml +++ b/documentation/yocto-project-qs/yocto-project-qs.xml | |||
@@ -1,12 +1,13 @@ | |||
1 | <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" | 1 | <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" |
2 | "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> | 2 | "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" |
3 | [<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] > | ||
3 | 4 | ||
4 | <article id='intro'> | 5 | <article id='intro'> |
5 | <imagedata fileref="figures/yocto-project-transp.png" width="6in" depth="1in" align="right" scale="25" /> | 6 | <imagedata fileref="figures/yocto-project-transp.png" width="6in" depth="1in" align="right" scale="25" /> |
6 | 7 | ||
7 | <section id='fake-title'> | 8 | <section id='fake-title'> |
8 | <title>Yocto Project Quick Start</title> | 9 | <title>The Yocto Project Quick Start</title> |
9 | <para>Copyright © 2010-2012 Linux Foundation</para> | 10 | <para>Copyright © ©RIGHT_YEAR; Linux Foundation</para> |
10 | </section> | 11 | </section> |
11 | 12 | ||
12 | <section id='welcome'> | 13 | <section id='welcome'> |
@@ -18,6 +19,7 @@ | |||
18 | Amongst other things, the Yocto Project uses the Poky build system to | 19 | Amongst other things, the Yocto Project uses the Poky build system to |
19 | construct complete Linux images. | 20 | construct complete Linux images. |
20 | </para> | 21 | </para> |
22 | |||
21 | <para> | 23 | <para> |
22 | This short document will give you some basic information about the environment as well | 24 | This short document will give you some basic information about the environment as well |
23 | as let you experience it in its simplest form. | 25 | as let you experience it in its simplest form. |
@@ -26,26 +28,28 @@ | |||
26 | This document steps you through a simple example showing you how to build a small image | 28 | This document steps you through a simple example showing you how to build a small image |
27 | and run it using the QEMU emulator. | 29 | and run it using the QEMU emulator. |
28 | </para> | 30 | </para> |
31 | |||
29 | <para> | 32 | <para> |
30 | For complete information on the Yocto Project, you should check out the | 33 | For more detailed information on the Yocto Project, you should check out these resources: |
31 | <ulink url='http://www.yoctoproject.org'>Yocto Project Website</ulink>. | 34 | <itemizedlist> |
32 | Through the website, you can find the latest builds, breaking news, full development | 35 | <listitem><para><emphasis>Website:</emphasis> The <ulink url='&YOCTO_HOME_URL;'>Yocto Project Website</ulink> |
33 | documentation, and a | 36 | provides the latest builds, breaking news, full development documentation, and a rich Yocto |
34 | rich Yocto Project Development Community into which you can tap. | 37 | Project Development Community into which you can tap. |
35 | </para> | 38 | </para></listitem> |
36 | <para> | 39 | <listitem><para><emphasis>FAQs:</emphasis> Lists commonly asked Yocto Project questions and answers. |
37 | Finally, you might find the Frequently Asked Questions (FAQ) for the Yocto Project | 40 | You can find two FAQs: <ulink url='&YOCTO_WIKI_URL;/wiki/FAQ'>Yocto Project FAQ</ulink> on |
38 | at <ulink url='https://wiki.yoctoproject.org/wiki/FAQ'>Yocto Project FAQ</ulink> and | 41 | a wiki, and the |
39 | the FAQ appendix located in | 42 | <ulink url='&YOCTO_DOCS_REF_URL;#faq'>FAQ</ulink> appendix in the |
40 | <ulink url='http://www.yoctoproject.org/docs/1.1.1/poky-ref-manual/poky-ref-manual.html'> | 43 | The Yocto Project Reference Manual. |
41 | The Yocto Project Reference Manual</ulink> helpful. | 44 | </para></listitem> |
45 | </itemizedlist> | ||
42 | </para> | 46 | </para> |
43 | <note> | 47 | <note> |
44 | Due to production processes, there could be differences between the Yocto Project | 48 | Due to production processes, there could be differences between the Yocto Project |
45 | documentation bundled in the release tarball and the | 49 | documentation bundled in the release tarball and the |
46 | <ulink url='http://www.yoctoproject.org/docs/1.1.1/yocto-project-qs/yocto-project-qs.html'> | 50 | <ulink url='&YOCTO_DOCS_QS_URL;'> |
47 | Yocto Project Quick Start</ulink> on | 51 | Yocto Project Quick Start</ulink> on |
48 | the <ulink url='http://www.yoctoproject.org'>Yocto Project</ulink> website. | 52 | the <ulink url='&YOCTO_HOME_URL;'>Yocto Project</ulink> website. |
49 | For the latest version of this manual, see the manual on the website. | 53 | For the latest version of this manual, see the manual on the website. |
50 | </note> | 54 | </note> |
51 | </section> | 55 | </section> |
@@ -156,11 +160,11 @@ | |||
156 | <listitem><para>openSUSE</para></listitem> | 160 | <listitem><para>openSUSE</para></listitem> |
157 | </itemizedlist> | 161 | </itemizedlist> |
158 | For a list of the distributions under validation and their status, see the | 162 | For a list of the distributions under validation and their status, see the |
159 | <ulink url='https://wiki.yoctoproject.org/wiki/Distribution_Support'>Distribution | 163 | <ulink url='&YOCTO_WIKI_URL;/wiki/Distribution_Support'>Distribution |
160 | Support</ulink> wiki page. | 164 | Support</ulink> wiki page. |
161 | <note> | 165 | <note> |
162 | For notes about using the Yocto Project on a RHEL 4-based host, see the | 166 | For notes about using the Yocto Project on a RHEL 4-based host, see the |
163 | <ulink url='https://wiki.yoctoproject.org/wiki/BuildingOnRHEL4'>BuildingOnRHEL4</ulink> | 167 | <ulink url='&YOCTO_WIKI_URL;/wiki/BuildingOnRHEL4'>BuildingOnRHEL4</ulink> |
164 | wiki page. | 168 | wiki page. |
165 | </note> | 169 | </note> |
166 | </para> | 170 | </para> |
@@ -174,12 +178,12 @@ | |||
174 | If you attempt to use a distribution not in the above list, you may or may not have success - you | 178 | If you attempt to use a distribution not in the above list, you may or may not have success - you |
175 | are venturing into untested territory. | 179 | are venturing into untested territory. |
176 | Refer to | 180 | Refer to |
177 | <ulink url='http://openembedded.net/index.php?title=OEandYourDistro&action=historysubmit&diff=4309&okdid=4225'>OE and Your Distro</ulink> and | 181 | <ulink url='&OE_HOME_URL;/index.php?title=OEandYourDistro&action=historysubmit&diff=4309&okdid=4225'>OE and Your Distro</ulink> and |
178 | <ulink url='http://openembedded.net/index.php?title=Required_software&action=historysubmit&diff=4311&oldid=4251'>Required Software</ulink> | 182 | <ulink url='&OE_HOME_URL;/index.php?title=Required_software&action=historysubmit&diff=4311&oldid=4251'>Required Software</ulink> |
179 | for information for other distributions used with the OpenEmbedded project, which might be | 183 | for information for other distributions used with the OpenEmbedded project, which might be |
180 | a starting point for exploration. | 184 | a starting point for exploration. |
181 | If you go down this path, you should expect problems. | 185 | If you go down this path, you should expect problems. |
182 | When you do, please go to <ulink url='http://bugzilla.yoctoproject.org'>Yocto Project Bugzilla</ulink> | 186 | When you do, please go to <ulink url='&YOCTO_BUGZILLA_URL;'>Yocto Project Bugzilla</ulink> |
183 | and submit a bug. | 187 | and submit a bug. |
184 | We are interested in hearing about your experience. | 188 | We are interested in hearing about your experience. |
185 | </para></note> | 189 | </para></note> |
@@ -213,8 +217,8 @@ | |||
213 | 217 | ||
214 | <literallayout class='monospaced'> | 218 | <literallayout class='monospaced'> |
215 | $ sudo apt-get install sed wget cvs subversion git-core coreutils \ | 219 | $ sudo apt-get install sed wget cvs subversion git-core coreutils \ |
216 | unzip texi2html texinfo libsdl1.2-dev docbook-utils gawk \ | 220 | unzip texi2html texinfo libsdl1.2-dev docbook-utils gawk fop \ |
217 | python-pysqlite2 diffstat help2man make gcc build-essential \ | 221 | python-pysqlite2 diffstat help2man make gcc build-essential xsltproc \ |
218 | g++ desktop-file-utils chrpath libgl1-mesa-dev libglu1-mesa-dev \ | 222 | g++ desktop-file-utils chrpath libgl1-mesa-dev libglu1-mesa-dev \ |
219 | mercurial autoconf automake groff libtool xterm | 223 | mercurial autoconf automake groff libtool xterm |
220 | </literallayout> | 224 | </literallayout> |
@@ -232,7 +236,7 @@ | |||
232 | $ sudo yum groupinstall "development tools" | 236 | $ sudo yum groupinstall "development tools" |
233 | $ sudo yum install python m4 make wget curl ftp hg tar bzip2 gzip \ | 237 | $ sudo yum install python m4 make wget curl ftp hg tar bzip2 gzip \ |
234 | unzip python-psyco perl texinfo texi2html diffstat openjade \ | 238 | unzip python-psyco perl texinfo texi2html diffstat openjade \ |
235 | docbook-style-dsssl sed docbook-style-xsl docbook-dtds \ | 239 | docbook-style-dsssl sed docbook-style-xsl docbook-dtds fop xsltproc \ |
236 | docbook-utils sed bc eglibc-devel ccache pcre pcre-devel quilt \ | 240 | docbook-utils sed bc eglibc-devel ccache pcre pcre-devel quilt \ |
237 | groff linuxdoc-tools patch linuxdoc-tools cmake help2man \ | 241 | groff linuxdoc-tools patch linuxdoc-tools cmake help2man \ |
238 | perl-ExtUtils-MakeMaker tcl-devel gettext chrpath ncurses apr \ | 242 | perl-ExtUtils-MakeMaker tcl-devel gettext chrpath ncurses apr \ |
@@ -258,8 +262,8 @@ | |||
258 | </para> | 262 | </para> |
259 | 263 | ||
260 | <literallayout class='monospaced'> | 264 | <literallayout class='monospaced'> |
261 | $ sudo zypper install python gcc gcc-c++ libtool \ | 265 | $ sudo zypper install python gcc gcc-c++ libtool fop \ |
262 | subversion git chrpath automake make wget help2man \ | 266 | subversion git chrpath automake make wget help2man xsltproc \ |
263 | diffstat texinfo mercurial freeglut-devel libSDL-devel | 267 | diffstat texinfo mercurial freeglut-devel libSDL-devel |
264 | </literallayout> | 268 | </literallayout> |
265 | </section> | 269 | </section> |
@@ -270,13 +274,13 @@ | |||
270 | 274 | ||
271 | <para> | 275 | <para> |
272 | You can download the latest Yocto Project release by going to the | 276 | You can download the latest Yocto Project release by going to the |
273 | <ulink url="http://yoctoproject.org/download">Yocto Project Download page</ulink>. | 277 | <ulink url="&YOCTO_HOME_URL;/download">Yocto Project Download page</ulink>. |
274 | Just go to the page and click the "Yocto Downloads" link found in the "Download" | 278 | Just go to the page and click the "Yocto Downloads" link found in the "Download" |
275 | navigation pane to the right to view all available Yocto Project releases. | 279 | navigation pane to the right to view all available Yocto Project releases. |
276 | Then, click the "Yocto Release" link for the release you want from the list to | 280 | Then, click the "Yocto Release" link for the release you want from the list to |
277 | begin the download. | 281 | begin the download. |
278 | Nightly and developmental builds are also maintained at | 282 | Nightly and developmental builds are also maintained at |
279 | <ulink url="http://autobuilder.yoctoproject.org/nightly/"></ulink>. | 283 | <ulink url="&YOCTO_AB_NIGHTLY_URL;"></ulink>. |
280 | However, for this document a released version of Yocto Project is used. | 284 | However, for this document a released version of Yocto Project is used. |
281 | </para> | 285 | </para> |
282 | 286 | ||
@@ -285,10 +289,8 @@ | |||
285 | development system. | 289 | development system. |
286 | Doing so allows you to contribute back to the project. | 290 | Doing so allows you to contribute back to the project. |
287 | For information on how to get set up using this method, see the | 291 | For information on how to get set up using this method, see the |
288 | "<ulink url='http://www.yoctoproject.org/docs/1.1.1/dev-manual/dev-manual.html#local-yp-release'>Yocto | 292 | "<ulink url='&YOCTO_DOCS_DEV_URL;#local-yp-release'>Yocto |
289 | Project Release</ulink>" item in | 293 | Project Release</ulink>" item in The Yocto Project Development Manual. |
290 | <ulink url='http://www.yoctoproject.org/docs/1.1.1/dev-manual/dev-manual.html'>The Yocto Project | ||
291 | Development Manual</ulink>. | ||
292 | </para> | 294 | </para> |
293 | </section> | 295 | </section> |
294 | </section> | 296 | </section> |
@@ -297,7 +299,7 @@ | |||
297 | <title>A Quick Test Run</title> | 299 | <title>A Quick Test Run</title> |
298 | 300 | ||
299 | <para> | 301 | <para> |
300 | Now that you have your system requirements in order, you can give Yocto Project a try. | 302 | Now that you have your system requirements in order, you can give the Yocto Project a try. |
301 | This section presents some steps that let you do the following: | 303 | This section presents some steps that let you do the following: |
302 | </para> | 304 | </para> |
303 | 305 | ||
@@ -343,28 +345,28 @@ | |||
343 | By default, the Yocto Project searches for source code using a pre-determined order | 345 | By default, the Yocto Project searches for source code using a pre-determined order |
344 | through a set of locations. | 346 | through a set of locations. |
345 | If you encounter problems with the Yocto Project finding and downloading source code, see | 347 | If you encounter problems with the Yocto Project finding and downloading source code, see |
346 | the FAQ entry "How does Poky obtain source code and will it work behind my | 348 | the FAQ entry "How does the Yocto Project build system obtain source code and will it work behind my |
347 | firewall or proxy server?" in | 349 | firewall or proxy server?" in |
348 | <ulink url='http://www.yoctoproject.org/docs/1.1.1/poky-ref-manual/poky-ref-manual.html'> | 350 | <ulink url='&YOCTO_DOCS_REF_URL;#faq'> |
349 | The Yocto Project Reference Manual</ulink>. | 351 | The Yocto Project Reference Manual</ulink>. |
350 | </para></note> | 352 | </para></note> |
351 | 353 | ||
352 | <para> | 354 | <para> |
353 | <literallayout class='monospaced'> | 355 | <literallayout class='monospaced'> |
354 | $ wget http://downloads.yoctoproject.org/releases/yocto/yocto-1.1.1/poky-edison-6.0.1.tar.bz2 | 356 | $ wget &YOCTO_POKY_DL_URL; |
355 | $ tar xjf poky-edison-6.0.1.tar.bz2 | 357 | $ tar xjf &YOCTO_POKY;.tar.bz2 |
356 | $ source poky-edison-6.0.1/oe-init-build-env edison-6.0.1-build | 358 | $ source &OE_INIT_PATH; &YOCTO_POKY;-build |
357 | </literallayout> | 359 | </literallayout> |
358 | </para> | 360 | </para> |
359 | 361 | ||
360 | <tip><para> | 362 | <tip><para> |
361 | To help conserve disk space during builds, you can add the following statement | 363 | To help conserve disk space during builds, you can add the following statement |
362 | to your project's configuration file, which for this example | 364 | to your project's configuration file, which for this example |
363 | is <filename>edison-6.0.1-build/conf/local.conf</filename>. | 365 | is <filename>&YOCTO_POKY;-build/conf/local.conf</filename>. |
364 | Adding this statement deletes the work directory used for building a package | 366 | Adding this statement deletes the work directory used for building a package |
365 | once the package is built. | 367 | once the package is built. |
366 | <literallayout class='monospaced'> | 368 | <literallayout class='monospaced'> |
367 | INHERIT += rm_work | 369 | INHERIT += "rm_work" |
368 | </literallayout> | 370 | </literallayout> |
369 | </para></tip> | 371 | </para></tip> |
370 | 372 | ||
@@ -373,16 +375,16 @@ | |||
373 | release tarball from the source repositories using the | 375 | release tarball from the source repositories using the |
374 | <filename>wget</filename> command. | 376 | <filename>wget</filename> command. |
375 | Alternatively, you can go to the | 377 | Alternatively, you can go to the |
376 | <ulink url='http://www.yoctoproject.org/download'>Yocto Project website</ulink> | 378 | <ulink url='&YOCTO_HOME_URL;/download'>Yocto Project website's Downloads page</ulink> |
377 | Downloads page to retrieve the tarball.</para></listitem> | 379 | to retrieve the tarball.</para></listitem> |
378 | <listitem><para>The second command extracts the files from the tarball and places | 380 | <listitem><para>The second command extracts the files from the tarball and places |
379 | them into a directory named <filename>poky-edison-6.0.1</filename> in the current | 381 | them into a directory named <filename>&YOCTO_POKY;</filename> in the current |
380 | directory.</para></listitem> | 382 | directory.</para></listitem> |
381 | <listitem><para>The third command runs the Yocto Project environment setup script. | 383 | <listitem><para>The third command runs the Yocto Project environment setup script. |
382 | Running this script defines Yocto Project build environment settings needed to | 384 | Running this script defines Yocto Project build environment settings needed to |
383 | complete the build. | 385 | complete the build. |
384 | The script also creates the Yocto Project | 386 | The script also creates the Yocto Project |
385 | build directory, which is <filename>edison-6.0.1-build</filename> in this case. | 387 | build directory, which is <filename>&YOCTO_POKY;-build</filename> in this case. |
386 | After the script runs, your current working directory is set | 388 | After the script runs, your current working directory is set |
387 | to the build directory. | 389 | to the build directory. |
388 | Later, when the build completes, the build directory contains all the files | 390 | Later, when the build completes, the build directory contains all the files |
@@ -406,15 +408,12 @@ | |||
406 | 408 | ||
407 | <para> | 409 | <para> |
408 | Another couple of variables of interest are the | 410 | Another couple of variables of interest are the |
409 | <ulink url='http://www.yoctoproject.org/docs/1.1.1/poky-ref-manual/poky-ref-manual.html#var-BB_NUMBER_THREADS'><filename>BB_NUMBER_THREADS</filename></ulink> and the | 411 | <ulink url='&YOCTO_DOCS_REF_URL;#var-BB_NUMBER_THREADS'><filename>BB_NUMBER_THREADS</filename></ulink> and the |
410 | <ulink url='http://www.yoctoproject.org/docs/1.1.1/poky-ref-manual/poky-ref-manual.html#var-PARALLEL_MAKE'><filename>PARALLEL_MAKE</filename></ulink> variables. | 412 | <ulink url='&YOCTO_DOCS_REF_URL;#var-PARALLEL_MAKE'><filename>PARALLEL_MAKE</filename></ulink> variables. |
411 | By default, these variables are commented out. | 413 | By default, these variables are commented out. |
412 | However, if you have a multi-core CPU you might want to uncomment | 414 | However, if you have a multi-core CPU you might want to uncomment |
413 | the lines and set the variable | 415 | the lines and set both variables equal to twice the number of your |
414 | <filename>BB_NUMBER_THREADS</filename> equal to twice the number of your | ||
415 | host's processor cores. | 416 | host's processor cores. |
416 | Also, you could set the variable <filename>PARALLEL_MAKE</filename> equal to | ||
417 | 1.5 times the number of processor cores. | ||
418 | Setting these variables can significantly shorten your build time. | 417 | Setting these variables can significantly shorten your build time. |
419 | </para> | 418 | </para> |
420 | 419 | ||
@@ -423,11 +422,10 @@ | |||
423 | the image. | 422 | the image. |
424 | By default, the Yocto Project build system uses the RPM package manager. | 423 | By default, the Yocto Project build system uses the RPM package manager. |
425 | You can control this configuration by using the | 424 | You can control this configuration by using the |
426 | <filename><ulink url='http://www.yoctoproject.org/docs/1.1.1/poky-ref-manual/poky-ref-manual.html#var-PACKAGE_CLASSES'><filename>PACKAGE_CLASSES</filename></ulink></filename> variable. | 425 | <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-PACKAGE_CLASSES'><filename>PACKAGE_CLASSES</filename></ulink></filename> variable. |
427 | For additional package manager selection information, see | 426 | For additional package manager selection information, see |
428 | "<ulink url='http://www.yoctoproject.org/docs/1.1.1/poky-ref-manual/poky-ref-manual.html#ref-classes-package'>Packaging - <filename>package*.bbclass</filename></ulink>" in | 427 | "<ulink url='&YOCTO_DOCS_REF_URL;#ref-classes-package'>Packaging - <filename>package*.bbclass</filename></ulink>" |
429 | <ulink url='http://www.yoctoproject.org/docs/1.1.1/poky-ref-manual/poky-ref-manual.html'> | 428 | in The Yocto Project Reference Manual. |
430 | The Yocto Project Reference Manual</ulink>. | ||
431 | </para> | 429 | </para> |
432 | 430 | ||
433 | <para> | 431 | <para> |
@@ -435,16 +433,16 @@ | |||
435 | <filename>core-image-sato</filename> in this example. | 433 | <filename>core-image-sato</filename> in this example. |
436 | For information on the <filename>-k</filename> option use the | 434 | For information on the <filename>-k</filename> option use the |
437 | <filename>bitbake --help</filename> command or see the | 435 | <filename>bitbake --help</filename> command or see the |
438 | "<ulink url='http://www.yoctoproject.org/docs/1.1.1/poky-ref-manual/poky-ref-manual.html#usingpoky-components-bitbake'>BitBake</ulink>" section in | 436 | "<ulink url='&YOCTO_DOCS_REF_URL;#usingpoky-components-bitbake'>BitBake</ulink>" section in |
439 | <ulink url='http://www.yoctoproject.org/docs/1.1.1/poky-ref-manual/poky-ref-manual.html'>The Yocto Project Reference Manual</ulink>. | 437 | The Yocto Project Reference Manual. |
440 | <literallayout class='monospaced'> | 438 | <literallayout class='monospaced'> |
441 | $ bitbake -k core-image-sato | 439 | $ bitbake -k core-image-sato |
442 | </literallayout> | 440 | </literallayout> |
443 | <note><para> | 441 | <note><para> |
444 | BitBake requires Python 2.6 or 2.7. For more information on this requirement, | 442 | BitBake requires Python 2.6 or 2.7. For more information on this requirement, |
445 | see the FAQ appendix in | 443 | see the |
446 | <ulink url='http://www.yoctoproject.org/docs/1.1.1/poky-ref-manual/poky-ref-manual.html'> | 444 | <ulink url='&YOCTO_DOCS_REF_URL;#faq'>FAQ</ulink> in The Yocto Project Reference |
447 | The Yocto Project Reference Manual</ulink>. | 445 | Manual. |
448 | </para></note> | 446 | </para></note> |
449 | The final command runs the image: | 447 | The final command runs the image: |
450 | <literallayout class='monospaced'> | 448 | <literallayout class='monospaced'> |
@@ -482,7 +480,7 @@ | |||
482 | </para> | 480 | </para> |
483 | 481 | ||
484 | <itemizedlist> | 482 | <itemizedlist> |
485 | <listitem><para>Install the stand-alone Yocto toolchain tarball.</para></listitem> | 483 | <listitem><para>Install the appropriate stand-alone Yocto toolchain tarball.</para></listitem> |
486 | <listitem><para>Download the pre-built image that will boot with QEMU. | 484 | <listitem><para>Download the pre-built image that will boot with QEMU. |
487 | You need to be sure to get the QEMU image that matches your target machine’s | 485 | You need to be sure to get the QEMU image that matches your target machine’s |
488 | architecture (e.g. x86, ARM, etc.).</para></listitem> | 486 | architecture (e.g. x86, ARM, etc.).</para></listitem> |
@@ -497,9 +495,9 @@ | |||
497 | <para> | 495 | <para> |
498 | You can download the pre-built toolchain, which includes the <filename>runqemu</filename> | 496 | You can download the pre-built toolchain, which includes the <filename>runqemu</filename> |
499 | script and support files, from the appropriate directory under | 497 | script and support files, from the appropriate directory under |
500 | <ulink url='http://downloads.yoctoproject.org/releases/yocto/yocto-1.1.1/toolchain/'></ulink>. | 498 | <ulink url='&YOCTO_TOOLCHAIN_DL_URL;'></ulink>. |
501 | Toolchains are available for 32-bit and 64-bit development systems from the | 499 | Toolchains are available for 32-bit and 64-bit development systems from the |
502 | <filename>i686</filename> and <filename>x86_64</filename> directories, respectively. | 500 | <filename>i686</filename> and <filename>x86-64</filename> directories, respectively. |
503 | Each type of development system supports five target architectures. | 501 | Each type of development system supports five target architectures. |
504 | The tarball files are named such that a string representing the host system appears | 502 | The tarball files are named such that a string representing the host system appears |
505 | first in the filename and then is immediately followed by a string representing | 503 | first in the filename and then is immediately followed by a string representing |
@@ -507,7 +505,7 @@ | |||
507 | </para> | 505 | </para> |
508 | 506 | ||
509 | <literallayout class='monospaced'> | 507 | <literallayout class='monospaced'> |
510 | poky-eglibc<<emphasis>host_system</emphasis>>-<<emphasis>arch</emphasis>>-toolchain-gmae-<<emphasis>release</emphasis>>.tar.bz2 | 508 | poky-eglibc-<<emphasis>host_system</emphasis>>-<<emphasis>arch</emphasis>>-toolchain-gmae-<<emphasis>release</emphasis>>.tar.bz2 |
511 | 509 | ||
512 | Where: | 510 | Where: |
513 | <<emphasis>host_system</emphasis>> is a string representing your development system: | 511 | <<emphasis>host_system</emphasis>> is a string representing your development system: |
@@ -525,7 +523,7 @@ | |||
525 | </para> | 523 | </para> |
526 | 524 | ||
527 | <literallayout class='monospaced'> | 525 | <literallayout class='monospaced'> |
528 | poky-eglibc-x86_64-i586-toolchain-gmae-1.1.1.tar.bz2 | 526 | poky-eglibc-x86_64-i586-toolchain-gmae-&DISTRO;.tar.bz2 |
529 | </literallayout> | 527 | </literallayout> |
530 | 528 | ||
531 | <para> | 529 | <para> |
@@ -538,16 +536,15 @@ | |||
538 | <para> | 536 | <para> |
539 | <literallayout class='monospaced'> | 537 | <literallayout class='monospaced'> |
540 | $ cd / | 538 | $ cd / |
541 | $ sudo tar -xvjf ~/toolchains/poky-eglibc-x86_64-i586-toolchain-gmae-1.1.1.tar.bz2 | 539 | $ sudo tar -xvjf ~/toolchains/poky-eglibc-x86_64-i586-toolchain-gmae-&DISTRO;.tar.bz2 |
542 | </literallayout> | 540 | </literallayout> |
543 | </para> | 541 | </para> |
544 | 542 | ||
545 | <para> | 543 | <para> |
546 | For more information on how to install tarballs, see the | 544 | For more information on how to install tarballs, see the |
547 | "<ulink url='http://www.yoctoproject.org/docs/1.1.1/adt-manual/adt-manual.html#using-an-existing-toolchain-tarball'>Using a Cross-Toolchain Tarball</ulink>" and | 545 | "<ulink url='&YOCTO_DOCS_ADT_URL;#using-an-existing-toolchain-tarball'>Using a Cross-Toolchain Tarball</ulink>" and |
548 | "<ulink url='http://www.yoctoproject.org/docs/1.1.1/adt-manual/adt-manual.html#using-the-toolchain-from-within-the-build-tree'>Using BitBake and the Yocto Project Build Tree</ulink>" sections in | 546 | "<ulink url='&YOCTO_DOCS_ADT_URL;#using-the-toolchain-from-within-the-build-tree'>Using BitBake and the Yocto Project Build Tree</ulink>" sections in The Yocto Project Application Development Toolkit (ADT) |
549 | <ulink url='http://www.yoctoproject.org/docs/1.1.1/adt-manual/adt-manual.html'>The Yocto Project | 547 | User's Guide. |
550 | Application Development Toolkit (ADT) User's Guide</ulink>. | ||
551 | </para> | 548 | </para> |
552 | </section> | 549 | </section> |
553 | 550 | ||
@@ -556,11 +553,11 @@ | |||
556 | 553 | ||
557 | <para> | 554 | <para> |
558 | You can download the pre-built Linux kernel suitable for running in the QEMU emulator from | 555 | You can download the pre-built Linux kernel suitable for running in the QEMU emulator from |
559 | <ulink url='http://downloads.yoctoproject.org/releases/yocto/yocto-1.1.1/machines/qemu'></ulink>. | 556 | <ulink url='&YOCTO_QEMU_DL_URL;'></ulink>. |
560 | Be sure to use the kernel that matches the architecture you want to simulate. | 557 | Be sure to use the kernel that matches the architecture you want to simulate. |
561 | Download areas exist for the five supported machine architectures: | 558 | Download areas exist for the five supported machine architectures: |
562 | <filename>qemuarm</filename>, <filename>qemumips</filename>, <filename>qemuppc</filename>, | 559 | <filename>qemuarm</filename>, <filename>qemumips</filename>, <filename>qemuppc</filename>, |
563 | <filename>qemux86</filename>, and <filename>qemux86_64</filename>. | 560 | <filename>qemux86</filename>, and <filename>qemux86-64</filename>. |
564 | </para> | 561 | </para> |
565 | 562 | ||
566 | <para> | 563 | <para> |
@@ -577,9 +574,8 @@ | |||
577 | 574 | ||
578 | <para> | 575 | <para> |
579 | You can learn more about downloading a Yocto Project kernel in the | 576 | You can learn more about downloading a Yocto Project kernel in the |
580 | "<ulink url='http://www.yoctoproject.org/docs/1.1.1/dev-manual/dev-manual.html#local-kernel-files'>Linux Yocto Kernel</ulink>" section of | 577 | "<ulink url='&YOCTO_DOCS_DEV_URL;#local-kernel-files'>Linux Yocto Kernel</ulink>" section of |
581 | <ulink url='http://www.yoctoproject.org/docs/1.1.1/dev-manual/dev-manual.html'>The | 578 | The Yocto Project Development Manual. |
582 | Yocto Project Development Manual</ulink>. | ||
583 | </para> | 579 | </para> |
584 | </section> | 580 | </section> |
585 | 581 | ||
@@ -588,7 +584,7 @@ | |||
588 | 584 | ||
589 | <para> | 585 | <para> |
590 | You can also download the filesystem image suitable for your target architecture from | 586 | You can also download the filesystem image suitable for your target architecture from |
591 | <ulink url='http://downloads.yoctoproject.org/releases/yocto/yocto-1.1.1/machines/qemu'></ulink>. | 587 | <ulink url='&YOCTO_QEMU_DL_URL;'></ulink>. |
592 | Again, be sure to use the filesystem that matches the architecture you want | 588 | Again, be sure to use the filesystem that matches the architecture you want |
593 | to simulate. | 589 | to simulate. |
594 | </para> | 590 | </para> |
@@ -599,7 +595,7 @@ | |||
599 | You must use the <filename>ext3</filename> form when booting an image using the | 595 | You must use the <filename>ext3</filename> form when booting an image using the |
600 | QEMU emulator. | 596 | QEMU emulator. |
601 | The <filename>tar</filename> form can be flattened out in your host development system | 597 | The <filename>tar</filename> form can be flattened out in your host development system |
602 | and used for Yocto Project build purposes. | 598 | and used for build purposes with the Yocto Project. |
603 | <literallayout class='monospaced'> | 599 | <literallayout class='monospaced'> |
604 | core-image-<<emphasis>profile</emphasis>>-qemu<<emphasis>arch</emphasis>>.ext3 | 600 | core-image-<<emphasis>profile</emphasis>>-qemu<<emphasis>arch</emphasis>>.ext3 |
605 | core-image-<<emphasis>profile</emphasis>>-qemu<<emphasis>arch</emphasis>>.tar.bz2 | 601 | core-image-<<emphasis>profile</emphasis>>-qemu<<emphasis>arch</emphasis>>.tar.bz2 |
@@ -608,7 +604,7 @@ | |||
608 | <<emphasis>profile</emphasis>> is the filesystem image's profile: | 604 | <<emphasis>profile</emphasis>> is the filesystem image's profile: |
609 | lsb, lsb-dev, lsb-sdk, lsb-qt3, minimal, minimal-dev, sato, sato-dev, or sato-sdk. | 605 | lsb, lsb-dev, lsb-sdk, lsb-qt3, minimal, minimal-dev, sato, sato-dev, or sato-sdk. |
610 | For information on these types of image profiles, see | 606 | For information on these types of image profiles, see |
611 | <ulink url='http://www.yoctoproject.org/docs/1.1.1/poky-ref-manual/poky-ref-manual.html#ref-images'>Reference: Images</ulink> in the Yocto Project Reference Manual. | 607 | <ulink url='&YOCTO_DOCS_REF_URL;#ref-images'>Reference: Images</ulink> in the Yocto Project Reference Manual. |
612 | 608 | ||
613 | <<emphasis>arch</emphasis>> is a string representing the target architecture: | 609 | <<emphasis>arch</emphasis>> is a string representing the target architecture: |
614 | x86, x86-64, ppc, mips, or arm. | 610 | x86, x86-64, ppc, mips, or arm. |
@@ -623,7 +619,7 @@ | |||
623 | Before you start the QEMU emulator, you need to set up the emulation environment. | 619 | Before you start the QEMU emulator, you need to set up the emulation environment. |
624 | The following command form sets up the emulation environment. | 620 | The following command form sets up the emulation environment. |
625 | <literallayout class='monospaced'> | 621 | <literallayout class='monospaced'> |
626 | $ source /opt/poky/1.1.1/environment-setup-<<emphasis>arch</emphasis>>-poky-linux-<<emphasis>if</emphasis>> | 622 | $ source &YOCTO_ADTPATH_DIR;/environment-setup-<<emphasis>arch</emphasis>>-poky-linux-<<emphasis>if</emphasis>> |
627 | 623 | ||
628 | Where: | 624 | Where: |
629 | <<emphasis>arch</emphasis>> is a string representing the target architecture: | 625 | <<emphasis>arch</emphasis>> is a string representing the target architecture: |
@@ -653,12 +649,13 @@ | |||
653 | <para> | 649 | <para> |
654 | Continuing with the example, the following two commands setup the emulation | 650 | Continuing with the example, the following two commands setup the emulation |
655 | environment and launch QEMU. | 651 | environment and launch QEMU. |
656 | This example assumes the toolchain tarball has been downloaded and expanded | 652 | This example assumes the root filesystem (<filename>.ext3</filename> file) and |
657 | into <filename>/opt/poky</filename> and | 653 | the pre-built kernel image file both reside in your home directory. |
658 | that the kernel and filesystem are for a 32-bit target architecture. | 654 | The kernel and filesystem are for a 32-bit target architecture. |
659 | <literallayout class='monospaced'> | 655 | <literallayout class='monospaced'> |
660 | $ source /opt/poky/1.1.1/environment-setup-i586-poky-linux | 656 | $ cd $HOME |
661 | $ runqemu qemux86 bzImage-3.0-qemux86-1.1.1.bin \ | 657 | $ source &YOCTO_ADTPATH_DIR;/environment-setup-i586-poky-linux |
658 | $ runqemu qemux86 bzImage-qemux86.bin \ | ||
662 | core-image-sato-qemux86.ext3 | 659 | core-image-sato-qemux86.ext3 |
663 | </literallayout> | 660 | </literallayout> |
664 | </para> | 661 | </para> |