summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual/ref-variables.xml
diff options
context:
space:
mode:
Diffstat (limited to 'documentation/ref-manual/ref-variables.xml')
-rw-r--r--documentation/ref-manual/ref-variables.xml161
1 files changed, 160 insertions, 1 deletions
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."