summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
Diffstat (limited to 'documentation')
-rw-r--r--documentation/ref-manual/ref-variables.xml322
1 files changed, 302 insertions, 20 deletions
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml
index 240201068d..18f358737f 100644
--- a/documentation/ref-manual/ref-variables.xml
+++ b/documentation/ref-manual/ref-variables.xml
@@ -67,6 +67,141 @@
67 </glossdef> 67 </glossdef>
68 </glossentry> 68 </glossentry>
69 69
70 <glossentry id='var-ALTERNATIVE'><glossterm>ALTERNATIVE</glossterm>
71 <glossdef>
72 <para>
73 Lists commands in a package that need an alternative
74 binary naming scheme.
75 Sometimes the same command is provided in multiple packages.
76 When this occurs, the OpenEmbedded build system needs to
77 use the alternatives system to create a different binary
78 naming scheme so the commands can co-exist.
79 </para>
80
81 <para>
82 To use the variable, list out the package's commands
83 that also exist as part of another package.
84 For example, if the <filename>busybox</filename> package
85 has four commands that also exist as part of another
86 package, you identify them as follows:
87 <literallayout class='monospaced'>
88 ALTERNATIVE_busybox = "sh sed test bracket"
89 </literallayout>
90 For more information on the alternatives system, see the
91 "<link linkend='ref-classes-update-alternatives'>Alternatives - <filename>update-alternatives.bbclass</filename></link>"
92 section.
93 </para>
94 </glossdef>
95 </glossentry>
96
97 <glossentry id='var-ALTERNATIVE_LINK_NAME'><glossterm>ALTERNATIVE_LINK_NAME</glossterm>
98 <glossdef>
99 <para>
100 Used by the alternatives system to map duplicated commands
101 to actual locations.
102 For example, if the <filename>bracket</filename> command
103 provided by the <filename>busybox</filename> package is
104 duplicated through another package, you must use the
105 <filename>ALTERNATIVE_LINK_NAME</filename> variable to
106 specify the actual location:
107 <literallayout class='monospaced'>
108 ALTERNATIVE_LINK_NAME[bracket] = "/usr/bin/["
109 </literallayout>
110 In this example, the binary for the
111 <filename>bracket</filename> command (i.e.
112 <filename>[</filename>) from the
113 <filename>busybox</filename> package resides in
114 <filename>/usr/bin/</filename>.
115 <note>
116 If <filename>ALTERNATIVE_LINK_NAME</filename> is not
117 defined, it defaults to
118 <filename>${bindir}/&lt;name&gt;</filename>.
119 </note>
120 </para>
121
122 <para>
123 For more information on the alternatives system, see the
124 "<link linkend='ref-classes-update-alternatives'>Alternatives - <filename>update-alternatives.bbclass</filename></link>"
125 section.
126 </para>
127 </glossdef>
128 </glossentry>
129
130 <glossentry id='var-ALTERNATIVE_PRIORITY'><glossterm>ALTERNATIVE_PRIORITY</glossterm>
131 <glossdef>
132 <para>
133 Used by the alternatives system to create default
134 priorities for duplicated commands.
135 You can use the variable to create a single default
136 regardless of the command name or package, a default for
137 specific duplicated commands regardless of the package, or
138 a default for specific commands tied to particular packages.
139 Here are the available syntax forms:
140 <literallayout class='monospaced'>
141 ALTERNATIVE_PRIORITY = "&lt;priority&gt;"
142 ALTERNATIVE_PRIORITY[&lt;name&gt;] = "&lt;priority&gt;"
143 ALTERNATIVE_PRIORITY_&lt;pkg&gt;[&lt;name&gt;] = "&lt;priority&gt;"
144 </literallayout>
145 </para>
146
147 <para>
148 For more information on the alternatives system, see the
149 "<link linkend='ref-classes-update-alternatives'>Alternatives - <filename>update-alternatives.bbclass</filename></link>"
150 section.
151 </para>
152 </glossdef>
153 </glossentry>
154
155 <glossentry id='var-ALTERNATIVE_TARGET'><glossterm>ALTERNATIVE_TARGET</glossterm>
156 <glossdef>
157 <para>
158 Used by the alternatives system to create default link
159 locations for duplicated commands.
160 You can use the variable to create a single default
161 location for all duplicated commands regardless of the
162 command name or package, a default for
163 specific duplicated commands regardless of the package, or
164 a default for specific commands tied to particular packages.
165 Here are the available syntax forms:
166 <literallayout class='monospaced'>
167 ALTERNATIVE_TARGET = "&lt;target&gt;"
168 ALTERNATIVE_TARGET[&lt;name&gt;] = "&lt;target&gt;"
169 ALTERNATIVE_TARGET_&lt;pkg&gt;[&lt;name&gt;] = "&lt;target&gt;"
170 </literallayout>
171 <note>
172 <para>
173 If <filename>ALTERNATIVE_TARGET</filename> is not
174 defined, it inherits the value from the
175 <link linkend='var-ALTERNATIVE_LINK_NAME'><filename>ALTERNATIVE_LINK_NAME</filename></link>
176 variable.
177 </para>
178
179 <para>
180 If <filename>ALTERNATIVE_LINK_NAME</filename> and
181 <filename>ALTERNATIVE_TARGET</filename> are the
182 same, the target for
183 <filename>ALTERNATIVE_TARGET</filename>
184 has "<filename>.{BPN}</filename>" appended to it.
185 </para>
186
187 <para>
188 Finally, if the file referenced has not been
189 renamed, the alternatives system will rename it to
190 avoid the need to rename alternative files in the
191 <filename>do_install</filename> task while
192 retaining support for the command if necessary.
193 </para>
194 </note>
195 </para>
196
197 <para>
198 For more information on the alternatives system, see the
199 "<link linkend='ref-classes-update-alternatives'>Alternatives - <filename>update-alternatives.bbclass</filename></link>"
200 section.
201 </para>
202 </glossdef>
203 </glossentry>
204
70 <glossentry id='var-AUTHOR'><glossterm>AUTHOR</glossterm> 205 <glossentry id='var-AUTHOR'><glossterm>AUTHOR</glossterm>
71 <glossdef> 206 <glossdef>
72 <para>The email address used to contact the original author 207 <para>The email address used to contact the original author
@@ -579,19 +714,6 @@ Core layer for images cannot be removed
579 </glossdef> 714 </glossdef>
580 </glossentry> 715 </glossentry>
581 716
582<!--
583 <glossentry id='var-BUILDHISTORY_CHECKVERBACKWARDS'><glossterm>BUILDHISTORY_CHECKVERBACKWARDS</glossterm>
584 <glossdef>
585 <para>
586 When Build History is enabled, setting this variable to "0"
587 disables the check for package versions going backwards.
588 During 1.5 development, a patch surfaced late that might
589 eliminate the need for this variable.
590 I am commenting it out for now until more is known.
591 </para>
592 </glossdef>
593 </glossentry>
594-->
595 </glossdiv> 717 </glossdiv>
596 718
597 <glossdiv id='var-glossary-c'><title>C</title> 719 <glossdiv id='var-glossary-c'><title>C</title>
@@ -615,6 +737,17 @@ Core layer for images cannot be removed
615 </glossdef> 737 </glossdef>
616 </glossentry> 738 </glossentry>
617 739
740 <glossentry id='var-COMMON_LICENSE_DIR'><glossterm>COMMON_LICENSE_DIR</glossterm>
741 <glossdef>
742 <para>
743 Points to <filename>meta/files/common-licenses</filename>
744 in the
745 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>,
746 which is where generic license files reside.
747 </para>
748 </glossdef>
749 </glossentry>
750
618 <glossentry id='var-COMPATIBLE_HOST'><glossterm>COMPATIBLE_HOST</glossterm> 751 <glossentry id='var-COMPATIBLE_HOST'><glossterm>COMPATIBLE_HOST</glossterm>
619 <glossdef> 752 <glossdef>
620 <para>A regular expression that resolves to one or more hosts 753 <para>A regular expression that resolves to one or more hosts
@@ -1043,6 +1176,30 @@ Core layer for images cannot be removed
1043 </glossdef> 1176 </glossdef>
1044 </glossentry> 1177 </glossentry>
1045 1178
1179 <glossentry id='var-EXCLUDE_FROM_WORLD'><glossterm>EXCLUDE_FROM_WORLD</glossterm>
1180 <glossdef>
1181 <para>
1182 Directs BitBake to exclude a recipe from world builds (i.e.
1183 <filename>bitbake world</filename>).
1184 This variable is intrinsically understood by BitBake.
1185 </para>
1186
1187 <note>
1188 During world builds, BitBake locates, parses and builds all
1189 recipes found in every layer exposed in the
1190 <filename>bblayers.conf</filename> configuration file.
1191 </note>
1192
1193 <para>
1194 To exclude a recipe from a world build using this variable,
1195 set the variable to "1" in the recipe.
1196 Alternatively, if a recipe inherits a class where
1197 <filename>EXCLUDE_FROM_WORLD</filename> is set to "1", that
1198 recipe will also be excluded from world builds.
1199 </para>
1200 </glossdef>
1201 </glossentry>
1202
1046 <glossentry id='var-EXTENDPKGV'><glossterm>EXTENDPKGV</glossterm> 1203 <glossentry id='var-EXTENDPKGV'><glossterm>EXTENDPKGV</glossterm>
1047 <glossdef> 1204 <glossdef>
1048 <para> 1205 <para>
@@ -1798,7 +1955,8 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
1798 </para> 1955 </para>
1799 1956
1800 <para> 1957 <para>
1801 Set the variable to "1" to prevent the default dependencies. 1958 Set the variable to "1" to prevent the default dependencies
1959 from being added.
1802 </para> 1960 </para>
1803 </glossdef> 1961 </glossdef>
1804 </glossentry> 1962 </glossentry>
@@ -1821,6 +1979,17 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
1821 </glossdef> 1979 </glossdef>
1822 </glossentry> 1980 </glossentry>
1823 1981
1982 <glossentry id='var-INITRAMFS_FSTYPES'><glossterm>INITRAMFS_FSTYPES</glossterm>
1983 <glossdef>
1984 <para>
1985 Defines the format for the output image of an initial
1986 RAM disk (initramfs), which is used during boot.
1987 Supported formats are the same as those supported by the
1988 <link linkend='var-IMAGE_FSTYPES'><filename>IMAGE_FSTYPES</filename></link>
1989 variable.
1990 </para>
1991 </glossdef>
1992 </glossentry>
1824 1993
1825 <glossentry id='var-INITSCRIPT_PACKAGES'><glossterm>INITSCRIPT_PACKAGES</glossterm> 1994 <glossentry id='var-INITSCRIPT_PACKAGES'><glossterm>INITSCRIPT_PACKAGES</glossterm>
1826 <glossdef> 1995 <glossdef>
@@ -1889,6 +2058,38 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
1889 </glossdef> 2058 </glossdef>
1890 </glossentry> 2059 </glossentry>
1891 2060
2061 <glossentry id='var-INTERCEPT_DIR'><glossterm>INTERCEPT_DIR</glossterm>
2062 <glossdef>
2063 <para>
2064 An environment variable that defines the directory where
2065 post installation hooks are installed for the
2066 post install environment.
2067 This variable is fixed as follows:
2068 <literallayout class='monospaced'>
2069 ${WORKDIR}/intercept_scripts
2070 </literallayout>
2071 </para>
2072
2073 <para>
2074 After installation of a target's root filesystem,
2075 post installation scripts, which are essentially bash scripts,
2076 are all executed just a single time.
2077 Limiting execution of these scripts minimizes installation
2078 time that would be lengthened due to certain packages
2079 triggering redundant operations.
2080 For example, consider the installation of font packages
2081 as a common example.
2082 Without limiting the execution of post installation scripts,
2083 all font directories would be rescanned to create the
2084 cache after each individual font package was installed.
2085 </para>
2086
2087 <para>
2088 Do not edit the <filename>INTERCEPT_DIR</filename>
2089 variable.
2090 </para>
2091 </glossdef>
2092 </glossentry>
1892 2093
1893 </glossdiv> 2094 </glossdiv>
1894 2095
@@ -2875,6 +3076,25 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
2875 </glossdef> 3076 </glossdef>
2876 </glossentry> 3077 </glossentry>
2877 3078
3079 <glossentry id='var-OLDEST_KERNEL'><glossterm>OLDEST_KERNEL</glossterm>
3080 <glossdef>
3081 <para>
3082 Declares the oldest version of the Linux kernel that the
3083 produced binaries must support.
3084 This variable is passed into the build of the Embedded
3085 GNU C Library (<filename>eglibc</filename>).
3086 </para>
3087
3088 <para>
3089 The default for this variable comes from the
3090 <filename>meta/conf/bitbake.conf</filename> configuration
3091 file.
3092 You can override this default by setting the variable
3093 in a custom distribution configuration file.
3094 </para>
3095 </glossdef>
3096 </glossentry>
3097
2878 <glossentry id='var-OVERRIDES'><glossterm>OVERRIDES</glossterm> 3098 <glossentry id='var-OVERRIDES'><glossterm>OVERRIDES</glossterm>
2879 <glossdef> 3099 <glossdef>
2880 <para> 3100 <para>
@@ -3091,8 +3311,8 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
3091 during <filename>do_patch</filename>. 3311 during <filename>do_patch</filename>.
3092 The default utility used is "quilt" except for the 3312 The default utility used is "quilt" except for the
3093 quilt-native recipe itself. 3313 quilt-native recipe itself.
3094 Because the quilt-native recipe is not available at the 3314 Because the quilt tool is not available at the
3095 time it is being patched, it uses "patch". 3315 time quilt-native is being patched, it uses "patch".
3096 </para> 3316 </para>
3097 3317
3098 <para> 3318 <para>
@@ -3648,10 +3868,19 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
3648 <glossentry id='var-SERIAL_CONSOLE'><glossterm>SERIAL_CONSOLE</glossterm> 3868 <glossentry id='var-SERIAL_CONSOLE'><glossterm>SERIAL_CONSOLE</glossterm>
3649 <glossdef> 3869 <glossdef>
3650 <para> 3870 <para>
3651 This variable is deprecated. 3871 Define a serial console (TTY) to enable using getty.
3652 See the 3872 Provide a value that specifies the baud rate followed by
3653 <link linkend='var-SERIAL_CONSOLES'><filename>SERIAL_CONSOLES</filename></link> 3873 the TTY device name separated by a space.
3654 variable. 3874 You cannot specify more than one TTY device:
3875 <literallayout class='monospaced'>
3876 SERIAL_CONSOLE = "115200 ttyS0"
3877 </literallayout>
3878 <note>
3879 The <filename>SERIAL_CONSOLE</filename> is deprecated.
3880 Please use the
3881 <link linkend='var-SERIAL_CONSOLES'><filename>SERIAL_CONSOLES</filename></link>
3882 variable.
3883 </note>
3655 </para> 3884 </para>
3656 </glossdef> 3885 </glossdef>
3657 </glossentry> 3886 </glossentry>
@@ -3767,6 +3996,42 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
3767 </glossdef> 3996 </glossdef>
3768 </glossentry> 3997 </glossentry>
3769 3998
3999 <glossentry id='var-SOLIBS'><glossterm>SOLIBS</glossterm>
4000 <glossdef>
4001 <para>
4002 Defines the suffix for shared libraries used on the
4003 target platform.
4004 By default, this suffix is ".so.*" for all Linux
4005 distributions and is defined in the
4006 <filename>meta/conf/bitbake.conf</filename> configuration
4007 file.
4008 </para>
4009
4010 <para>
4011 You will see this variable referenced in the default values
4012 of <filename>FILES_${PN}</filename>.
4013 </para>
4014 </glossdef>
4015 </glossentry>
4016
4017 <glossentry id='var-SOLIBSDEV'><glossterm>SOLIBSDEV</glossterm>
4018 <glossdef>
4019 <para>
4020 Defines the suffix for the development symbolic link
4021 (symlink) for shared libraries on the target platform.
4022 By default, this suffix is ".so" for all Linux
4023 distributions and is defined in the
4024 <filename>meta/conf/bitbake.conf</filename> configuration
4025 file.
4026 </para>
4027
4028 <para>
4029 You will see this variable referenced in the default values
4030 of <filename>FILES_${PN}</filename>.
4031 </para>
4032 </glossdef>
4033 </glossentry>
4034
3770 <glossentry id='var-SPECIAL_PKGSUFFIX'><glossterm>SPECIAL_PKGSUFFIX</glossterm> 4035 <glossentry id='var-SPECIAL_PKGSUFFIX'><glossterm>SPECIAL_PKGSUFFIX</glossterm>
3771 <glossdef> 4036 <glossdef>
3772 <para> 4037 <para>
@@ -4319,6 +4584,23 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
4319 </glossdef> 4584 </glossdef>
4320 </glossentry> 4585 </glossentry>
4321 4586
4587 <glossentry id='var-TRANSLATED_TARGET_ARCH'><glossterm>TRANSLATED_TARGET_ARCH</glossterm>
4588 <glossdef>
4589 <para>
4590 A sanitized version of
4591 <link linkend='var-TARGET_ARCH'><filename>TARGET_ARCH</filename></link>.
4592 This variable is used when package filenames contain
4593 underscore characters that would otherwise not be allowed.
4594 In this case, dash characters replace the underscore
4595 characters used in the package names.
4596 </para>
4597
4598 <para>
4599 Do not edit this variable.
4600 </para>
4601 </glossdef>
4602 </glossentry>
4603
4322 </glossdiv> 4604 </glossdiv>
4323 4605
4324<!-- <glossdiv id='var-glossary-u'><title>U</title>--> 4606<!-- <glossdiv id='var-glossary-u'><title>U</title>-->