summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual/ref-variables.xml
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2013-09-24 12:22:31 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2013-10-01 22:52:53 +0100
commit7bd3a81ef54b790943577409e30c825fe9d4182c (patch)
tree199b5426f5e5b1cf21fb876a6b944235da1573f9 /documentation/ref-manual/ref-variables.xml
parent155961db71e15356ce5ccd6baf4e57e5f9ad6799 (diff)
downloadpoky-7bd3a81ef54b790943577409e30c825fe9d4182c.tar.gz
ref-manual: New migration section for 1.5 and new variables
1. Created the first draft of the new migration section for moving to the YP 1.5 release. 2. Created new variable glossary descriptions for the SDK_NAME, IMAGE_NAME, and DATETIME variables. (From yocto-docs rev: 26e6a7675183b49a0ee8059d81218dbc5cd14bd4) 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.xml97
1 files changed, 96 insertions, 1 deletions
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml
index c7fb036c3f..c1e2013f42 100644
--- a/documentation/ref-manual/ref-variables.xml
+++ b/documentation/ref-manual/ref-variables.xml
@@ -24,7 +24,7 @@
24 <link linkend='var-FILES'>F</link> 24 <link linkend='var-FILES'>F</link>
25<!-- <link linkend='var-glossary-g'>G</link> --> 25<!-- <link linkend='var-glossary-g'>G</link> -->
26 <link linkend='var-HOMEPAGE'>H</link> 26 <link linkend='var-HOMEPAGE'>H</link>
27 <link linkend='var-IMAGE_CLASSES'>I</link> 27 <link linkend='var-IMAGE_BASENAME'>I</link>
28<!-- <link linkend='var-glossary-j'>J</link> --> 28<!-- <link linkend='var-glossary-j'>J</link> -->
29 <link linkend='var-KARCH'>K</link> 29 <link linkend='var-KARCH'>K</link>
30 <link linkend='var-LAYERDEPENDS'>L</link> 30 <link linkend='var-LAYERDEPENDS'>L</link>
@@ -819,6 +819,14 @@ Core layer for images cannot be removed
819 </glossdef> 819 </glossdef>
820 </glossentry> 820 </glossentry>
821 821
822 <glossentry id='var-BUSYBOX_SPLIT_SUID'><glossterm>BUSYBOX_SPLIT_SUID</glossterm>
823 <glossdef>
824 <para>
825 Need description.
826 </para>
827 </glossdef>
828 </glossentry>
829
822 </glossdiv> 830 </glossdiv>
823 831
824 <glossdiv id='var-glossary-c'><title>C</title> 832 <glossdiv id='var-glossary-c'><title>C</title>
@@ -885,6 +893,14 @@ Core layer for images cannot be removed
885 </glossdef> 893 </glossdef>
886 </glossentry> 894 </glossentry>
887 895
896 <glossentry id='var-COMPLEMENTARY_GLOBS'><glossterm>COMPLEMENTARY_GLOBS</glossterm>
897 <glossdef>
898 <para>
899 Need description.
900 </para>
901 </glossdef>
902 </glossentry>
903
888 <glossentry id='var-CONFFILES'><glossterm>CONFFILES</glossterm> 904 <glossentry id='var-CONFFILES'><glossterm>CONFFILES</glossterm>
889 <glossdef> 905 <glossdef>
890 <para> 906 <para>
@@ -994,6 +1010,17 @@ Core layer for images cannot be removed
994 </glossdef> 1010 </glossdef>
995 </glossentry> 1011 </glossentry>
996 1012
1013 <glossentry id='var-DATETIME'><glossterm>DATETIME</glossterm>
1014 <glossdef>
1015 <para>
1016 The date and time on which the build started:
1017 <literallayout class='monospaced'>
1018 date/time
1019 </literallayout>
1020 </para>
1021 </glossdef>
1022 </glossentry>
1023
997 <glossentry id='var-DEBUG_BUILD'><glossterm>DEBUG_BUILD</glossterm> 1024 <glossentry id='var-DEBUG_BUILD'><glossterm>DEBUG_BUILD</glossterm>
998 <glossdef> 1025 <glossdef>
999 <para> 1026 <para>
@@ -1853,6 +1880,14 @@ Core layer for images cannot be removed
1853 1880
1854 <glossdiv id='var-glossary-i'><title>I</title> 1881 <glossdiv id='var-glossary-i'><title>I</title>
1855 1882
1883 <glossentry id='var-IMAGE_BASENAME'><glossterm>IMAGE_BASENAME</glossterm>
1884 <glossdef>
1885 <para>
1886 Need description.
1887 </para>
1888 </glossdef>
1889 </glossentry>
1890
1856 <glossentry id='var-IMAGE_CLASSES'><glossterm>IMAGE_CLASSES</glossterm> 1891 <glossentry id='var-IMAGE_CLASSES'><glossterm>IMAGE_CLASSES</glossterm>
1857 <glossdef> 1892 <glossdef>
1858 <para> 1893 <para>
@@ -1992,6 +2027,23 @@ Core layer for images cannot be removed
1992 </glossdef> 2027 </glossdef>
1993 </glossentry> 2028 </glossentry>
1994 2029
2030 <glossentry id='var-IMAGE_NAME'><glossterm>IMAGE_NAME</glossterm>
2031 <glossdef>
2032 <para>
2033 The name of the output image files minus the extension.
2034 This variable is derived using the
2035 <link linkend='var-IMAGE_BASENAME'><filename>IMAGE_BASENAME</filename></link>
2036 <link linkend='var-MACHINE'><filename>MACHINE</filename></link>
2037 and
2038 <link linkend='var-DATETIME'><filename>DATETIME</filename></link>
2039 variables:
2040 <literallayout class='monospaced'>
2041 IMAGE_NAME = "${IMAGE_BASENAME}-${MACHINE}-${DATETIME}"
2042 </literallayout>
2043 </para>
2044 </glossdef>
2045 </glossentry>
2046
1995 <glossentry id='var-IMAGE_OVERHEAD_FACTOR'><glossterm>IMAGE_OVERHEAD_FACTOR</glossterm> 2047 <glossentry id='var-IMAGE_OVERHEAD_FACTOR'><glossterm>IMAGE_OVERHEAD_FACTOR</glossterm>
1996 <glossdef> 2048 <glossdef>
1997 <para> 2049 <para>
@@ -3620,6 +3672,14 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
3620 </glossdef> 3672 </glossdef>
3621 </glossentry> 3673 </glossentry>
3622 3674
3675 <glossentry id='var-PACKAGE_GROUP'><glossterm>PACKAGE_GROUP</glossterm>
3676 <glossdef>
3677 <para>
3678 Need description.
3679 </para>
3680 </glossdef>
3681 </glossentry>
3682
3623 <glossentry id='var-PACKAGE_INSTALL'><glossterm>PACKAGE_INSTALL</glossterm> 3683 <glossentry id='var-PACKAGE_INSTALL'><glossterm>PACKAGE_INSTALL</glossterm>
3624 <glossdef> 3684 <glossdef>
3625 <para> 3685 <para>
@@ -4567,6 +4627,33 @@ PARALLEL_MAKEINST with the description ".
4567 </glossdef> 4627 </glossdef>
4568 </glossentry> 4628 </glossentry>
4569 4629
4630 <glossentry id='var-SDK_ARCH'><glossterm>SDK_ARCH</glossterm>
4631 <glossdef>
4632 <para>
4633 Need description.
4634 </para>
4635 </glossdef>
4636 </glossentry>
4637
4638 <glossentry id='var-SDK_NAME'><glossterm>SDK_NAME</glossterm>
4639 <glossdef>
4640 <para>
4641 The base name for SDK output files.
4642 The name is derived from the
4643 <link linkend='var-DISTRO'><filename>DISTRO</filename></link>,
4644 <link linkend='var-TCLIBC'><filename>TCLIBC</filename></link>,
4645 <link linkend='var-SDK_ARCH'><filename>SDK_ARCH</filename></link>,
4646 <link linkend='var-IMAGE_BASENAME'><filename>IMAGE_BASENAME</filename></link>,
4647 and
4648 <link linkend='var-TUNE_PKGARCH'><filename>TUNE_PKGARCH</filename></link>
4649 variables:
4650 <literallayout class='monospaced'>
4651 SDK_NAME = "${DISTRO}-${TCLIBC}-${SDK_ARCH}-${IMAGE_BASENAME}-${TUNE_PKGARCH}"
4652 </literallayout>
4653 </para>
4654 </glossdef>
4655 </glossentry>
4656
4570 <glossentry id='var-SDKIMAGE_FEATURES'><glossterm>SDKIMAGE_FEATURES</glossterm> 4657 <glossentry id='var-SDKIMAGE_FEATURES'><glossterm>SDKIMAGE_FEATURES</glossterm>
4571 <glossdef> 4658 <glossdef>
4572 <para>Equivalent to 4659 <para>Equivalent to
@@ -5480,6 +5567,14 @@ PARALLEL_MAKEINST with the description ".
5480 </glossdef> 5567 </glossdef>
5481 </glossentry> 5568 </glossentry>
5482 5569
5570 <glossentry id='var-TUNE_PKGARCH'><glossterm>TUNE_PKGARCH</glossterm>
5571 <glossdef>
5572 <para>
5573 Need description.
5574 </para>
5575 </glossdef>
5576 </glossentry>
5577
5483 </glossdiv> 5578 </glossdiv>
5484 5579
5485 <glossdiv id='var-glossary-u'><title>U</title> 5580 <glossdiv id='var-glossary-u'><title>U</title>