diff options
author | Scott Rifenbark <scott.m.rifenbark@intel.com> | 2013-04-09 14:12:07 -0700 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2013-04-10 16:20:56 +0100 |
commit | 2477c9c7b2af5856c72572f45b8433ea5cce8a0a (patch) | |
tree | 25a5b90fcf2db07c66b353c565003d580a06f083 /documentation/dev-manual/dev-manual-newbie.xml | |
parent | c218ec68833683c2474cfcf5044f6d0e035e4ee9 (diff) | |
download | poky-2477c9c7b2af5856c72572f45b8433ea5cce8a0a.tar.gz |
dev-manual: Edits to "Yocto Project Terms" section.
(From yocto-docs rev: d5742f17daccbaab752e9c82f12dbc9b166bb901)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/dev-manual/dev-manual-newbie.xml')
-rw-r--r-- | documentation/dev-manual/dev-manual-newbie.xml | 57 |
1 files changed, 29 insertions, 28 deletions
diff --git a/documentation/dev-manual/dev-manual-newbie.xml b/documentation/dev-manual/dev-manual-newbie.xml index 48d42d50b7..3193403e85 100644 --- a/documentation/dev-manual/dev-manual-newbie.xml +++ b/documentation/dev-manual/dev-manual-newbie.xml | |||
@@ -444,14 +444,14 @@ | |||
444 | <para> | 444 | <para> |
445 | In summary, here is where you can get the project files needed for development: | 445 | In summary, here is where you can get the project files needed for development: |
446 | <itemizedlist> | 446 | <itemizedlist> |
447 | <listitem><para id='source-repositories'><emphasis><ulink url='&YOCTO_GIT_URL;/cgit/cgit.cgi'>Source Repositories:</ulink></emphasis> | 447 | <listitem><para id='source-repositories'>:S<emphasis><ulink url='&YOCTO_GIT_URL;/cgit/cgit.cgi'>Source Repositories:</ulink></emphasis> |
448 | This area contains IDE Plugins, Matchbox, Poky, Poky Support, Tools, Yocto Linux Kernel, and Yocto | 448 | This area contains IDE Plugins, Matchbox, Poky, Poky Support, Tools, Yocto Linux Kernel, and Yocto |
449 | Metadata Layers. | 449 | Metadata Layers. |
450 | You can create local copies of Git repositories for each of these areas.</para> | 450 | You can create local copies of Git repositories for each of these areas.</para> |
451 | <para> | 451 | <para> |
452 | <imagedata fileref="figures/source-repos.png" align="center" width="6in" depth="4in" /> | 452 | <imagedata fileref="figures/source-repos.png" align="center" width="6in" depth="4in" /> |
453 | </para></listitem> | 453 | </para></listitem> |
454 | <listitem><para><anchor id='index-downloads' /><emphasis><ulink url='&YOCTO_DL_URL;/releases/'>Index of /releases:</ulink></emphasis> | 454 | <listitem><para><anchor id='index-downloads' />:<emphasis><ulink url='&YOCTO_DL_URL;/releases/'>Index of /releases:</ulink></emphasis> |
455 | This area contains index releases such as | 455 | This area contains index releases such as |
456 | the <trademark class='trade'>Eclipse</trademark> | 456 | the <trademark class='trade'>Eclipse</trademark> |
457 | Yocto Plug-in, miscellaneous support, poky, pseudo, installers for cross-development toolchains, | 457 | Yocto Plug-in, miscellaneous support, poky, pseudo, installers for cross-development toolchains, |
@@ -487,9 +487,10 @@ | |||
487 | <listitem><para><emphasis>Append Files:</emphasis> Files that append build information to | 487 | <listitem><para><emphasis>Append Files:</emphasis> Files that append build information to |
488 | a recipe file. | 488 | a recipe file. |
489 | Append files are known as BitBake append files and <filename>.bbappend</filename> files. | 489 | Append files are known as BitBake append files and <filename>.bbappend</filename> files. |
490 | The OpenEmbedded build system expects every append file to have a corresponding and | 490 | The OpenEmbedded build system expects every append file to have a corresponding |
491 | underlying recipe (<filename>.bb</filename>) file. | 491 | recipe (<filename>.bb</filename>) file. |
492 | Furthermore, the append file and the underlying recipe must have the same root filename. | 492 | Furthermore, the append file and corresponding recipe file |
493 | must use the same root filename. | ||
493 | The filenames can differ only in the file type suffix used (e.g. | 494 | The filenames can differ only in the file type suffix used (e.g. |
494 | <filename>formfactor_0.0.bb</filename> and <filename>formfactor_0.0.bbappend</filename>). | 495 | <filename>formfactor_0.0.bb</filename> and <filename>formfactor_0.0.bbappend</filename>). |
495 | </para> | 496 | </para> |
@@ -508,7 +509,7 @@ | |||
508 | This term refers to the area used by the OpenEmbedded build system for builds. | 509 | This term refers to the area used by the OpenEmbedded build system for builds. |
509 | The area is created when you <filename>source</filename> the setup | 510 | The area is created when you <filename>source</filename> the setup |
510 | environment script that is found in the Source Directory | 511 | environment script that is found in the Source Directory |
511 | (i.e. <filename>&OE_INIT_FILE;</filename>). | 512 | (i.e. <ulink url='&YOCTO_DOCS_REF_URL;#structure-core-script'><filename>&OE_INIT_FILE;</filename></ulink>). |
512 | The <ulink url='&YOCTO_DOCS_REF_URL;#var-TOPDIR'><filename>TOPDIR</filename></ulink> | 513 | The <ulink url='&YOCTO_DOCS_REF_URL;#var-TOPDIR'><filename>TOPDIR</filename></ulink> |
513 | variable points to the Build Directory.</para> | 514 | variable points to the Build Directory.</para> |
514 | 515 | ||
@@ -529,22 +530,21 @@ | |||
529 | <literallayout class='monospaced'> | 530 | <literallayout class='monospaced'> |
530 | $ source &OE_INIT_PATH; $HOME/mybuilds/YP-&POKYVERSION; | 531 | $ source &OE_INIT_PATH; $HOME/mybuilds/YP-&POKYVERSION; |
531 | </literallayout></para></listitem> | 532 | </literallayout></para></listitem> |
532 | <listitem><para>Provide an existing directory to use as the Build Directory. | 533 | <listitem><para>Provide an existing directory to use as the Build Directory |
533 | This example uses the existing <filename>mybuilds</filename> directory | 534 | and use the default <filename>build</filename> name. |
534 | as the Build Directory. | ||
535 | <literallayout class='monospaced'> | 535 | <literallayout class='monospaced'> |
536 | $ source &OE_INIT_PATH; $HOME/mybuilds/ | 536 | $ source &OE_INIT_PATH; $HOME/mybuilds/ |
537 | </literallayout></para></listitem> | 537 | </literallayout></para></listitem> |
538 | </itemizedlist> | 538 | </itemizedlist> |
539 | </para></listitem> | 539 | </para></listitem> |
540 | <listitem><para><emphasis>Build System:</emphasis> In the context of the Yocto Project | 540 | <listitem><para><emphasis>Build System:</emphasis> In the context of the Yocto Project, |
541 | this term refers to the OpenEmbedded build system used by the project. | 541 | this term refers to the OpenEmbedded build system used by the project. |
542 | This build system is based on the project known as "Poky." | 542 | This build system is based on the project known as "Poky." |
543 | For some historical information about Poky, see the | 543 | For some historical information about Poky, see the |
544 | <link linkend='poky'>Poky</link> term further along in this section. | 544 | <link linkend='poky'>Poky</link> term. |
545 | </para></listitem> | 545 | </para></listitem> |
546 | <listitem><para><emphasis>Classes:</emphasis> Files that provide for logic encapsulation | 546 | <listitem><para><emphasis>Classes:</emphasis> Files that provide for logic encapsulation |
547 | and inheritance allowing commonly used patterns to be defined once and easily used | 547 | and inheritance so that commonly used patterns can be defined once and then easily used |
548 | in multiple recipes. | 548 | in multiple recipes. |
549 | Class files end with the <filename>.bbclass</filename> filename extension. | 549 | Class files end with the <filename>.bbclass</filename> filename extension. |
550 | </para></listitem> | 550 | </para></listitem> |
@@ -554,7 +554,7 @@ | |||
554 | <link linkend='build-directory'>Build Directory</link> | 554 | <link linkend='build-directory'>Build Directory</link> |
555 | contains user-defined variables that affect each build. | 555 | contains user-defined variables that affect each build. |
556 | The <filename>meta-yocto/conf/distro/poky.conf</filename> configuration file | 556 | The <filename>meta-yocto/conf/distro/poky.conf</filename> configuration file |
557 | defines Yocto ‘distro’ configuration | 557 | defines Yocto "distro" configuration |
558 | variables used only when building with this policy. | 558 | variables used only when building with this policy. |
559 | Machine configuration files, which | 559 | Machine configuration files, which |
560 | are located throughout the | 560 | are located throughout the |
@@ -586,18 +586,18 @@ | |||
586 | The initial compiler needed to bootstrap the toolchain | 586 | The initial compiler needed to bootstrap the toolchain |
587 | that runs on the host and is used to build software | 587 | that runs on the host and is used to build software |
588 | for the target. | 588 | for the target. |
589 | This tool is a 'native' package.</para></listitem> | 589 | This tool is a "native" package.</para></listitem> |
590 | <listitem><para><filename>gcc-cross-intermediate</filename>: | 590 | <listitem><para><filename>gcc-cross-intermediate</filename>: |
591 | The second stage of the bootstrap process that runs | 591 | The second stage of the bootstrap process that runs |
592 | on the host and builds software for the target. | 592 | on the host and builds software for the target. |
593 | This tool is a 'native' package.</para></listitem> | 593 | This tool is a "native" package.</para></listitem> |
594 | <listitem><para><filename>gcc-cross</filename>: | 594 | <listitem><para><filename>gcc-cross</filename>: |
595 | The the final stage of the bootstrap process that | 595 | The the final stage of the bootstrap process that |
596 | results in the cross compiler that runs on the host | 596 | results in the cross compiler that runs on the host |
597 | and builds software for the target. | 597 | and builds software for the target. |
598 | If you are replacing the cross compiler toolchain | 598 | If you are replacing the cross compiler toolchain |
599 | with a custom version, this is what you must replace. | 599 | with a custom version, this is what you must replace. |
600 | This tool is a 'native' package.</para></listitem> | 600 | This tool is a "native" package.</para></listitem> |
601 | <listitem><para><filename>gcc-runtime</filename>: | 601 | <listitem><para><filename>gcc-runtime</filename>: |
602 | Runtime libraries from the toolchain bootstrapping | 602 | Runtime libraries from the toolchain bootstrapping |
603 | process. | 603 | process. |
@@ -607,20 +607,20 @@ | |||
607 | Stage 1 and 2 of the a cross compiler that runs on the | 607 | Stage 1 and 2 of the a cross compiler that runs on the |
608 | host and builds for the SDK. | 608 | host and builds for the SDK. |
609 | Often the SDK is not the same target as the host. | 609 | Often the SDK is not the same target as the host. |
610 | This tool is a 'native' binary.</para></listitem> | 610 | This tool is a "native" binary.</para></listitem> |
611 | <listitem><para><filename>gcc-crosssdk</filename>: | 611 | <listitem><para><filename>gcc-crosssdk</filename>: |
612 | The final stage of the SDK compiler. | 612 | The final stage of the SDK compiler. |
613 | This tool is a 'native' binary. | 613 | This tool is a "native" binary. |
614 | The tool runs on the host and builds for the SDK. | 614 | The tool runs on the host and builds for the SDK. |
615 | </para></listitem> | 615 | </para></listitem> |
616 | <listitem><para><filename>gcc-cross-canadian</filename>: | 616 | <listitem><para><filename>gcc-cross-canadian</filename>: |
617 | The compiler that runs on the SDK machine and is | 617 | The compiler that runs on the SDK machine and is |
618 | included with the SDK that builds software for the | 618 | included with the SDK that builds software for the |
619 | target. | 619 | target. |
620 | This tool is a 'nativesdk' package.</para></listitem> | 620 | This tool is a "nativesdk" package.</para></listitem> |
621 | </itemizedlist></para></listitem> | 621 | </itemizedlist></para></listitem> |
622 | <listitem><para><emphasis>Image:</emphasis> An image is the result produced when | 622 | <listitem><para><emphasis>Image:</emphasis> An image is the result produced when |
623 | BitBake processes a given collection of recipes and related metadata. | 623 | BitBake processes a given collection of recipes and related Metadata. |
624 | Images are the binary output that run on specific hardware or QEMU | 624 | Images are the binary output that run on specific hardware or QEMU |
625 | and for specific use cases. | 625 | and for specific use cases. |
626 | For a list of the supported image types that the Yocto Project provides, see the | 626 | For a list of the supported image types that the Yocto Project provides, see the |
@@ -636,17 +636,17 @@ | |||
636 | In general, Metadata includes recipes, classes, and | 636 | In general, Metadata includes recipes, classes, and |
637 | configuration files. | 637 | configuration files. |
638 | In the context of the kernel ("kernel Metadata"), | 638 | In the context of the kernel ("kernel Metadata"), |
639 | it refers to metadata in the <filename>meta</filename> | 639 | it refers to Metadata in the <filename>meta</filename> |
640 | branches of the kernel source Git repositories. | 640 | branches of the kernel source Git repositories. |
641 | </para></listitem> | 641 | </para></listitem> |
642 | <listitem><para id='oe-core'><emphasis>OE-Core:</emphasis> A core set of metadata originating | 642 | <listitem><para id='oe-core'><emphasis>OE-Core:</emphasis> A core set of Metadata originating |
643 | with OpenEmbedded (OE) that is shared between OE and the Yocto Project. | 643 | with OpenEmbedded (OE) that is shared between OE and the Yocto Project. |
644 | This metadata is found in the <filename>meta</filename> directory of the source | 644 | This Metadata is found in the <filename>meta</filename> directory of the |
645 | directory.</para></listitem> | 645 | <link linkend='source-directory'>Source Directory</link>.</para></listitem> |
646 | <listitem><para><emphasis>Package:</emphasis> In the context of the Yocto Project, | 646 | <listitem><para><emphasis>Package:</emphasis> In the context of the Yocto Project, |
647 | this term refers to the packaged output from a baked recipe. | 647 | this term refers to the packaged output from a baked recipe. |
648 | A package is generally the compiled binaries produced from the recipe's sources. | 648 | A package is generally the compiled binaries produced from the recipe's sources. |
649 | You ‘bake’ something by running it through BitBake.</para> | 649 | You "bake" something by running it through BitBake.</para> |
650 | <para>It is worth noting that the term "package" can, in general, have subtle | 650 | <para>It is worth noting that the term "package" can, in general, have subtle |
651 | meanings. For example, the packages referred to in the | 651 | meanings. For example, the packages referred to in the |
652 | "<ulink url='&YOCTO_DOCS_QS_URL;#packages'>The Packages</ulink>" section are | 652 | "<ulink url='&YOCTO_DOCS_QS_URL;#packages'>The Packages</ulink>" section are |
@@ -666,7 +666,8 @@ | |||
666 | build system becoming a build system for embedded images. | 666 | build system becoming a build system for embedded images. |
667 | After Intel Corporation acquired OpenedHand, the project poky became the basis for | 667 | After Intel Corporation acquired OpenedHand, the project poky became the basis for |
668 | the Yocto Project's build system. | 668 | the Yocto Project's build system. |
669 | Within the Yocto Project source repositories, poky exists as a separate Git repository | 669 | Within the Yocto Project source repositories, <filename>poky</filename> |
670 | exists as a separate Git repository | ||
670 | that can be cloned to yield a local copy on the host system. | 671 | that can be cloned to yield a local copy on the host system. |
671 | Thus, "poky" can refer to the local copy of the Source Directory used to develop within | 672 | Thus, "poky" can refer to the local copy of the Source Directory used to develop within |
672 | the Yocto Project.</para></listitem> | 673 | the Yocto Project.</para></listitem> |
@@ -690,7 +691,7 @@ | |||
690 | Be sure that the Source Directory you use does not contain these types | 691 | Be sure that the Source Directory you use does not contain these types |
691 | of names. | 692 | of names. |
692 | </note></para> | 693 | </note></para> |
693 | <para>The Source Directory contains BitBake, Documentation, metadata and | 694 | <para>The Source Directory contains BitBake, Documentation, Metadata and |
694 | other files that all support the Yocto Project. | 695 | other files that all support the Yocto Project. |
695 | Consequently, you must have the Source Directory in place on your development | 696 | Consequently, you must have the Source Directory in place on your development |
696 | system in order to do any development using the Yocto Project.</para> | 697 | system in order to do any development using the Yocto Project.</para> |
@@ -729,7 +730,7 @@ | |||
729 | "<link linkend='repositories-tags-and-branches'>Repositories, Tags, and Branches</link>" | 730 | "<link linkend='repositories-tags-and-branches'>Repositories, Tags, and Branches</link>" |
730 | section.</para></listitem> | 731 | section.</para></listitem> |
731 | <listitem><para><emphasis>Tasks:</emphasis> Arbitrary groups of software Recipes. | 732 | <listitem><para><emphasis>Tasks:</emphasis> Arbitrary groups of software Recipes. |
732 | You simply use Tasks to hold recipes that, when built, usually accomplish a single task. | 733 | You use tasks to hold recipes that, when built, usually accomplish a single task. |
733 | For example, a task could contain the recipes for a company’s proprietary or value-add software. | 734 | For example, a task could contain the recipes for a company’s proprietary or value-add software. |
734 | Or, the task could contain the recipes that enable graphics. | 735 | Or, the task could contain the recipes that enable graphics. |
735 | A task is really just another recipe. | 736 | A task is really just another recipe. |