summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2013-02-06 18:51:39 (GMT)
committerRichard Purdie <richard.purdie@linuxfoundation.org>2013-02-14 17:24:04 (GMT)
commit0ad26c66e0b926591f5d68095bd4b142f381cd86 (patch)
treeae8982295a2764d99a065c260d368ccdd50388f8
parent3c984fdbc60600d5839a8c8d9042d8381d03d2af (diff)
downloadpoky-0ad26c66e0b926591f5d68095bd4b142f381cd86.tar.gz
dev-manual: Updates to expose cross-toolchain recipes.
Added a bulleted list to the "Terms" section to help define some toolchain recipes such as gcc-cross-initial, gcc-cross-intermediate, and so forth. Added a cross-reference link to the term "Cross-Development Toolchain" in the the "Working Using Stand-alone Cross-development Toolchains" section. This gives the reader a way to see more on the toolchain recipes. (From yocto-docs rev: 2cb612424c0cf6addfd8bce8a0ef77665c35bd9a) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
-rw-r--r--documentation/dev-manual/dev-manual-model.xml64
-rw-r--r--documentation/dev-manual/dev-manual-newbie.xml58
2 files changed, 89 insertions, 33 deletions
diff --git a/documentation/dev-manual/dev-manual-model.xml b/documentation/dev-manual/dev-manual-model.xml
index cdb799d..f59fae3 100644
--- a/documentation/dev-manual/dev-manual-model.xml
+++ b/documentation/dev-manual/dev-manual-model.xml
@@ -1448,45 +1448,57 @@ directory.</para></listitem>
1448 <title>Workflow Using Stand-alone Cross-development Toolchains</title> 1448 <title>Workflow Using Stand-alone Cross-development Toolchains</title>
1449 1449
1450 <para> 1450 <para>
1451 If you want to develop an application without prior installation of the ADT, you 1451 If you want to develop an application without prior installation
1452 still can employ the cross-development toolchain, the QEMU emulator, and a number of supported 1452 of the ADT, you still can employ the
1453 target image files. 1453 <link linkend='cross-development-toolchain'>Cross Development Toolchain</link>,
1454 the QEMU emulator, and a number of supported target image files.
1454 You just need to follow these general steps: 1455 You just need to follow these general steps:
1455 <orderedlist> 1456 <orderedlist>
1456 <listitem><para><emphasis>Install the cross-development toolchain for your target hardware:</emphasis> 1457 <listitem><para><emphasis>Install the cross-development
1458 toolchain for your target hardware:</emphasis>
1457 For information on how to install the toolchain, see the 1459 For information on how to install the toolchain, see the
1458 "<ulink url='&YOCTO_DOCS_ADT_URL;#using-an-existing-toolchain-tarball'>Using a Cross-Toolchain Tarball</ulink>" 1460 "<ulink url='&YOCTO_DOCS_ADT_URL;#using-an-existing-toolchain-tarball'>Using a Cross-Toolchain Tarball</ulink>"
1459 section 1461 section in the Yocto Project Application Developer's
1460 in the Yocto Project Application Developer's Guide.</para></listitem> 1462 Guide.</para></listitem>
1461 <listitem><para><emphasis>Download the Target Image:</emphasis> The Yocto Project supports 1463 <listitem><para><emphasis>Download the Target Image:</emphasis>
1462 several target architectures and has many pre-built kernel images and root filesystem 1464 The Yocto Project supports several target architectures
1465 and has many pre-built kernel images and root filesystem
1463 images.</para> 1466 images.</para>
1464 <para>If you are going to develop your application on hardware, go to the 1467 <para>If you are going to develop your application on
1468 hardware, go to the
1465 <ulink url='&YOCTO_MACHINES_DL_URL;'><filename>machines</filename></ulink> 1469 <ulink url='&YOCTO_MACHINES_DL_URL;'><filename>machines</filename></ulink>
1466 download area and choose a target machine area 1470 download area and choose a target machine area
1467 from which to download the kernel image and root filesystem. 1471 from which to download the kernel image and root filesystem.
1468 This download area could have several files in it that support development using 1472 This download area could have several files in it that
1469 actual hardware. 1473 support development using actual hardware.
1470 For example, the area might contain <filename>.hddimg</filename> files that combine the 1474 For example, the area might contain
1475 <filename>.hddimg</filename> files that combine the
1471 kernel image with the filesystem, boot loaders, etc. 1476 kernel image with the filesystem, boot loaders, etc.
1472 Be sure to get the files you need for your particular development process.</para> 1477 Be sure to get the files you need for your particular
1473 <para>If you are going to develop your application and then run and test it using the QEMU 1478 development process.</para>
1474 emulator, go to the 1479 <para>If you are going to develop your application and
1480 then run and test it using the QEMU emulator, go to the
1475 <ulink url='&YOCTO_QEMU_DL_URL;'><filename>machines/qemu</filename></ulink> 1481 <ulink url='&YOCTO_QEMU_DL_URL;'><filename>machines/qemu</filename></ulink>
1476 download area. 1482 download area.
1477 From this area, go down into the directory for your target architecture 1483 From this area, go down into the directory for your
1478 (e.g. <filename>qemux86_64</filename> for an 1484 target architecture (e.g. <filename>qemux86_64</filename>
1479 <trademark class='registered'>Intel</trademark>-based 64-bit architecture). 1485 for an <trademark class='registered'>Intel</trademark>-based
1480 Download kernel, root filesystem, and any other files you need for your process. 1486 64-bit architecture).
1481 <note>In order to use the root filesystem in QEMU, you need to extract it. 1487 Download kernel, root filesystem, and any other files you
1488 need for your process.
1489 <note>In order to use the root filesystem in QEMU, you
1490 need to extract it.
1482 See the 1491 See the
1483 "<ulink url='&YOCTO_DOCS_ADT_URL;#extracting-the-root-filesystem'>Extracting the Root Filesystem</ulink>" 1492 "<ulink url='&YOCTO_DOCS_ADT_URL;#extracting-the-root-filesystem'>Extracting the Root Filesystem</ulink>"
1484 section for information on how to extract the root filesystem.</note></para></listitem> 1493 section for information on how to extract the root
1485 <listitem><para><emphasis>Develop and Test your Application:</emphasis> At this point, 1494 filesystem.</note></para></listitem>
1486 you have the tools to develop your application. 1495 <listitem><para><emphasis>Develop and Test your
1487 If you need to separately install and use the QEMU emulator, you can go to 1496 Application:</emphasis> At this point, you have the tools
1488 <ulink url='http://wiki.qemu.org/Main_Page'>QEMU Home Page</ulink> to download and learn about the 1497 to develop your application.
1489 emulator.</para></listitem> 1498 If you need to separately install and use the QEMU
1499 emulator, you can go to
1500 <ulink url='http://wiki.qemu.org/Main_Page'>QEMU Home Page</ulink>
1501 to download and learn about the emulator.</para></listitem>
1490 </orderedlist> 1502 </orderedlist>
1491 </para> 1503 </para>
1492 </section> 1504 </section>
diff --git a/documentation/dev-manual/dev-manual-newbie.xml b/documentation/dev-manual/dev-manual-newbie.xml
index 169f307..7c21379 100644
--- a/documentation/dev-manual/dev-manual-newbie.xml
+++ b/documentation/dev-manual/dev-manual-newbie.xml
@@ -311,17 +311,61 @@
311 variables for the Texas Instruments ARM Cortex-A8 development board). 311 variables for the Texas Instruments ARM Cortex-A8 development board).
312 Configuration files end with a <filename>.conf</filename> filename extension. 312 Configuration files end with a <filename>.conf</filename> filename extension.
313 </para></listitem> 313 </para></listitem>
314 <listitem><para><emphasis>Cross-Development Toolchain:</emphasis> 314 <listitem><para id='cross-development-toolchain'>
315 <emphasis>Cross-Development Toolchain:</emphasis>
315 A collection of software development 316 A collection of software development
316 tools and utilities that allow you to develop software for targeted architectures. 317 tools and utilities that allow you to develop software for
317 This toolchain contains cross-compilers, linkers, and debuggers that are specific to 318 targeted architectures.
318 an architecture. 319 This toolchain contains cross-compilers, linkers, and debuggers
319 You can use the OpenEmbedded build system to build a cross-development toolchain 320 that are specific to an architecture.
320 installer that when run installs the toolchain that contains the development tools you 321 You can use the OpenEmbedded build system to build a
322 cross-development toolchain installer that, when run, installs
323 the toolchain that contains the development tools you
321 need to cross-compile and test your software. 324 need to cross-compile and test your software.
322 The Yocto Project ships with images that contain installers for 325 The Yocto Project ships with images that contain installers for
323 toolchains for supported architectures as well. 326 toolchains for supported architectures as well.
324 Sometimes this toolchain is referred to as the meta-toolchain.</para></listitem> 327 Sometimes this toolchain is referred to as the
328 meta-toolchain.</para>
329 <para>Following is a list of toolchain recipes with brief
330 descriptions of each:
331 <itemizedlist>
332 <listitem><para><filename>gcc-cross-initial</filename>:
333 The initial compiler needed to bootstrap the toolchain
334 that runs on the host and is used to build software
335 for the target.
336 This tool is a 'native' package.</para></listitem>
337 <listitem><para><filename>gcc-cross-intermediate</filename>:
338 The second stage of the bootstrap process that runs
339 on the host and builds software for the target.
340 This tool is a 'native' package.</para></listitem>
341 <listitem><para><filename>gcc-cross</filename>:
342 The the final stage of the bootstrap process that
343 results in the cross compiler that runs on the host
344 and builds software for the target.
345 If you are replacing the cross compiler toolchain
346 with a custom version, this is what you must replace.
347 This tool is a 'native' package.</para></listitem>
348 <listitem><para><filename>gcc-runtime</filename>:
349 Runtime libraries from the toolchain bootstrapping
350 process.
351 This tool produces a binary for the target.
352 </para></listitem>
353 <listitem><para><filename>gcc-crosssdk-initial/intermediate</filename>:
354 Stage 1 and 2 of the a cross compiler that runs on the
355 host and builds for the SDK.
356 Often the SDK is not the same target as the host.
357 This tool is a 'native' binary.</para></listitem>
358 <listitem><para><filename>gcc-crosssdk</filename>:
359 The final stage of the SDK compiler.
360 This tool is a 'native' binary.
361 The tool runs on the host and builds for the SDK.
362 </para></listitem>
363 <listitem><para><filename>gcc-cross-canadian</filename>:
364 The compiler that runs on the SDK machine and is
365 included with the SDK that builds software for the
366 target.
367 This tool is a 'nativesdk' package.</para></listitem>
368 </itemizedlist></para></listitem>
325 <listitem><para><emphasis>Image:</emphasis> An image is the result produced when 369 <listitem><para><emphasis>Image:</emphasis> An image is the result produced when
326 BitBake processes a given collection of recipes and related metadata. 370 BitBake processes a given collection of recipes and related metadata.
327 Images are the binary output that run on specific hardware or QEMU 371 Images are the binary output that run on specific hardware or QEMU