diff options
| author | Scott Rifenbark <scott.m.rifenbark@intel.com> | 2013-09-13 14:32:05 -0700 | 
|---|---|---|
| committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2013-09-22 12:20:44 +0100 | 
| commit | 25bea918aaccdd8561681923f36cb3ca359fdb25 (patch) | |
| tree | 7ffe9007de5f2833706b1f691008dddfcd96cd33 /documentation/ref-manual | |
| parent | 72c73e67ca38d5024f93644806a657726edc27d7 (diff) | |
| download | poky-25bea918aaccdd8561681923f36cb3ca359fdb25.tar.gz | |
ref-manual: Edits to the "Image Generation" section
Fixes [YOCTO #2808]
Did a self-edit here to try and straighten out how I am mapping
the variables to the actual figure.
(From yocto-docs rev: 82e94d8a8221bbf2eb5feb19a6642907b4ff490b)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/ref-manual')
| -rw-r--r-- | documentation/ref-manual/closer-look.xml | 123 | 
1 files changed, 59 insertions, 64 deletions
diff --git a/documentation/ref-manual/closer-look.xml b/documentation/ref-manual/closer-look.xml index a690544364..5a7d111890 100644 --- a/documentation/ref-manual/closer-look.xml +++ b/documentation/ref-manual/closer-look.xml  | |||
| @@ -601,6 +601,58 @@ | |||
| 601 | </section> | 601 | </section> | 
| 602 | </section> | 602 | </section> | 
| 603 | 603 | ||
| 604 | <section id="package-feeds-dev-environment"> | ||
| 605 | <title>Package Feeds</title> | ||
| 606 | |||
| 607 | <para> | ||
| 608 | When the OpenEmbedded build system generates an image or an SDK, | ||
| 609 | it gets the packages from a package feed area located in the | ||
| 610 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. | ||
| 611 | The | ||
| 612 | <link linkend='general-yocto-environment-figure'>general Yocto Project Development Environment figure</link> | ||
| 613 | shows this package feeds area in the upper-right corner. | ||
| 614 | </para> | ||
| 615 | |||
| 616 | <para> | ||
| 617 | This section looks a little closer into the package feeds area used | ||
| 618 | by the build system. | ||
| 619 | Here is a more detailed look at the area: | ||
| 620 | <imagedata fileref="figures/package-feeds.png" align="center" width="7in" depth="6in" /> | ||
| 621 | </para> | ||
| 622 | |||
| 623 | <para> | ||
| 624 | Package feeds are an intermediary step in the build process. | ||
| 625 | BitBake generates packages whose type is defined by the | ||
| 626 | <link linkend='var-PACKAGE_CLASSES'><filename>PACKAGE_CLASSES</filename></link> | ||
| 627 | variable. | ||
| 628 | Before placing the packages into package feeds, | ||
| 629 | the build process validates them with generated output quality | ||
| 630 | assurance checks through the | ||
| 631 | <link linkend='ref-classes-insane'><filename>insane.bbclass</filename></link> | ||
| 632 | class. | ||
| 633 | </para> | ||
| 634 | |||
| 635 | <para> | ||
| 636 | The package feed area resides in | ||
| 637 | <filename>tmp/deploy</filename> of the Build Directory. | ||
| 638 | Folders are created that correspond to the package type | ||
| 639 | (IPK, DEB, or RPM) created. | ||
| 640 | Further organization is derived through the value of the | ||
| 641 | <link linkend='var-PACKAGE_ARCH'><filename>PACKAGE_ARCH</filename></link> | ||
| 642 | variable for each package. | ||
| 643 | For example, packages can exist for the i586 or qemux86 | ||
| 644 | architectures. | ||
| 645 | The package files themselves reside within the appropriate | ||
| 646 | architecture folder. | ||
| 647 | </para> | ||
| 648 | |||
| 649 | <para> | ||
| 650 | BitBake uses the <filename>do_package_write_*</filename> task to | ||
| 651 | place generated packages into the package holding area (e.g. | ||
| 652 | <filename>do_package_write_ipk</filename> for IPK packages). | ||
| 653 | </para> | ||
| 654 | </section> | ||
| 655 | |||
| 604 | <section id='bitbake-dev-environment'> | 656 | <section id='bitbake-dev-environment'> | 
| 605 | <title>BitBake</title> | 657 | <title>BitBake</title> | 
| 606 | 658 | ||
| @@ -844,12 +896,15 @@ | |||
| 844 | <para> | 896 | <para> | 
| 845 | The image generation process consists of several stages and | 897 | The image generation process consists of several stages and | 
| 846 | depends on many variables. | 898 | depends on many variables. | 
| 847 | The <filename>do_rootfs</filename> uses these key variables | 899 | The <filename>do_rootfs</filename> task uses these key variables | 
| 848 | to help create the list of packages to actually install: | 900 | to help create the list of packages to actually install: | 
| 849 | <itemizedlist> | 901 | <itemizedlist> | 
| 850 | <listitem><para><link linkend='var-IMAGE_INSTALL'><filename>IMAGE_INSTALL</filename></link>: | 902 | <listitem><para><link linkend='var-IMAGE_INSTALL'><filename>IMAGE_INSTALL</filename></link>: | 
| 851 | Lists out the base set of packages to install from | 903 | Lists out the base set of packages to install from | 
| 852 | the Package Feeds area.</para></listitem> | 904 | the Package Feeds area.</para></listitem> | 
| 905 | <listitem><para><link linkend='var-PACKAGE_EXCLUDE'><filename>PACKAGE_EXCLUDE</filename></link>: | ||
| 906 | Specifies packages that should not be installed. | ||
| 907 | </para></listitem> | ||
| 853 | <listitem><para><link linkend='var-IMAGE_FEATURES'><filename>IMAGE_FEATURES</filename></link>: | 908 | <listitem><para><link linkend='var-IMAGE_FEATURES'><filename>IMAGE_FEATURES</filename></link>: | 
| 854 | Specifies features to include in the image. | 909 | Specifies features to include in the image. | 
| 855 | These features map to additional packages for | 910 | These features map to additional packages for | 
| @@ -858,20 +913,12 @@ | |||
| 858 | Specifies the package manager to use and consequently | 913 | Specifies the package manager to use and consequently | 
| 859 | helps determine where to locate packages within the | 914 | helps determine where to locate packages within the | 
| 860 | Package Feeds area.</para></listitem> | 915 | Package Feeds area.</para></listitem> | 
| 861 | <listitem><para><link linkend='var-PACKAGE_EXCLUDE'><filename>PACKAGE_EXCLUDE</filename></link>: | 916 | <listitem><para><link linkend='var-IMAGE_LINGUAS'><filename>IMAGE_LINGUAS</filename></link>: | 
| 862 | Specifies packages that should not be installed. | 917 | Determines the language for which packages are being | 
| 863 | </para></listitem> | 918 | installed.</para></listitem> | 
| 864 | </itemizedlist> | 919 | </itemizedlist> | 
| 865 | </para> | 920 | </para> | 
| 866 | 921 | ||
| 867 | <para> | ||
| 868 | In addition to the previously mentioned variables, the image | ||
| 869 | generation process uses | ||
| 870 | <link linkend='var-IMAGE_LINGUAS'><filename>IMAGE_LINGUAS</filename></link> | ||
| 871 | to determine what language for which packages are being | ||
| 872 | installed. | ||
| 873 | </para> | ||
| 874 | |||
| 875 | <para> | 922 | <para> | 
| 876 | Part of the image generation process includes compressing the | 923 | Part of the image generation process includes compressing the | 
| 877 | root filesystem image. | 924 | root filesystem image. | 
| @@ -923,58 +970,6 @@ | |||
| 923 | </section> | 970 | </section> | 
| 924 | </section> | 971 | </section> | 
| 925 | 972 | ||
| 926 | <section id="package-feeds-dev-environment"> | ||
| 927 | <title>Package Feeds</title> | ||
| 928 | |||
| 929 | <para> | ||
| 930 | When the OpenEmbedded build system generates an image or an SDK, | ||
| 931 | it gets the packages from a package feed area located in the | ||
| 932 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. | ||
| 933 | The | ||
| 934 | <link linkend='general-yocto-environment-figure'>general Yocto Project Development Environment figure</link> | ||
| 935 | shows this package feeds area in the upper-right corner. | ||
| 936 | </para> | ||
| 937 | |||
| 938 | <para> | ||
| 939 | This section looks a little closer into the package feeds area used | ||
| 940 | by the build system. | ||
| 941 | Here is a more detailed look at the area: | ||
| 942 | <imagedata fileref="figures/package-feeds.png" align="center" width="7in" depth="6in" /> | ||
| 943 | </para> | ||
| 944 | |||
| 945 | <para> | ||
| 946 | Package feeds are an intermediary step in the build process. | ||
| 947 | BitBake generates packages whose type is defined by the | ||
| 948 | <link linkend='var-PACKAGE_CLASSES'><filename>PACKAGE_CLASSES</filename></link> | ||
| 949 | variable. | ||
| 950 | Before placing the packages into package feeds, | ||
| 951 | the build process validates them with generated output quality | ||
| 952 | assurance checks through the | ||
| 953 | <link linkend='ref-classes-insane'><filename>insane.bbclass</filename></link> | ||
| 954 | class. | ||
| 955 | </para> | ||
| 956 | |||
| 957 | <para> | ||
| 958 | The package feed area resides in | ||
| 959 | <filename>tmp/deploy</filename> of the Build Directory. | ||
| 960 | Folders are created that correspond to the package type | ||
| 961 | (IPK, DEB, or RPM) created. | ||
| 962 | Further organization is derived through the value of the | ||
| 963 | <link linkend='var-PACKAGE_ARCH'><filename>PACKAGE_ARCH</filename></link> | ||
| 964 | variable for each package. | ||
| 965 | For example, packages can exist for the i586 or qemux86 | ||
| 966 | architectures. | ||
| 967 | The package files themselves reside within the appropriate | ||
| 968 | architecture folder. | ||
| 969 | </para> | ||
| 970 | |||
| 971 | <para> | ||
| 972 | BitBake uses the <filename>do_package_write_*</filename> task to | ||
| 973 | place generated packages into the package holding area (e.g. | ||
| 974 | <filename>do_package_write_ipk</filename> for IPK packages). | ||
| 975 | </para> | ||
| 976 | </section> | ||
| 977 | |||
| 978 | <section id='images-dev-environment'> | 973 | <section id='images-dev-environment'> | 
| 979 | <title>Images</title> | 974 | <title>Images</title> | 
| 980 | 975 | ||
