summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual/ref-variables.xml
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2014-06-10 11:01:06 +0300
committerRichard Purdie <richard.purdie@linuxfoundation.org>2014-06-18 10:30:48 +0100
commit1657abe3f2ef87ea3394e3442172fc93cfde3457 (patch)
tree26641c250c3198bbaa2b293f980f28a8f58952ad /documentation/ref-manual/ref-variables.xml
parent66e3891337e742b355b13936ab99cb67fd1ab5cc (diff)
downloadpoky-1657abe3f2ef87ea3394e3442172fc93cfde3457.tar.gz
ref-manual: Added 17 new STAGING* variables to the glossary:
STAGING_BASE_LIBDIR_NATIVE STAGING_BASELIBDIR STAGING_BINDIR STAGING_BINDIR_CROSS STAGING_BINDIR_NATIVE STAGING_DATADIR STAGING_DIR STAGING_DIR_HOST STAGING_DATADIR_NATIVE STAGING_DIR_NATIVE STAGING_DIR_TARGET STAGING_ETCDIR_NATIVE STAGING_EXECPREFIXDIR STAGING_INCDIR STAGING_INCDIR_NATIVE STAGING_LIBDIR STAGING_LIBDIR_NATIVE (From yocto-docs rev: e3a45f13b6daf00a2a61db4b82d95257987a9dbe) 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/ref-variables.xml')
-rw-r--r--documentation/ref-manual/ref-variables.xml225
1 files changed, 225 insertions, 0 deletions
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml
index 1edd0ab44a..fff28ffed6 100644
--- a/documentation/ref-manual/ref-variables.xml
+++ b/documentation/ref-manual/ref-variables.xml
@@ -7707,6 +7707,231 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
7707 </glossdef> 7707 </glossdef>
7708 </glossentry> 7708 </glossentry>
7709 7709
7710 <glossentry id='var-STAGING_BASE_LIBDIR_NATIVE'><glossterm>STAGING_BASE_LIBDIR_NATIVE</glossterm>
7711 <glossdef>
7712 <para>
7713 Specifies the path to the <filename>/lib</filename>
7714 subdirectory of the sysroot directory for the
7715 build host.
7716 </para>
7717 </glossdef>
7718 </glossentry>
7719
7720 <glossentry id='var-STAGING_BASELIBDIR'><glossterm>STAGING_BASELIBDIR</glossterm>
7721 <glossdef>
7722 <para>
7723 Specifies the path to the <filename>/lib</filename>
7724 subdirectory of the sysroot directory for which the target
7725 is being built
7726 (<link linkend='var-STAGING_DIR_HOST'><filename>STAGING_DIR_HOST</filename></link>).
7727 </para>
7728 </glossdef>
7729 </glossentry>
7730
7731 <glossentry id='var-STAGING_BINDIR'><glossterm>STAGING_BINDIR</glossterm>
7732 <glossdef>
7733 <para>
7734 Specifies the path to the
7735 <filename>/usr/bin</filename> subdirectory of the
7736 sysroot directory for which the target is being built
7737 (<link linkend='var-STAGING_DIR_HOST'><filename>STAGING_DIR_HOST</filename></link>).
7738 </para>
7739 </glossdef>
7740 </glossentry>
7741
7742 <glossentry id='var-STAGING_BINDIR_CROSS'><glossterm>STAGING_BINDIR_CROSS</glossterm>
7743 <glossdef>
7744 <para>
7745 Specifies the path to the directory containing binary
7746 configuration scripts.
7747 These scripts provide configuration information for
7748 other software that wants to make use of libraries or
7749 include files provided by the software associated with
7750 the script.
7751 <note>
7752 This style of build configuration has been largely
7753 replaced by <filename>pkg-config</filename>.
7754 Consequently, if <filename>pkg-config</filename>
7755 is supported by the library to which you are linking,
7756 it is recommended you use
7757 <filename>pkg-config</filename> instead of a
7758 provided configuration script.
7759 </note>
7760 </para>
7761 </glossdef>
7762 </glossentry>
7763
7764 <glossentry id='var-STAGING_BINDIR_NATIVE'><glossterm>STAGING_BINDIR_NATIVE</glossterm>
7765 <glossdef>
7766 <para>
7767 Specifies the path to the
7768 <filename>/usr/bin</filename> subdirectory of the
7769 sysroot directory for the build host.
7770 </para>
7771 </glossdef>
7772 </glossentry>
7773
7774 <glossentry id='var-STAGING_DATADIR'><glossterm>STAGING_DATADIR</glossterm>
7775 <glossdef>
7776 <para>
7777 Specifies the path to the <filename>/usr/share</filename>
7778 subdirectory of the sysroot directory for which the
7779 target is being built
7780 (<link linkend='var-STAGING_DIR_HOST'><filename>STAGING_DIR_HOST</filename></link>).
7781 </para>
7782 </glossdef>
7783 </glossentry>
7784
7785 <glossentry id='var-STAGING_DIR'><glossterm>STAGING_DIR</glossterm>
7786 <glossdef>
7787 <para>
7788 Specifies the path to the top-level sysroots directory
7789 (i.e.
7790 <filename>${</filename><link linkend='var-TMPDIR'><filename>TMPDIR</filename></link><filename>}/sysroots</filename>).
7791 <note>
7792 Recipes should never write files directly under
7793 this directory because the OpenEmbedded build system
7794 the directory automatically.
7795 Instead, files should be installed to
7796 <filename>${</filename><link linkend='var-D'><filename>D</filename></link><filename>}</filename>
7797 within your recipe's
7798 <link linkend='ref-tasks-install'><filename>install</filename></link>
7799 task and then the OpenEmbedded build system will
7800 stage a subset of those files into the sysroot.
7801 </note>
7802 </para>
7803 </glossdef>
7804 </glossentry>
7805
7806 <glossentry id='var-STAGING_DIR_HOST'><glossterm>STAGING_DIR_HOST</glossterm>
7807 <glossdef>
7808 <para>
7809 Specifies the path to the primary sysroot directory for
7810 which the target is being built.
7811 Depending on the type of recipe and the build target, the
7812 recipe's value is as follows:
7813 <itemizedlist>
7814 <listitem><para><emphasis>Recipes Building for the Target Machine</emphasis>:
7815 The value is "${STAGING_DIR}/${MACHINE}".
7816 </para></listitem>
7817 <listitem><para><emphasis>Native Recipes Building for the Build Host</emphasis>:
7818 The value is empty given the assumption that when
7819 building for the build host, the build host's own
7820 directories should be used.
7821 </para></listitem>
7822 <listitem><para><emphasis><filename>nativesdk</filename> Recipes that Build for the SDK</emphasis>:
7823 The value is "${STAGING_DIR}/${MULTIMACH_HOST_SYS}".
7824 </para></listitem>
7825 </itemizedlist>
7826 </para>
7827 </glossdef>
7828 </glossentry>
7829
7830 <glossentry id='var-STAGING_DATADIR_NATIVE'><glossterm>STAGING_DATADIR_NATIVE</glossterm>
7831 <glossdef>
7832 <para>
7833 Specifies the path to the <filename>/usr/share</filename>
7834 subdirectory of the sysroot directory for the build host.
7835 </para>
7836 </glossdef>
7837 </glossentry>
7838
7839
7840
7841 <glossentry id='var-STAGING_DIR_NATIVE'><glossterm>STAGING_DIR_NATIVE</glossterm>
7842 <glossdef>
7843 <para>
7844 Specifies the path to the sysroot directory for the
7845 build host.
7846 </para>
7847 </glossdef>
7848 </glossentry>
7849
7850 <glossentry id='var-STAGING_DIR_TARGET'><glossterm>STAGING_DIR_TARGET</glossterm>
7851 <glossdef>
7852 <para>
7853 Specifies the path to the sysroot directory for which
7854 the target is being built.
7855 In most cases, this path is the
7856 <link linkend='var-STAGING_DIR_HOST'><filename>STAGING_DIR_HOST</filename></link>.
7857 </para>
7858
7859 <para>
7860 Some recipes build binaries that can run on the target
7861 system but those binaries in turn generate code for
7862 another different system (e.g. cross-canadian recipes).
7863 Using terminology from GNU, the primary system is referred
7864 to as the "HOST" and the secondary, or different, system is
7865 referred to as the "TARGET".
7866 Thus, the binaries run on the "HOST" system and
7867 and generate binaries for the "TARGET" system.
7868 <filename>STAGING_DIR_TARGET</filename> points to the
7869 sysroot used for the "TARGET" system.
7870 </para>
7871 </glossdef>
7872 </glossentry>
7873
7874 <glossentry id='var-STAGING_ETCDIR_NATIVE'><glossterm>STAGING_ETCDIR_NATIVE</glossterm>
7875 <glossdef>
7876 <para>
7877 Specifies the path to the <filename>/etc</filename>
7878 subdirectory of the sysroot directory for the
7879 build host.
7880 </para>
7881 </glossdef>
7882 </glossentry>
7883
7884 <glossentry id='var-STAGING_EXECPREFIXDIR'><glossterm>STAGING_EXECPREFIXDIR</glossterm>
7885 <glossdef>
7886 <para>
7887 Specifies the path to the <filename>/usr</filename>
7888 subdirectory of the sysroot directory for which the
7889 target is being built
7890 (<link linkend='var-STAGING_DIR_HOST'><filename>STAGING_DIR_HOST</filename></link>).
7891 </para>
7892 </glossdef>
7893 </glossentry>
7894
7895 <glossentry id='var-STAGING_INCDIR'><glossterm>STAGING_INCDIR</glossterm>
7896 <glossdef>
7897 <para>
7898 Specifies the path to the
7899 <filename>/usr/include</filename> subdirectory of the
7900 sysroot directory for which the target is being built
7901 (<link linkend='var-STAGING_DIR_HOST'><filename>STAGING_DIR_HOST</filename></link>).
7902 </para>
7903 </glossdef>
7904 </glossentry>
7905
7906 <glossentry id='var-STAGING_INCDIR_NATIVE'><glossterm>STAGING_INCDIR_NATIVE</glossterm>
7907 <glossdef>
7908 <para>
7909 Specifies the path to the <filename>/usr/include</filename>
7910 subdirectory of the sysroot directory for the build host.
7911 </para>
7912 </glossdef>
7913 </glossentry>
7914
7915 <glossentry id='var-STAGING_LIBDIR'><glossterm>STAGING_LIBDIR</glossterm>
7916 <glossdef>
7917 <para>
7918 Specifies the path to the <filename>/usr/lib</filename>
7919 subdirectory of the sysroot directory for which the target
7920 is being built
7921 (<link linkend='var-STAGING_DIR_HOST'><filename>STAGING_DIR_HOST</filename></link>).
7922 </para>
7923 </glossdef>
7924 </glossentry>
7925
7926 <glossentry id='var-STAGING_LIBDIR_NATIVE'><glossterm>STAGING_LIBDIR_NATIVE</glossterm>
7927 <glossdef>
7928 <para>
7929 Specifies the path to the <filename>/usr/lib</filename>
7930 subdirectory of the sysroot directory for the build host.
7931 </para>
7932 </glossdef>
7933 </glossentry>
7934
7710 <glossentry id='var-STAGING_KERNEL_DIR'><glossterm>STAGING_KERNEL_DIR</glossterm> 7935 <glossentry id='var-STAGING_KERNEL_DIR'><glossterm>STAGING_KERNEL_DIR</glossterm>
7711 <glossdef> 7936 <glossdef>
7712 <para> 7937 <para>