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.xml81
1 files changed, 68 insertions, 13 deletions
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml
index c1e2013f42..cf964c78a7 100644
--- a/documentation/ref-manual/ref-variables.xml
+++ b/documentation/ref-manual/ref-variables.xml
@@ -822,7 +822,18 @@ Core layer for images cannot be removed
822 <glossentry id='var-BUSYBOX_SPLIT_SUID'><glossterm>BUSYBOX_SPLIT_SUID</glossterm> 822 <glossentry id='var-BUSYBOX_SPLIT_SUID'><glossterm>BUSYBOX_SPLIT_SUID</glossterm>
823 <glossdef> 823 <glossdef>
824 <para> 824 <para>
825 Need description. 825 For the BusyBox recipe, specifies whether to split the
826 output executable file into two parts: one for features
827 that require <filename>setuid root</filename>, and one for
828 the remaining features (i.e. those that do not require
829 <filename>setuid root</filename>).
830 </para>
831
832 <para>
833 The <filename>BUSYBOX_SPLIT_SUID</filename> variable
834 defaults to "1", which results in a single output
835 executable file.
836 Set the variable to "0" to split the output file.
826 </para> 837 </para>
827 </glossdef> 838 </glossdef>
828 </glossentry> 839 </glossentry>
@@ -893,10 +904,29 @@ Core layer for images cannot be removed
893 </glossdef> 904 </glossdef>
894 </glossentry> 905 </glossentry>
895 906
896 <glossentry id='var-COMPLEMENTARY_GLOBS'><glossterm>COMPLEMENTARY_GLOBS</glossterm> 907 <glossentry id='var-COMPLEMENTARY_GLOB'><glossterm>COMPLEMENTARY_GLOB</glossterm>
897 <glossdef> 908 <glossdef>
898 <para> 909 <para>
899 Need description. 910 Defines wildcards you can use when installing a list of
911 complementary packages for all the packages explicitly
912 (or implicitly) installed in an image.
913 The resulting list of complementary packages is associated
914 with an item that can be added to
915 <link linkend='var-IMAGE_FEATURES'><filename>IMAGE_FEATURES</filename></link>.
916 An example usage of this is the "dev-pkgs" item that when
917 added to <filename>IMAGE_FEATURES</filename> will
918 install -dev packages (containing headers and other
919 development files) for every package in the image.
920 </para>
921
922 <para>
923 To add a new feature item pointing to a wildcard, use a
924 variable flag to specify the feature item name and
925 use the value to specify the wildcard.
926 Here is an example:
927 <literallayout class='monospaced'>
928 COMPLEMENTARY_GLOB[dev-pkgs] = '*-dev'
929 </literallayout>
900 </para> 930 </para>
901 </glossdef> 931 </glossdef>
902 </glossentry> 932 </glossentry>
@@ -1013,10 +1043,8 @@ Core layer for images cannot be removed
1013 <glossentry id='var-DATETIME'><glossterm>DATETIME</glossterm> 1043 <glossentry id='var-DATETIME'><glossterm>DATETIME</glossterm>
1014 <glossdef> 1044 <glossdef>
1015 <para> 1045 <para>
1016 The date and time on which the build started: 1046 The date and time on which the current build started.
1017 <literallayout class='monospaced'> 1047 The format is suitable for timestamps.
1018 date/time
1019 </literallayout>
1020 </para> 1048 </para>
1021 </glossdef> 1049 </glossdef>
1022 </glossentry> 1050 </glossentry>
@@ -1883,7 +1911,9 @@ Core layer for images cannot be removed
1883 <glossentry id='var-IMAGE_BASENAME'><glossterm>IMAGE_BASENAME</glossterm> 1911 <glossentry id='var-IMAGE_BASENAME'><glossterm>IMAGE_BASENAME</glossterm>
1884 <glossdef> 1912 <glossdef>
1885 <para> 1913 <para>
1886 Need description. 1914 The base name of image output files.
1915 This variable defaults to the recipe name
1916 (<filename>${</filename><link linkend='var-PN'><filename>PN</filename></link><filename>}</filename>).
1887 </para> 1917 </para>
1888 </glossdef> 1918 </glossdef>
1889 </glossentry> 1919 </glossentry>
@@ -2032,8 +2062,8 @@ Core layer for images cannot be removed
2032 <para> 2062 <para>
2033 The name of the output image files minus the extension. 2063 The name of the output image files minus the extension.
2034 This variable is derived using the 2064 This variable is derived using the
2035 <link linkend='var-IMAGE_BASENAME'><filename>IMAGE_BASENAME</filename></link> 2065 <link linkend='var-IMAGE_BASENAME'><filename>IMAGE_BASENAME</filename></link>,
2036 <link linkend='var-MACHINE'><filename>MACHINE</filename></link> 2066 <link linkend='var-MACHINE'><filename>MACHINE</filename></link>,
2037 and 2067 and
2038 <link linkend='var-DATETIME'><filename>DATETIME</filename></link> 2068 <link linkend='var-DATETIME'><filename>DATETIME</filename></link>
2039 variables: 2069 variables:
@@ -3675,7 +3705,27 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
3675 <glossentry id='var-PACKAGE_GROUP'><glossterm>PACKAGE_GROUP</glossterm> 3705 <glossentry id='var-PACKAGE_GROUP'><glossterm>PACKAGE_GROUP</glossterm>
3676 <glossdef> 3706 <glossdef>
3677 <para> 3707 <para>
3678 Need description. 3708 Defines one or more packages to include in an image when
3709 a specific item is included in
3710 <link linkend='var-IMAGE_FEATURES'><filename>IMAGE_FEATURES</filename></link>.
3711 When setting the value, <filename>PACKAGE_GROUP</filename>
3712 should have the name of the feature item as an override.
3713 Here is an example:
3714 <literallayout class='monospaced'>
3715 PACKAGE_GROUP_widget = "package1 package2"
3716 </literallayout>
3717 In this example, if "widget" were added to
3718 <filename>IMAGE_FEATURES</filename>, "package1" and
3719 "package2" would be included in the image.
3720 <note>
3721 Packages installed by features defined through
3722 <filename>PACKAGE_GROUP</filename> are often package
3723 groups.
3724 While similarly named, you should not confuse the
3725 <filename>PACKAGE_GROUP</filename> variable with
3726 package groups, which are discussed elsewhere in the
3727 documentation.
3728 </note>
3679 </para> 3729 </para>
3680 </glossdef> 3730 </glossdef>
3681 </glossentry> 3731 </glossentry>
@@ -4630,7 +4680,10 @@ PARALLEL_MAKEINST with the description ".
4630 <glossentry id='var-SDK_ARCH'><glossterm>SDK_ARCH</glossterm> 4680 <glossentry id='var-SDK_ARCH'><glossterm>SDK_ARCH</glossterm>
4631 <glossdef> 4681 <glossdef>
4632 <para> 4682 <para>
4633 Need description. 4683 The target architecture for the SDK.
4684 Typically, you do not directly set this variable.
4685 Instead, use
4686 <link linkend='var-SDKMACHINE'><filename>SDKMACHINE</filename></link>.
4634 </para> 4687 </para>
4635 </glossdef> 4688 </glossdef>
4636 </glossentry> 4689 </glossentry>
@@ -5570,7 +5623,9 @@ PARALLEL_MAKEINST with the description ".
5570 <glossentry id='var-TUNE_PKGARCH'><glossterm>TUNE_PKGARCH</glossterm> 5623 <glossentry id='var-TUNE_PKGARCH'><glossterm>TUNE_PKGARCH</glossterm>
5571 <glossdef> 5624 <glossdef>
5572 <para> 5625 <para>
5573 Need description. 5626 The package architecture understood by the packaging
5627 system to define the architecture, ABI, and tuning of
5628 output packages.
5574 </para> 5629 </para>
5575 </glossdef> 5630 </glossdef>
5576 </glossentry> 5631 </glossentry>