diff options
Diffstat (limited to 'documentation/ref-manual/ref-variables.xml')
-rw-r--r-- | documentation/ref-manual/ref-variables.xml | 124 |
1 files changed, 116 insertions, 8 deletions
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml index 5f2a2a716c..5fd459fc34 100644 --- a/documentation/ref-manual/ref-variables.xml +++ b/documentation/ref-manual/ref-variables.xml | |||
@@ -598,16 +598,34 @@ Core layer for images cannot be removed | |||
598 | </glossdef> | 598 | </glossdef> |
599 | </glossentry> | 599 | </glossentry> |
600 | 600 | ||
601 | <glossentry id='var-COMPATIBLE_HOST'><glossterm>COMPATIBLE_HOST</glossterm> | ||
602 | <glossdef> | ||
603 | <para>A regular expression matched against | ||
604 | <link linkend="var-HOST_SYS"><filename>HOST_SYS</filename></link> | ||
605 | that the OpenEmbedded build system evaulates against | ||
606 | systems with which the recipe works. | ||
607 | You can use the variable to stop recipes from being built | ||
608 | for classes of systems with which the recipes are not | ||
609 | compatible. | ||
610 | Stopping these builds is particularly useful with kernels. | ||
611 | The variable also helps to increase parsing speed | ||
612 | since the build system skips parsing recipes not | ||
613 | compatible with the current system.</para> | ||
614 | </glossdef> | ||
615 | </glossentry> | ||
616 | |||
601 | <glossentry id='var-COMPATIBLE_MACHINE'><glossterm>COMPATIBLE_MACHINE</glossterm> | 617 | <glossentry id='var-COMPATIBLE_MACHINE'><glossterm>COMPATIBLE_MACHINE</glossterm> |
602 | <glossdef> | 618 | <glossdef> |
603 | <para>A regular expression that evaluates to match the machines | 619 | <para>A regular expression matched against |
604 | with which the recipe works. | 620 | <link linkend="var-MACHINEOVERRIDES"><filename>MACHINEOVERRIDES</filename></link> |
605 | You can use the variable to stop recipes from being run | 621 | that the OpenEmbedded build system evaluates against |
606 | on machines for which they are not compatible. | 622 | machines with which the recipe works. |
607 | This is particularly useful with kernels. | 623 | You can use the variable to stop recipes from being built |
608 | The variable also helps to increase parsing speed as | 624 | for machines with which the recipes are not compatible. |
609 | further parsing of the recipe is skipped if it is found | 625 | Stopping these builds is particularly useful with kernels. |
610 | the current machine is not compatible.</para> | 626 | The variable also helps to increase parsing speed |
627 | since the build system skips parsing recipes not | ||
628 | compatible with the current machine.</para> | ||
611 | </glossdef> | 629 | </glossdef> |
612 | </glossentry> | 630 | </glossentry> |
613 | 631 | ||
@@ -869,6 +887,22 @@ Core layer for images cannot be removed | |||
869 | </glossdef> | 887 | </glossdef> |
870 | </glossentry> | 888 | </glossentry> |
871 | 889 | ||
890 | <glossentry id='var-DISTROOVERRIDES'><glossterm>DISTROOVERRIDES</glossterm> | ||
891 | <glossdef> | ||
892 | <para> | ||
893 | This variable lists overrides specific to the current | ||
894 | distribution. | ||
895 | By default, the variable list includes the value of the | ||
896 | <filename><link linkend='var-DISTRO'>DISTRO</link></filename> | ||
897 | variable. | ||
898 | You can extend the variable to apply any variable overrides | ||
899 | you want as part of the distribution and are not | ||
900 | already in <filename>OVERRIDES</filename> through | ||
901 | some other means. | ||
902 | </para> | ||
903 | </glossdef> | ||
904 | </glossentry> | ||
905 | |||
872 | <glossentry id='var-DL_DIR'><glossterm>DL_DIR</glossterm> | 906 | <glossentry id='var-DL_DIR'><glossterm>DL_DIR</glossterm> |
873 | <glossdef> | 907 | <glossdef> |
874 | <para> | 908 | <para> |
@@ -1221,6 +1255,33 @@ Core layer for images cannot be removed | |||
1221 | </glossdef> | 1255 | </glossdef> |
1222 | </glossentry> | 1256 | </glossentry> |
1223 | 1257 | ||
1258 | <glossentry id='var-HOST_SYS'><glossterm>HOST_SYS</glossterm> | ||
1259 | <glossdef> | ||
1260 | <para> | ||
1261 | Specifies the system, including the architecture and the | ||
1262 | operating system, being built in the context of the current | ||
1263 | recipe. | ||
1264 | The OpenEmbedded build system automatically sets this | ||
1265 | variable. | ||
1266 | You do not need to set the variable yourself. | ||
1267 | </para> | ||
1268 | |||
1269 | <para> | ||
1270 | Here are two examples: | ||
1271 | <itemizedlist> | ||
1272 | <listitem><para>Given a native recipe on a 32-bit | ||
1273 | x86 machine running Linux, the value is | ||
1274 | "i686-linux". | ||
1275 | </para></listitem> | ||
1276 | <listitem><para>Given a recipe being built for a | ||
1277 | little-endian MIPS target running Linux, | ||
1278 | the value might be "mipsel-linux". | ||
1279 | </para></listitem> | ||
1280 | </itemizedlist> | ||
1281 | </para> | ||
1282 | </glossdef> | ||
1283 | </glossentry> | ||
1284 | |||
1224 | </glossdiv> | 1285 | </glossdiv> |
1225 | 1286 | ||
1226 | <glossdiv id='var-glossary-i'><title>I</title> | 1287 | <glossdiv id='var-glossary-i'><title>I</title> |
@@ -2336,6 +2397,35 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
2336 | </glossdef> | 2397 | </glossdef> |
2337 | </glossentry> | 2398 | </glossentry> |
2338 | 2399 | ||
2400 | <glossentry id='var-MACHINEOVERRIDES'><glossterm>MACHINEOVERRIDES</glossterm> | ||
2401 | <glossdef> | ||
2402 | <para> | ||
2403 | Lists overrides specific to the current machine. | ||
2404 | By default, this list includes the value | ||
2405 | of <filename><link linkend='var-MACHINE'>MACHINE</link></filename>. | ||
2406 | You can extend the list to apply variable overrides for | ||
2407 | classes of machines. | ||
2408 | For example, all QEMU emulated machines (e.g. qemuarm, | ||
2409 | qemux86, and so forth) include a common file named | ||
2410 | <filename>meta/conf/machine/include/qemu.inc</filename> | ||
2411 | that prepends <filename>MACHINEOVERRIDES</filename> with | ||
2412 | the following variable override: | ||
2413 | <literallayout class='monospaced'> | ||
2414 | MACHINEOVERRIDES =. "qemuall:" | ||
2415 | </literallayout> | ||
2416 | Applying an override like <filename>qemuall</filename> | ||
2417 | affects all QEMU emulated machines elsewhere. | ||
2418 | Here is an example from the | ||
2419 | <filename>connman-conf</filename> recipe: | ||
2420 | <literallayout class='monospaced'> | ||
2421 | SRC_URI_append_qemuall = "file://wired.config \ | ||
2422 | file://wired-setup \ | ||
2423 | " | ||
2424 | </literallayout> | ||
2425 | </para> | ||
2426 | </glossdef> | ||
2427 | </glossentry> | ||
2428 | |||
2339 | <glossentry id='var-MAINTAINER'><glossterm>MAINTAINER</glossterm> | 2429 | <glossentry id='var-MAINTAINER'><glossterm>MAINTAINER</glossterm> |
2340 | <glossdef> | 2430 | <glossdef> |
2341 | <para>The email address of the distribution maintainer.</para> | 2431 | <para>The email address of the distribution maintainer.</para> |
@@ -3016,6 +3106,24 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
3016 | </glossdef> | 3106 | </glossdef> |
3017 | </glossentry> | 3107 | </glossentry> |
3018 | 3108 | ||
3109 | <glossentry id='var-SOC_FAMILY'><glossterm>SOC_FAMILY</glossterm> | ||
3110 | <glossdef> | ||
3111 | <para> | ||
3112 | Groups together machines based upon the same family | ||
3113 | of SOC (System On Chip). | ||
3114 | You typically set this variable in a common | ||
3115 | <filename>.inc</filename> file that you include in the | ||
3116 | configuration files of all the machines. | ||
3117 | <note> | ||
3118 | You must include | ||
3119 | <filename>conf/machine/include/soc-family.inc</filename> | ||
3120 | for this variable to appear in | ||
3121 | <link linkend='var-MACHINEOVERRIDES'><filename>MACHINEOVERRIDES</filename></link>. | ||
3122 | </note> | ||
3123 | </para> | ||
3124 | </glossdef> | ||
3125 | </glossentry> | ||
3126 | |||
3019 | <glossentry id='var-SPECIAL_PKGSUFFIX'><glossterm>SPECIAL_PKGSUFFIX</glossterm> | 3127 | <glossentry id='var-SPECIAL_PKGSUFFIX'><glossterm>SPECIAL_PKGSUFFIX</glossterm> |
3020 | <glossdef> | 3128 | <glossdef> |
3021 | <para> | 3129 | <para> |