summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
Diffstat (limited to 'documentation')
-rw-r--r--documentation/mega-manual/figures/package-feeds.pngbin27711 -> 30112 bytes
-rw-r--r--documentation/ref-manual/closer-look.xml54
-rw-r--r--documentation/ref-manual/figures/package-feeds.pngbin27711 -> 30112 bytes
-rw-r--r--documentation/ref-manual/ref-classes.xml51
-rw-r--r--documentation/ref-manual/ref-tasks.xml39
-rw-r--r--documentation/ref-manual/ref-variables.xml161
6 files changed, 252 insertions, 53 deletions
diff --git a/documentation/mega-manual/figures/package-feeds.png b/documentation/mega-manual/figures/package-feeds.png
index 4bc311f3d6..37c9c32506 100644
--- a/documentation/mega-manual/figures/package-feeds.png
+++ b/documentation/mega-manual/figures/package-feeds.png
Binary files differ
diff --git a/documentation/ref-manual/closer-look.xml b/documentation/ref-manual/closer-look.xml
index eaf07d665f..27f674ae2f 100644
--- a/documentation/ref-manual/closer-look.xml
+++ b/documentation/ref-manual/closer-look.xml
@@ -640,7 +640,9 @@
640 640
641 <para> 641 <para>
642 Package feeds are an intermediary step in the build process. 642 Package feeds are an intermediary step in the build process.
643 BitBake generates packages whose types are defined by the 643 The OpenEmbedded build system provides classes to generate
644 different package types, and you specify which classes to enable
645 through the
644 <link linkend='var-PACKAGE_CLASSES'><filename>PACKAGE_CLASSES</filename></link> 646 <link linkend='var-PACKAGE_CLASSES'><filename>PACKAGE_CLASSES</filename></link>
645 variable. 647 variable.
646 Before placing the packages into package feeds, 648 Before placing the packages into package feeds,
@@ -651,22 +653,41 @@
651 </para> 653 </para>
652 654
653 <para> 655 <para>
654 The package feed area resides in 656 The package feed area resides in the Build Directory.
655 <filename>tmp/deploy</filename> of the Build Directory. 657 The directory the build system uses to temporarily store packages
656 Folders are created that correspond to the package type 658 is determined by a combination of variables and the particular
657 (IPK, DEB, or RPM) created. 659 package manager in use.
658 Further organization is derived through the value of the 660 See the "Package Feeds" box in the illustration and note the
659 <link linkend='var-PACKAGE_ARCH'><filename>PACKAGE_ARCH</filename></link> 661 information to the right of that area.
660 variable for each package. 662 In particular, the following defines where package files are
661 For example, packages can exist for the i586 or qemux86 663 kept:
662 architectures. 664 <itemizedlist>
663 The package files themselves reside within the appropriate 665 <listitem><para><link linkend='var-DEPLOY_DIR'><filename>DEPLOY_DIR</filename></link>:
664 architecture folder. 666 Defined as <filename>tmp/deploy</filename> in the Build
667 Directory.
668 </para></listitem>
669 <listitem><para><filename>DEPLOY_DIR_*</filename>:
670 Depending on the package manager used, the package type
671 sub-folder.
672 Given RPM, IPK, or DEB packaging and tarball creation, the
673 <link linkend='var-DEPLOY_DIR_RPM'><filename>DEPLOY_DIR_RPM</filename></link>,
674 <link linkend='var-DEPLOY_DIR_IPK'><filename>DEPLOY_DIR_IPK</filename></link>,
675 <link linkend='var-DEPLOY_DIR_DEB'><filename>DEPLOY_DIR_DEB</filename></link>,
676 or
677 <link linkend='var-DEPLOY_DIR_TAR'><filename>DEPLOY_DIR_TAR</filename></link>,
678 variables are used, respectively.
679 </para></listitem>
680 <listitem><para><link linkend='var-PACKAGE_ARCH'><filename>PACKAGE_ARCH</filename></link>:
681 Defines architecture-specific sub-folders.
682 For example, packages could exist for the i586 or qemux86
683 architectures.
684 </para></listitem>
685 </itemizedlist>
665 </para> 686 </para>
666 687
667 <para> 688 <para>
668 BitBake uses the <filename>do_package_write_*</filename> tasks to 689 BitBake uses the <filename>do_package_write_*</filename> tasks to
669 place generated packages into the package holding area (e.g. 690 generate packages and place them into the package holding area (e.g.
670 <filename>do_package_write_ipk</filename> for IPK packages). 691 <filename>do_package_write_ipk</filename> for IPK packages).
671 See the 692 See the
672 "<link linkend='ref-tasks-package_write_deb'><filename>do_package_write_deb</filename></link>", 693 "<link linkend='ref-tasks-package_write_deb'><filename>do_package_write_deb</filename></link>",
@@ -675,6 +696,13 @@
675 and 696 and
676 "<link linkend='ref-tasks-package_write_tar'><filename>do_package_write_tar</filename></link>" 697 "<link linkend='ref-tasks-package_write_tar'><filename>do_package_write_tar</filename></link>"
677 sections for additional information. 698 sections for additional information.
699 As an example, consider a scenario where an IPK packaging manager
700 is being used and package architecture support for both i586
701 and qemux86 exist.
702 Packages for the i586 architecture are placed in
703 <filename>build/tmp/deploy/ipk/i586</filename>, while packages for
704 the qemux86 architecture are placed in
705 <filename>build/tmp/deploy/ipk/qemux86</filename>.
678 </para> 706 </para>
679 </section> 707 </section>
680 708
diff --git a/documentation/ref-manual/figures/package-feeds.png b/documentation/ref-manual/figures/package-feeds.png
index 4bc311f3d6..37c9c32506 100644
--- a/documentation/ref-manual/figures/package-feeds.png
+++ b/documentation/ref-manual/figures/package-feeds.png
Binary files differ
diff --git a/documentation/ref-manual/ref-classes.xml b/documentation/ref-manual/ref-classes.xml
index 880badda73..4eb61c5ba5 100644
--- a/documentation/ref-manual/ref-classes.xml
+++ b/documentation/ref-manual/ref-classes.xml
@@ -2263,11 +2263,12 @@
2263 2263
2264 <para> 2264 <para>
2265 The <filename>package_deb</filename> class 2265 The <filename>package_deb</filename> class
2266 provides support for creating packages that use the 2266 provides support for creating packages that use the Debian
2267 <filename>.deb</filename> file format. 2267 (i.e. <filename>.deb</filename>) file format.
2268 The class ensures the packages are written out to the 2268 The class ensures the packages are written out in a
2269 <filename>${</filename><link linkend='var-DEPLOY_DIR'><filename>DEPLOY_DIR</filename></link><filename>}/deb</filename> 2269 <filename>.deb</filename> file format to the
2270 directory in a <filename>.deb</filename> file format. 2270 <filename>${</filename><link linkend='var-DEPLOY_DIR_DEB'><filename>DEPLOY_DIR_DEB</filename></link><filename>}</filename>
2271 directory.
2271 </para> 2272 </para>
2272 2273
2273 <para> 2274 <para>
@@ -2284,11 +2285,12 @@
2284 2285
2285 <para> 2286 <para>
2286 The <filename>package_ipk</filename> class 2287 The <filename>package_ipk</filename> class
2287 provides support for creating packages that use the 2288 provides support for creating packages that use the IPK
2288 <filename>.ipk</filename> file format. 2289 (i.e. <filename>.ipk</filename>) file format.
2289 The class ensures the packages are written out to the 2290 The class ensures the packages are written out in a
2290 <filename>${</filename><link linkend='var-DEPLOY_DIR'><filename>DEPLOY_DIR</filename></link><filename>}/ipk</filename> 2291 <filename>.ipk</filename> file format to the
2291 directory in a <filename>.ipk</filename> file format. 2292 <filename>${</filename><link linkend='var-DEPLOY_DIR_IPK'><filename>DEPLOY_DIR_IPK</filename></link><filename>}</filename>
2293 directory.
2292 </para> 2294 </para>
2293 2295
2294 <para> 2296 <para>
@@ -2305,11 +2307,12 @@
2305 2307
2306 <para> 2308 <para>
2307 The <filename>package_rpm</filename> class 2309 The <filename>package_rpm</filename> class
2308 provides support for creating packages that use the 2310 provides support for creating packages that use the RPM
2309 <filename>.rpm</filename> file format. 2311 (i.e. <filename>.rpm</filename>) file format.
2310 The class ensures the packages are written out to the 2312 The class ensures the packages are written out in a
2311 <filename>${</filename><link linkend='var-DEPLOY_DIR'><filename>DEPLOY_DIR</filename></link><filename>}/rpm</filename> 2313 <filename>.rpm</filename> file format to the
2312 directory in a <filename>.rpm</filename> file format. 2314 <filename>${</filename><link linkend='var-DEPLOY_DIR_RPM'><filename>DEPLOY_DIR_RPM</filename></link><filename>}</filename>
2315 directory.
2313 </para> 2316 </para>
2314 2317
2315 <para> 2318 <para>
@@ -2324,19 +2327,13 @@
2324<section id='ref-classes-package_tar'> 2327<section id='ref-classes-package_tar'>
2325 <title><filename>package_tar.bbclass</filename></title> 2328 <title><filename>package_tar.bbclass</filename></title>
2326 2329
2327 <note><title>Warning</title>
2328 The <filename>package_tar</filename> class is broken and is not
2329 supported.
2330 It is recommended that you do not use it.
2331 </note>
2332
2333 <para> 2330 <para>
2334 The <filename>package_tar</filename> 2331 The <filename>package_tar</filename> class
2335 class provides support for creating packages that use the 2332 provides support for creating tarballs.
2336 <filename>.tar</filename> file format. 2333 The class ensures the packages are written out in a
2337 The class ensures the packages are written out to the 2334 tarball format to the
2338 <filename>${</filename><link linkend='var-DEPLOY_DIR'><filename>DEPLOY_DIR</filename></link><filename>}/tar</filename> 2335 <filename>${</filename><link linkend='var-DEPLOY_DIR_TAR'><filename>DEPLOY_DIR_TAR</filename></link><filename>}</filename>
2339 directory in a <filename>.tar</filename> file format. 2336 directory.
2340 </para> 2337 </para>
2341 2338
2342 <para> 2339 <para>
diff --git a/documentation/ref-manual/ref-tasks.xml b/documentation/ref-manual/ref-tasks.xml
index 2b3031538f..59b4d9607a 100644
--- a/documentation/ref-manual/ref-tasks.xml
+++ b/documentation/ref-manual/ref-tasks.xml
@@ -144,9 +144,13 @@
144 <title><filename>do_package_write_deb</filename></title> 144 <title><filename>do_package_write_deb</filename></title>
145 145
146 <para> 146 <para>
147 Creates the actual DEB packages and places them in the 147 Creates Debian packages (i.e. <filename>*.deb</filename> files) and
148 <link linkend='package-feeds-dev-environment'>Package Feeds</link> 148 places them in the
149 area. 149 <filename>${</filename><link linkend='var-DEPLOY_DIR_DEB'><filename>DEPLOY_DIR_DEB</filename></link><filename>}</filename>
150 directory in the package feeds area.
151 For more information, see the
152 "<link linkend='package-feeds-dev-environment'>Package Feeds</link>"
153 section.
150 </para> 154 </para>
151 </section> 155 </section>
152 156
@@ -154,9 +158,13 @@
154 <title><filename>do_package_write_ipk</filename></title> 158 <title><filename>do_package_write_ipk</filename></title>
155 159
156 <para> 160 <para>
157 Creates the actual IPK packages and places them in the 161 Creates IPK packages (i.e. <filename>*.ipk</filename> files) and
158 <link linkend='package-feeds-dev-environment'>Package Feeds</link> 162 places them in the
159 area. 163 <filename>${</filename><link linkend='var-DEPLOY_DIR_IPK'><filename>DEPLOY_DIR_IPK</filename></link><filename>}</filename>
164 directory in the package feeds area.
165 For more information, see the
166 "<link linkend='package-feeds-dev-environment'>Package Feeds</link>"
167 section.
160 </para> 168 </para>
161 </section> 169 </section>
162 170
@@ -164,9 +172,13 @@
164 <title><filename>do_package_write_rpm</filename></title> 172 <title><filename>do_package_write_rpm</filename></title>
165 173
166 <para> 174 <para>
167 Creates the actual RPM packages and places them in the 175 Creates RPM packages (i.e. <filename>*.rpm</filename> files) and
168 <link linkend='package-feeds-dev-environment'>Package Feeds</link> 176 places them in the
169 area. 177 <filename>${</filename><link linkend='var-DEPLOY_DIR_RPM'><filename>DEPLOY_DIR_RPM</filename></link><filename>}</filename>
178 directory in the package feeds area.
179 For more information, see the
180 "<link linkend='package-feeds-dev-environment'>Package Feeds</link>"
181 section.
170 </para> 182 </para>
171 </section> 183 </section>
172 184
@@ -174,9 +186,12 @@
174 <title><filename>do_package_write_tar</filename></title> 186 <title><filename>do_package_write_tar</filename></title>
175 187
176 <para> 188 <para>
177 Creates tar archives for packages and places them in the 189 Creates tarballs and places them in the
178 <link linkend='package-feeds-dev-environment'>Package Feeds</link> 190 <filename>${</filename><link linkend='var-DEPLOY_DIR_TAR'><filename>DEPLOY_DIR_TAR</filename></link><filename>}</filename>
179 area. 191 directory in the package feeds area.
192 For more information, see the
193 "<link linkend='package-feeds-dev-environment'>Package Feeds</link>"
194 section.
180 </para> 195 </para>
181 </section> 196 </section>
182 197
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml
index c0cae81212..ecac2b6c26 100644
--- a/documentation/ref-manual/ref-variables.xml
+++ b/documentation/ref-manual/ref-variables.xml
@@ -2686,13 +2686,55 @@
2686 section. 2686 section.
2687 For more detail on the contents of the 2687 For more detail on the contents of the
2688 <filename>deploy</filename> directory, see the 2688 <filename>deploy</filename> directory, see the
2689 "<link linkend='images-dev-environment'>Images</link>" and 2689 "<link linkend='images-dev-environment'>Images</link>",
2690 "<link linkend='package-feeds-dev-environment'>Package Feeds</link>",
2691 and
2690 "<link linkend='sdk-dev-environment'>Application Development SDK</link>" 2692 "<link linkend='sdk-dev-environment'>Application Development SDK</link>"
2691 sections. 2693 sections.
2692 </para> 2694 </para>
2693 </glossdef> 2695 </glossdef>
2694 </glossentry> 2696 </glossentry>
2695 2697
2698 <glossentry id='var-DEPLOY_DIR_DEB'><glossterm>DEPLOY_DIR_DEB</glossterm>
2699 <info>
2700 DEPLOY_DIR_DEB[doc] = "Points to a Debian-specific area that the OpenEmbedded build system uses to place images, packages, SDKs and other output files that are ready to be used outside of the build system."
2701 </info>
2702 <glossdef>
2703 <para role="glossdeffirst">
2704<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
2705 Points to the area that the OpenEmbedded build system uses
2706 to place Debian packages that are ready to be used outside
2707 of the build system.
2708 This variable applies only when
2709 <link linkend='var-PACKAGE_CLASSES'><filename>PACKAGE_CLASSES</filename></link>
2710 contains "package_deb".
2711 </para>
2712
2713 <para>
2714 The BitBake configuration file initially defines the
2715 <filename>DEPLOY_DIR_DEB</filename> variable as a
2716 sub-folder of
2717 <link linkend='var-DEPLOY_DIR'><filename>DEPLOY_DIR</filename></link>:
2718 <literallayout class='monospaced'>
2719 DEPLOY_DIR_DEB = "${DEPLOY_DIR}/deb"
2720 </literallayout>
2721 </para>
2722
2723 <para>
2724 The
2725 <link linkend='ref-classes-package_deb'><filename>package_deb</filename></link>
2726 class uses the
2727 <filename>DEPLOY_DIR_DEB</filename> variable to make sure
2728 the
2729 <link linkend='ref-tasks-package_write_deb'><filename>do_package_write_deb</filename></link>
2730 task writes Debian packages into the appropriate folder.
2731 For more information on how packaging works, see the
2732 "<link linkend='package-feeds-dev-environment'>Package Feeds</link>"
2733 section.
2734 </para>
2735 </glossdef>
2736 </glossentry>
2737
2696 <glossentry id='var-DEPLOY_DIR_IMAGE'><glossterm>DEPLOY_DIR_IMAGE</glossterm> 2738 <glossentry id='var-DEPLOY_DIR_IMAGE'><glossterm>DEPLOY_DIR_IMAGE</glossterm>
2697 <info> 2739 <info>
2698 DEPLOY_DIR_IMAGE[doc] = "Points to the area that the OpenEmbedded build system uses to place images and other associated output files that are ready to be deployed onto the target machine." 2740 DEPLOY_DIR_IMAGE[doc] = "Points to the area that the OpenEmbedded build system uses to place images and other associated output files that are ready to be deployed onto the target machine."
@@ -2724,6 +2766,123 @@
2724 </glossdef> 2766 </glossdef>
2725 </glossentry> 2767 </glossentry>
2726 2768
2769 <glossentry id='var-DEPLOY_DIR_IPK'><glossterm>DEPLOY_DIR_IPK</glossterm>
2770 <info>
2771 DEPLOY_DIR_IPK[doc] = "Points to a IPK-specific area that the OpenEmbedded build system uses to place images, packages, SDKs and other output files that are ready to be used outside of the build system."
2772 </info>
2773 <glossdef>
2774 <para role="glossdeffirst">
2775<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
2776 Points to the area that the OpenEmbedded build system uses
2777 to place IPK packages that are ready to be used outside of
2778 the build system.
2779 This variable applies only when
2780 <link linkend='var-PACKAGE_CLASSES'><filename>PACKAGE_CLASSES</filename></link>
2781 contains "package_ipk".
2782 </para>
2783
2784 <para>
2785 The BitBake configuration file initially defines this
2786 variable as a sub-folder of
2787 <link linkend='var-DEPLOY_DIR'><filename>DEPLOY_DIR</filename></link>:
2788 <literallayout class='monospaced'>
2789 DEPLOY_DIR_IPK = "${DEPLOY_DIR}/ipk"
2790 </literallayout>
2791 </para>
2792
2793 <para>
2794 The
2795 <link linkend='ref-classes-package_ipk'><filename>package_ipk</filename></link>
2796 class uses the
2797 <filename>DEPLOY_DIR_IPK</filename> variable to make sure
2798 the
2799 <link linkend='ref-tasks-package_write_ipk'><filename>do_package_write_ipk</filename></link>
2800 task writes IPK packages into the appropriate folder.
2801 For more information on how packaging works, see the
2802 "<link linkend='package-feeds-dev-environment'>Package Feeds</link>"
2803 section.
2804 </para>
2805 </glossdef>
2806 </glossentry>
2807
2808 <glossentry id='var-DEPLOY_DIR_RPM'><glossterm>DEPLOY_DIR_RPM</glossterm>
2809 <info>
2810 DEPLOY_DIR_RPM[doc] = "Points to a RPM-specific area that the OpenEmbedded build system uses to place images, packages, SDKs and other output files that are ready to be used outside of the build system."
2811 </info>
2812 <glossdef>
2813 <para role="glossdeffirst">
2814<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
2815 Points to the area that the OpenEmbedded build system uses
2816 to place RPM packages that are ready to be used outside
2817 of the build system.
2818 This variable applies only when
2819 <link linkend='var-PACKAGE_CLASSES'><filename>PACKAGE_CLASSES</filename></link>
2820 contains "package_rpm".
2821 </para>
2822
2823 <para>
2824 The BitBake configuration file initially defines this
2825 variable as a sub-folder of
2826 <link linkend='var-DEPLOY_DIR'><filename>DEPLOY_DIR</filename></link>:
2827 <literallayout class='monospaced'>
2828 DEPLOY_DIR_RPM = "${DEPLOY_DIR}/rpm"
2829 </literallayout>
2830 </para>
2831
2832 <para>
2833 The
2834 <link linkend='ref-classes-package_rpm'><filename>package_rpm</filename></link>
2835 class uses the
2836 <filename>DEPLOY_DIR_RPM</filename> variable to make sure
2837 the
2838 <link linkend='ref-tasks-package_write_rpm'><filename>do_package_write_rpm</filename></link>
2839 task writes RPM packages into the appropriate folder.
2840 For more information on how packaging works, see the
2841 "<link linkend='package-feeds-dev-environment'>Package Feeds</link>"
2842 section.
2843 </para>
2844 </glossdef>
2845 </glossentry>
2846
2847 <glossentry id='var-DEPLOY_DIR_TAR'><glossterm>DEPLOY_DIR_TAR</glossterm>
2848 <info>
2849 DEPLOY_DIR_TAR[doc] = "Points to a tarball area that the OpenEmbedded build system uses to place images, packages, SDKs and other output files that are ready to be used outside of the build system."
2850 </info>
2851 <glossdef>
2852 <para role="glossdeffirst">
2853<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
2854 Points to the area that the OpenEmbedded build system uses
2855 to place tarballs that are ready to be used outside of
2856 the build system.
2857 This variable applies only when
2858 <link linkend='var-PACKAGE_CLASSES'><filename>PACKAGE_CLASSES</filename></link>
2859 contains "package_tar".
2860 </para>
2861
2862 <para>
2863 The BitBake configuration file initially defines this
2864 variable as a sub-folder of
2865 <link linkend='var-DEPLOY_DIR'><filename>DEPLOY_DIR</filename></link>:
2866 <literallayout class='monospaced'>
2867 DEPLOY_DIR_TAR = "${DEPLOY_DIR}/tar"
2868 </literallayout>
2869 </para>
2870
2871 <para>
2872 The
2873 <link linkend='ref-classes-package_tar'><filename>package_tar</filename></link>
2874 class uses the
2875 <filename>DEPLOY_DIR_TAR</filename> variable to make sure
2876 the
2877 <link linkend='ref-tasks-package_write_tar'><filename>do_package_write_tar</filename></link>
2878 task writes TAR packages into the appropriate folder.
2879 For more information on how packaging works, see the
2880 "<link linkend='package-feeds-dev-environment'>Package Feeds</link>"
2881 section.
2882 </para>
2883 </glossdef>
2884 </glossentry>
2885
2727 <glossentry id='var-DEPLOYDIR'><glossterm>DEPLOYDIR</glossterm> 2886 <glossentry id='var-DEPLOYDIR'><glossterm>DEPLOYDIR</glossterm>
2728 <info> 2887 <info>
2729 DEPLOYDIR[doc] = "For recipes that inherit the deploy class, the DEPLOYDIR points to a temporary work area for deployed files." 2888 DEPLOYDIR[doc] = "For recipes that inherit the deploy class, the DEPLOYDIR points to a temporary work area for deployed files."