Lines Matching full:variable
53 To use the variable, list out the package's commands that are also
67 use the :term:`ALTERNATIVE_LINK_NAME` variable to specify the actual
85 duplicated commands. You can use the variable to create a single
101 duplicated commands. You can use the variable to create a single
114 from the :term:`ALTERNATIVE_LINK_NAME` variable.
131 class, this variable identifies a list of distribution features where
145 information on how this variable is used.
153 You can use this variable to create archives of patched source,
155 following variable flags (varflags)::
166 For information on how the variable works, see the
211 When :term:`SRCREV` is set to the value of this variable, it specifies to
231 must set this variable in your recipe. The
232 :ref:`syslinux <ref-classes-syslinux>` class checks this variable.
254 This variable can be defined to be used by the fetcher to authenticate
272 by the :term:`B` variable. Most Autotools-based recipes support
279 :term:`RRECOMMENDS` variable. You can prevent any
281 with the :term:`BAD_RECOMMENDATIONS` variable::
285 You can set this variable globally in your ``local.conf`` file or you
292 using this variable and some other packages are dependent on them
294 variable), the OpenEmbedded build system ignores your request and
297 This variable is supported only when using the IPK and RPM
311 The :term:`BASE_LIB` variable is defined in the machine include files in
322 considerations surrounding this variable:
370 You can change the default behavior by setting this variable to "1",
381 add the :term:`BB_DISKMON_DIRS` variable to your ``conf/local.conf`` file
401 variable, which must be defined in
429 variable in the ``conf/local.conf``. This example causes the build
433 variable, the build system also issue a warning when the disk space
437 variable.
450 intervals, define the variable in your ``conf/local.conf`` file in
453 If you are going to use the :term:`BB_DISKMON_WARNINTERVAL` variable, you
455 variable and define its action as "WARN". During the build,
459 If you do not provide a :term:`BB_DISKMON_WARNINTERVAL` variable and you
465 When specifying the variable in your configuration file, use the
509 Set this variable in your
519 variable to be equal to the number of cores on the build system. For
521 hyper-threading causes the :term:`BB_NUMBER_THREADS` variable to default
525 override this variable to gain optimal parallelism during builds.
527 CPUs, you might want to make sure the :term:`BB_NUMBER_THREADS` variable
566 variants by rewriting variable values and applying overrides such
580 its name to this variable in its ``conf/layer.conf`` file.
583 Variable that expands to match files from
584 :term:`BBFILES` in a particular layer. This variable
591 This variable is useful in situations where the same recipe appears
592 in more than one layer. Setting this variable allows you to
595 layers. The precedence established through this variable stands
596 regardless of a recipe's version (:term:`PV` variable). For
601 A larger value for the :term:`BBFILE_PRIORITY` variable results in a
603 than the value 5. If not specified, the :term:`BBFILE_PRIORITY` variable
604 is set based on layer dependencies (see the :term:`LAYERDEPENDS` variable
627 Use the :term:`BBFILES_DYNAMIC` variable to avoid ``.bbappend`` files
653 Variable that controls how BitBake displays logs on build failure.
662 Lists the layers to enable during the build. This variable is defined
679 You can use the :term:`BBMASK` variable to "hide" these ``.bb`` and
714 building targets with multiple configurations. Use this variable in
733 variable is analogous to the ``PATH`` variable.
739 to point to the Build Directory. Set the variable as you would any
740 environment variable and then run BitBake::
751 Use the following format to export the variable to the BitBake
763 this variable specifies binary configuration scripts to disable in
776 this variable specifies a wildcard for configuration scripts that
784 The :term:`BINCONFIG_GLOB` variable uses
791 For more information on how this variable works, see
805 This variable is a version of the :term:`PN` variable with
815 The OpenEmbedded build system does not use this variable. Rather, the
816 variable is a useful pointer in case a bug in the software being
842 :term:`CFLAGS` is set to the value of this variable by
849 is set to the value of this variable by default.
854 :term:`CXXFLAGS` is set to the value of this variable
876 :term:`LDFLAGS` is set to the value of this variable
885 The default value of the :term:`BUILD_OPTIMIZATION` variable is "-O2
911 The OpenEmbedded build system automatically sets this variable based
915 :term:`BUILD_SYS` variable yourself.
931 class, this variable specifies whether or not to commit the build
946 class, this variable specifies the author to use for each Git commit.
947 In order for the :term:`BUILDHISTORY_COMMIT_AUTHOR` variable to work, the
948 :term:`BUILDHISTORY_COMMIT` variable must
952 :term:`BUILDHISTORY_COMMIT_AUTHOR` variable takes the form of "name
956 …By default, the :ref:`buildhistory <ref-classes-buildhistory>` class sets the variable as follows::
962 class, this variable specifies the directory in which build history
963 information is kept. For more information on how the variable works,
972 class, this variable specifies the build history features to be
1000 class, this variable specifies a list of paths to files copied from
1016 class, this variable specifies a common path prefix that should be
1022 …By default, the :ref:`buildhistory <ref-classes-buildhistory>` class sets the variable as follows::
1030 class, this variable optionally specifies a remote repository to
1041 …By default, the :ref:`buildhistory <ref-classes-buildhistory>` class sets the variable as follows::
1048 :term:`CFLAGS` is set to the value of this variable by
1055 to the value of this variable by default.
1060 :term:`CXXFLAGS` is set to the value of this variable
1066 :term:`LDFLAGS` is set to the value of this variable
1082 The :term:`BUSYBOX_SPLIT_SUID` variable defaults to "1", which results in
1083 splitting the output executable file. Set the variable to "0" to get
1095 Specifies the flags to pass to the C compiler. This variable is
1096 exported to an environment variable and thus made visible to the
1112 An internal variable specifying the special class override that
1114 forth). The classes that use this variable (e.g.
1117 variable to appropriate values.
1169 variable to stop recipes from being built for classes of systems with
1171 particularly useful with kernels. The variable also helps to increase
1179 the variable to stop recipes from being built for machines with which
1181 useful with kernels. The variable also helps to increase parsing
1192 The :term:`COMPLEMENTARY_GLOB` variable uses Unix filename pattern matching
1204 To add a new feature item pointing to a wildcard, use a variable flag
1233 variable to list the files in the package that you wish to prevent
1236 To use the :term:`CONFFILES` variable, provide a package name override
1249 variable.
1253 When specifying paths as part of the :term:`CONFFILES` variable, it is
1263 variable as an environment variable. By default, the variable is set
1283 the current build. This variable is used by the Autotools utilities
1292 class, this variable identifies distribution features that would be
1294 :term:`CONFLICT_DISTRO_FEATURES` variable lists a feature that also
1301 :term:`COPY_LIC_MANIFEST` variable, the
1312 :term:`LICENSE_CREATE_PACKAGE` variable for additional information.
1328 :term:`LICENSE_CREATE_PACKAGE` variable for additional information.
1343 The :term:`COPYLEFT_LICENSE_EXCLUDE` variable takes precedence over the
1344 :term:`COPYLEFT_LICENSE_INCLUDE` variable.
1366 :term:`COPYLEFT_PN_EXCLUDE` variable overrides the license inclusion and
1380 :term:`COPYLEFT_PN_INCLUDE` variable overrides the license inclusion and
1403 only set this variable in the ``local.conf`` configuration file found
1406 This variable replaces ``POKY_EXTRA_INSTALL``, which is no longer
1423 ``bblayers.conf`` file. The :term:`COREBASE_FILES` variable allows
1438 C and the C++ compilers). This variable is exported to an environment
1439 variable and thus made visible to the software being built during the
1456 :term:`CROSS_COMPILE` variable is the same as the
1457 :term:`TARGET_PREFIX` variable.
1462 variable only in certain contexts (e.g. when building for kernel
1518 used in the CVE database, then this variable can be used to set the
1531 Specifies the flags to pass to the C++ compiler. This variable is
1532 exported to an environment variable and thus made visible to the
1573 set this variable. Here is an example from the ``fontconfig`` recipe::
1582 override when you set this variable. Here is an example from the
1589 influences the value of the :term:`SELECTED_OPTIMIZATION` variable.
1593 compiling a system for debugging. This variable defaults to "-O
1610 This variable is set in the ``meta/conf/bitbake.conf`` file. It is
1616 The most common usage of this is variable is to set it to "-1" within
1618 variable in this way causes the stable version of the recipe to build
1625 by :term:`BBFILE_PRIORITY` if that variable is different between two
1657 …``[``\ :ref:`deptask <bitbake:bitbake-user-manual/bitbake-user-manual-metadata:variable flags>`\ `…
1675 the :term:`EXTRANATIVEPATH` variable.
1705 :term:`RDEPENDS` variable. You can also see the
1729 system. This variable applies only when
1734 :term:`DEPLOY_DIR_DEB` variable as a sub-folder of
1740 :term:`DEPLOY_DIR_DEB` variable to make sure the
1772 This variable applies only when
1776 The BitBake configuration file initially defines this variable as a
1782 :term:`DEPLOY_DIR_IPK` variable to make sure the
1792 This variable applies only when
1796 The BitBake configuration file initially defines this variable as a
1802 :term:`DEPLOY_DIR_RPM` variable to make sure the
1812 variable applies only when
1816 The BitBake configuration file initially defines this variable as a
1822 :term:`DEPLOY_DIR_TAR` variable to make sure the
1844 variable.
1849 variable.
1851 The :term:`DISTRO` variable corresponds to a distribution configuration
1852 file whose root name is the same as the variable's argument and whose
1858 Within that ``poky.conf`` file, the :term:`DISTRO` variable is set as
1870 If the :term:`DISTRO` variable is blank, a set of default configurations
1879 This variable takes effect through ``packagegroup-base`` so the
1880 variable only really applies to the more full-featured images that
1881 include ``packagegroup-base``. You can use this variable to keep
1883 variables, you set this variable in the distro ``.conf`` file.
1907 provide with this variable, see the ":ref:`ref-features-distro`" section.
1913 This variable is set in the ``meta/conf/bitbake.conf`` file. It is
1915 the variable to see which distro features are being backfilled for
1925 A convenience variable that gives you the default list of distro
1941 variable is used in addition to the features filtered using the
1943 variable.
1949 variable is used in addition to the features filtered using the
1951 variable.
1956 recipes. This variable is used in addition to the features filtered
1959 variable.
1964 nativesdk recipes. This variable is used in addition to the features
1967 variable.
1971 of the distribution, see the :term:`DISTRO` variable.
1973 The :term:`DISTRO_NAME` variable corresponds to a distribution
1974 configuration file whose root name is the same as the variable's
1980 Within that ``poky.conf`` file, the :term:`DISTRO_NAME` variable is set
1991 If the :term:`DISTRO_NAME` variable is blank, a set of default
2016 variable.
2018 You can set this directory by defining the :term:`DL_DIR` variable in the
2050 class, this variable sets the compression policy used when the
2055 For information on policies and on how to use this variable, see the
2061 :term:`EFI_PROVIDER` variable specifies the EFI bootloader to use. The
2069 Variable that controls which locales for ``glibc`` are generated
2079 database. By default, the value of this variable is
2090 errors by the OpenEmbedded build system. You set this variable in
2092 can control with this variable, see the
2104 context. You can use this variable to disable those classes.
2119 :term:`ESDK_LOCALCONF_REMOVE` variable as well as
2169 The :term:`EXCLUDE_FROM_SHLIBS` variable is similar to the
2170 :term:`PRIVATE_LIBS` variable, which excludes a
2173 Use the :term:`EXCLUDE_FROM_SHLIBS` variable by setting it to "1" for a
2184 To exclude a recipe from a world build using this variable, set the
2185 variable to "1" in the recipe.
2202 See the :term:`STAMP` variable for an example.
2206 packages produced by a recipe. The variable's value is normally used
2216 When set, the :term:`EXTERNAL_KERNEL_TOOLS` variable indicates that these
2221 variable tells the OpenEmbedded build system to prefer the installed
2224 ``meta/classes`` to see how the variable is used.
2228 class, this variable points to the source tree, which is outside of
2229 the OpenEmbedded build system. When set, this variable sets the
2230 :term:`S` variable, which is what the OpenEmbedded build
2234 can also find information on how to use this variable in the
2240 class, this variable points to the directory in which the recipe's
2242 system. When set, this variable sets the :term:`B` variable,
2247 can also find information on how to use this variable in the
2263 Typically, you configure this variable in your ``local.conf`` file,
2265 Although you can use this variable from within a recipe, best
2271 :term:`IMAGE_FEATURES` variable.
2299 …variable, see the ":ref:`dev-manual/common-tasks:customizing images using custom \`\`image_feature…
2305 this variable, use an override for the associated image type. Here is
2316 variable to list these recipes and thus specify the dependencies. A
2337 variable to specify any required GNU options.
2345 variable specifies additional configuration options you want to pass
2350 class, this variable provides image level user and group operations.
2377 The resulting hash is set to a variable and used in ``useradd`` command parameters::
2414 added to the beginning of the environment variable ``PATH``. As an
2436 confuse the :term:`FEATURE_PACKAGES` variable with package groups, which
2443 this variable in your ``local.conf`` file.
2458 :term:`PACKAGES` variable lists the packages
2461 To use the :term:`FILES` variable, provide a package name override that
2476 - When specifying paths as part of the :term:`FILES` variable, it is
2485 If some of the files you provide with the :term:`FILES` variable are
2489 the :term:`CONFFILES` variable for information on
2508 variable. You can extend :term:`FILESPATH` variable by using
2540 :term:`FILESPATH` variable to include a directory named ``files`` that is
2572 :term:`FILESPATH`. The :term:`FILESOVERRIDES` variable
2574 :term:`FILESPATH` variable. For an example of how
2575 that works, see the :term:`FILESPATH` variable
2581 By default, the :term:`FILESOVERRIDES` variable is defined as::
2587 Do not hand-edit the :term:`FILESOVERRIDES` variable. The values match up
2600 The default value for the :term:`FILESPATH` variable is defined in the
2608 :term:`FILESPATH` variable is automatically extended using the overrides
2609 from the :term:`FILESOVERRIDES` variable.
2613 - Do not hand-edit the :term:`FILESPATH` variable. If you want the
2615 extend the :term:`FILESPATH` variable by using the
2616 :term:`FILESEXTRAPATHS` variable.
2622 to extend the :term:`FILESPATH` variable by using the
2623 :term:`FILESEXTRAPATHS` variable.
2661 You define the :term:`FILESYSTEM_PERMS_TABLES` variable in the
2666 within the :term:`BBPATH` variable.
2689 If you set this variable to anything other than "none" you may also need
2727 this variable specifies the runtime dependencies for font packages.
2732 this variable identifies packages containing font files that need to
2735 ``${``\ :term:`PN`\ ``}``). Use this variable if fonts you
2742 Set the variable to "1" to force the removal of these packages.
2746 compiling an optimized system. This variable defaults to "-O2 -pipe
2755 variable as follows::
2800 this variable specifies for a package what parameters should be
2813 this variable specifies for a package what parameters should be
2822 and serial in the boot menu. Set this variable to "1" in your
2827 information on how this variable is used.
2834 The :term:`GRUB_OPTS` variable is optional. See the
2836 on how this variable is used.
2842 The :term:`GRUB_TIMEOUT` variable is optional. See the
2844 on how this variable is used.
2849 this variable specifies the packages that contain the GTK+ input
2890 the same as the :term:`TARGET_OS`. The variable can
2904 The OpenEmbedded build system automatically sets this variable based
2911 You do not need to set the variable yourself.
2947 compile support to consider. This variable is used by the
2948 :ref:`icecc <ref-classes-icecc>` class. You set this variable in
2951 When you list classes using this variable, the recipes inheriting
2958 variable, see the ":ref:`ref-classes-icecc`"
2961 Setting this variable to "1" in your ``local.conf`` disables the
2966 To enable the function, set the variable as follows::
2972 variable is used by the :ref:`icecc <ref-classes-icecc>` class. You
2973 set this variable in your ``local.conf`` file.
2983 compilation. This variable usually takes the form of "-j x", where x
2996 :term:`PARALLEL_MAKE` variable, there is no
3005 The location of the ``icecc`` binary. You can set this variable in
3007 this variable, the :ref:`icecc <ref-classes-icecc>` class attempts
3012 compile support to consider. This variable is used by the
3013 :ref:`icecc <ref-classes-icecc>` class. You set this variable in
3016 When you list recipes using this variable, you are excluding them
3022 :term:`PARALLEL_MAKE` variable that you want to
3024 distributed compile support. This variable is used by the
3025 :ref:`icecc <ref-classes-icecc>` class. You set this variable in
3029 The base name of image output files. This variable defaults to the
3068 this variable to specify the list of classes that register the
3072 set this variable in your ``local.conf`` or in a distribution
3082 ``btrfs``, and so forth). When setting this variable, you should use
3089 You typically do not need to set this variable unless you are adding
3091 variable, see the :ref:`image_types <ref-classes-image_types>`
3140 configure this variable in an image recipe. Although you can use this
3141 variable from your ``local.conf`` file, which is found in the
3148 :term:`EXTRA_IMAGE_FEATURES` variable.
3154 …variable, see the ":ref:`dev-manual/common-tasks:customizing images using custom \`\`image_feature…
3175 variable, you cannot update its contents by using ``:append``
3177 more options to the :term:`IMAGE_FSTYPES` variable.
3182 :term:`IMAGE_INSTALL` variable with care to avoid ordering issues.
3192 When you use this variable, it is best to use it as follows::
3204 image, do not use the :term:`IMAGE_INSTALL` variable to specify
3206 :term:`PACKAGE_INSTALL` variable, which
3232 into separate packages. Setting the :term:`IMAGE_LINGUAS` variable
3247 variable for information on generating GLIBC locales.
3278 The name of the output image files minus the extension. This variable
3289 clear the value of this variable (set the value to ""). For example,
3299 multiplier of 1.3 for this variable. This default value results in
3318 variable.
3322 OpenEmbedded build system. The variable is defined appropriately by
3338 variable is set indirectly through the appropriate
3340 :term:`PACKAGE_CLASSES` variable. The
3342 or IPK) that appears with the variable
3360 :term:`IMAGE_ROOTFS` variable for more
3373 :term:`IMAGE_ROOTFS` variable for more
3379 variable is not configurable. Do not change it.
3390 default, this variable is set to "0". This free disk space is added
3394 This variable is particularly useful when you want to ensure that a
3397 free disk space is available, set the variable as follows::
3436 In the previous example, the variable ensures that when "live" is
3437 listed with the :term:`IMAGE_FSTYPES` variable,
3512 ``include`` file. You can think of this variable as part of the
3525 :term:`INC_PR` variable inside the ``include`` files that the recipes
3526 share and then expand the :term:`INC_PR` variable within the recipes to
3530 :term:`INC_PR` variable given a common ``include`` file that defines the
3531 variable. Once the variable is defined in the ``include`` file, you
3532 can use the variable to set the :term:`PR` values in each recipe. You
3534 granular revisioning by appending values to the :term:`INC_PR` variable::
3554 There is some support for wildcards in this variable's value,
3586 unlikely that you want to edit this variable.
3588 The default value of the variable is set as follows in the
3596 This variable is usually used within recipes that do not require any
3599 Set the variable to "1" to prevent the default dependencies from
3609 variable.
3612 during packaging, set the :term:`INHIBIT_PACKAGE_DEBUG_SPLIT` variable as
3633 :term:`INHIBIT_SYSROOT_STRIP` variable to "1" in your recipe, you inhibit
3636 If you want to use this variable, include the
3638 ``sys_strip()`` function to test for the variable and acts
3643 Use of the :term:`INHIBIT_SYSROOT_STRIP` variable occurs in rare and
3652 This variable is set by default to ``${DEPLOY_DIR_IMAGE}`` in the
3660 :term:`IMAGE_FSTYPES` variable.
3662 The default value of this variable, which is set in the
3672 image. In other words, the :term:`INITRAMFS_IMAGE` variable causes an
3695 the :term:`INITRAMFS_IMAGE` variable.
3702 variable, which allows the generated image to be bundled inside the
3736 Setting the variable to "1" in a configuration file causes the
3743 :ref:`kernel <ref-classes-kernel>` class sets this variable to a
3750 You must set the :term:`INITRAMFS_IMAGE_BUNDLE` variable in a
3751 configuration file. You cannot set the variable in a recipe file.
3760 The link name of the initial RAM filesystem image. This variable is
3767 ``KERNEL_ARTIFACT_LINK_NAME`` variable, which is set in the same
3772 See the :term:`MACHINE` variable for additional
3786 The base name of the initial RAM filesystem image. This variable is
3793 variable, which is set in the same file, has the following value::
3801 The :term:`INITRD` variable is an optional variable used with the
3818 This variable is used in recipes when using :ref:`ref-classes-update-rc.d`.
3819 The variable is mandatory.
3826 This variable is used in recipes when using :ref:`ref-classes-update-rc.d`.
3827 The variable is optional and defaults to the :term:`PN`
3828 variable.
3838 The variable's default value is "defaults", which is set in the
3856 list of the valid QA checks you can specify using this variable.
3860 Set the :term:`INSTALL_TIMEZONE_FILE` variable to "0" at the
3865 the target, you can use this variable to set up ``opkg`` in the
3881 You define the :term:`KARCH` variable in the :ref:`kernel-dev/advanced:bsp descriptions`.
3886 build. You must set this variable to ensure the exact kernel branch
3889 Values for this variable are set in the kernel's recipe file and the
3897 This variable is also used from the kernel's append file to identify
3926 :term:`KBUILD_DEFCONFIG` variable and append the
3927 :term:`KMACHINE` variable to point to the
3930 To use the variable, set it in the append file for your kernel recipe
3945 information on how to use the :term:`KBUILD_DEFCONFIG` variable, see the
3969 :term:`KBUILD_DEFCONFIG` variable. :term:`KCONFIG_MODE` does not need to
3990 :term:`KERNEL_IMAGETYPE` variable.
3995 variable.
4009 typically append this variable to enable extended image types. An
4013 variable.
4029 In order to use this variable, the
4034 The link name of the kernel device tree binary (DTB). This variable
4041 value of the ``KERNEL_ARTIFACT_LINK_NAME`` variable, which is set in
4046 See the :term:`MACHINE` variable for additional
4050 The base name of the kernel device tree binary (DTB). This variable
4057 variable, which is set in the same file, has the following value::
4064 variable).
4066 In order to use this variable, the
4079 variables. You can use the :term:`KERNEL_FEATURES` variable from within
4083 The metadata you add through this variable includes config fragments
4086 variable for a specific machine. In this way, you can provide
4102 variable is set in the ``meta/classes/kernel-artifact-names.bbclass``
4108 ``KERNEL_ARTIFACT_LINK_NAME`` variable, which is set in the same
4113 See the :term:`MACHINE` variable for additional
4118 variable is set in the ``meta/classes/kernel-artifact-names.bbclass``
4124 variable, which is set in the same file, has the following value::
4129 The link name for the kernel image. This variable is set in the
4135 the ``KERNEL_ARTIFACT_LINK_NAME`` variable, which is set in the same
4140 See the :term:`MACHINE` variable for additional
4153 By default, this variable is not set, which means the size of the
4157 The base name of the kernel image. This variable is set in the
4163 :term:`KERNEL_ARTIFACT_NAME` variable,
4170 configuration files and defaults to "zImage". This variable is used
4176 variable.
4183 This variable replaces the deprecated :term:`module_autoload`
4184 variable.
4186 You can use the :term:`KERNEL_MODULE_AUTOLOAD` variable anywhere that it
4205 ``modprobe.d`` syntax lines, see the :term:`KERNEL_MODULE_PROBECONF` variable.
4212 :term:`module_conf_* <module_conf>` variable.
4215 The location of the kernel sources. This variable is set to the value
4218 how this variable is used, see the
4224 :term:`KERNEL_SRC` variable, which is identical to
4225 the :term:`KERNEL_PATH` variable. Both variables are common variables
4229 The location of the kernel sources. This variable is set to the value
4232 how this variable is used, see the
4238 :term:`KERNEL_PATH` variable, which is identical
4239 to the :term:`KERNEL_SRC` variable. Both variables are common variables
4245 this variable do not take effect until the kernel has been
4246 configured. Consequently, attempting to refer to this variable in
4254 use the data, set the :term:`KERNELDEPMODDEPEND` variable in your
4255 ``initramfs`` recipe. Setting the variable there when the data is not
4260 this variable in the ``.scc`` file that describes a configuration
4261 fragment file. Here is the variable used in a file named ``smp.scc``
4273 the :term:`KMACHINE` variable maps the kernel machine name to the
4301 You define the :term:`KTYPE` variable in the
4311 information on how this variable is used.
4325 numbers (if specified) do not match exactly. This variable is used in
4330 When used inside the ``layer.conf`` configuration file, this variable
4331 provides the path of the current layer. This variable is not
4348 This variable is used in the ``conf/layer.conf`` file and must be
4354 a layer is compatible. Using the :term:`LAYERSERIES_COMPAT` variable
4356 layer and OE-Core can be expected to work. The variable gives the
4361 this variable in your layer's ``conf/layer.conf`` configuration file.
4373 The OpenEmbedded build system produces a warning if the variable
4383 This variable is used in the ``conf/layer.conf`` file and must be
4391 Specifies the flags to pass to the linker. This variable is exported
4392 to an environment variable and thus made visible to the software
4412 This variable works in conjunction with the :ref:`debian <ref-classes-debian>` class.
4417 This variable tracks changes in license text of the source code
4422 This variable must be defined for all recipes (unless
4481 the :term:`LICENSE` variable of the recipe metadata
4487 :term:`COPY_LIC_DIRS` variable, the
4488 :term:`COPY_LIC_MANIFEST` variable, and the
4516 :term:`LICENSE_PATH` variable allows you to extend that location to other
4531 :term:`LINUX_KERNEL_TYPE` variable defines the search arguments used by
4539 this variable in the kernel recipe. For example, the
4545 The :term:`LINUX_VERSION` variable is used to define :term:`PV`
4553 variable in the kernel recipe. For example, the linux-yocto kernel
4554 recipes all define the variable as follows::
4558 Defining this variable essentially sets the Linux kernel
4571 :term:`T` variable.
4582 The variable corresponds to a machine configuration file of the same
4614 variable is set automatically from :term:`MACHINE` or
4616 the :term:`MACHINE_ARCH` variable.
4622 variable, the list of packages are essential for the machine to boot.
4623 The impact of this variable affects images based on
4627 This variable is similar to the
4628 :term:`MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS` variable with the exception
4629 that the image being built has a build dependency on the variable's
4644 "machine-essential" variable, the list of packages are essential for
4645 the machine to boot. The impact of this variable affects images based
4649 This variable is similar to the :term:`MACHINE_ESSENTIAL_EXTRA_RDEPENDS`
4650 variable with the exception that the image being built does not have
4651 a build dependency on the variable's list of packages. In other
4653 found. Typically, this variable is used to handle essential kernel
4663 kernel, you still want the build to succeed. This variable sets up a
4674 explicitly set its :term:`PACKAGES` variable to ensure that BitBake
4675 does not use the kernel recipe's :term:`PACKAGES_DYNAMIC` variable to
4687 This variable affects all images based on ``packagegroup-base``,
4691 The variable is similar to the :term:`MACHINE_EXTRA_RRECOMMENDS` variable
4693 on the variable's list of packages. In other words, the image will
4712 This variable affects only images based on ``packagegroup-base``,
4716 This variable is similar to the :term:`MACHINE_EXTRA_RDEPENDS` variable
4718 dependency on the variable's list of packages. In other words, the
4748 This variable is set in the ``meta/conf/bitbake.conf`` file. It is
4750 the variable to see which machine features are being backfilled for
4811 variable is used in places where the prefix needs to be added to or
4812 removed from a the name (e.g. the :term:`BPN` variable).
4839 This variable has been replaced by the :term:`KERNEL_MODULE_AUTOLOAD`
4840 variable. You should replace all occurrences of :term:`module_autoload`
4849 See the :term:`KERNEL_MODULE_AUTOLOAD` variable for more information.
4856 You can use this variable anywhere that it can be recognized by the
4859 for the recipe, or the recipe itself). If you use this variable, you
4862 variable.
4881 boot, see the :term:`KERNEL_MODULE_AUTOLOAD` variable.
4884 Controls creation of the ``modules-*.tgz`` file. Set this variable to
4889 The link name of the kernel module tarball. This variable is set in
4895 of the ``KERNEL_ARTIFACT_LINK_NAME`` variable, which is set in the
4900 See the :term:`MACHINE` variable for additional information.
4903 The base name of the kernel module tarball. This variable is set in
4908 The value of the :term:`KERNEL_ARTIFACT_NAME` variable,
4915 are being built. This variable allows output for different types of
4919 The default value of this variable is::
4927 See the :term:`STAMP` variable for an example. See the
4928 :term:`STAGING_DIR_TARGET` variable for more information.
4938 This variable is used by default to isolate native shared state
4940 ``glibc`` version incompatibilities). Additionally, the variable is
4943 variable is set.
4971 :term:`RRECOMMENDS` variable). Setting the
4972 :term:`NO_RECOMMENDATIONS` variable to "1" turns this feature on::
4976 You can set this variable globally in your ``local.conf`` file or you
4983 using this variable and some other packages are dependent on them
4985 variable), the OpenEmbedded build system ignores your request and
4992 packages with the :term:`IMAGE_INSTALL` variable.
4994 This variable is only supported when using the IPK and RPM
5027 this variable specifies additional arguments passed to the "sed"
5039 An internal variable used to tell the OpenEmbedded build system what
5044 Do not set this variable. It is for internal use only.
5052 :term:`OE_INIT_ENV_SCRIPT` variable to its name.
5061 You can use the following values for the :term:`OE_TERMINAL` variable:
5075 script, the :term:`OEROOT` variable resolves to the directory that
5078 For additional information on how this variable is used, see the
5083 binaries must support. This variable is passed into the build of the
5086 The default for this variable comes from the
5088 default by setting the variable in a custom distribution
5125 ":ref:`dev-manual/common-tasks:viewing variable values`" section in the Yocto
5134 This variable defines additional metadata to add to packages.
5137 This variable allows you to do that by setting the injected data as
5141 The suffixes '_IPK', '_DEB', or '_RPM' can be applied to the variable
5145 You can find out more about applying this variable in the
5152 By default, the value of this variable is set to
5171 This variable is set automatically and should not normally be
5182 This variable, which is set in the ``local.conf`` configuration file
5188 variable: PACKAGE_CLASSES ?= "package_rpm package_deb package_ipk
5215 Debugger (GDB). In general, based on the value of this variable,
5221 The possible values of :term:`PACKAGE_DEBUG_SPLIT_STYLE` variable:
5241 independently. This is the default setting for this variable,
5250 use of the :term:`INHIBIT_PACKAGE_DEBUG_SPLIT` variable.
5262 You can set this variable globally in your ``local.conf`` file or you
5268 If you choose to not install a package using this variable and some
5270 :term:`RDEPENDS` variable), the OpenEmbedded build
5272 halts the process with a fatal error, you can use the variable with
5276 This variable is supported only when using the IPK and RPM
5292 use the :term:`PACKAGE_EXCLUDE_COMPLEMENTARY` variable to specify regular
5297 This variable is useful when you build for several different devices
5303 :term:`PACKAGE_FEED_ARCHS` variable is appended to the final package feed
5312 variable to allow specific package architectures. If you do
5314 case, you can omit this variable. Omitting the variable results in
5342 :term:`PACKAGE_FEED_BASE_PATHS` variable makes up the middle portion of a
5405 variable is internal to the image construction code. Consequently, in
5407 :term:`IMAGE_INSTALL` variable to specify
5411 use the :term:`PACKAGE_INSTALL` variable. For information on creating an
5418 install, the build system does not generate an error. This variable
5439 This variable provides a means of enabling or disabling features of a
5456 The :term:`PACKAGECONFIG` variable itself specifies a space-separated
5509 variable::
5513 Or, you can just append the variable::
5520 described, you can either completely override the variable::
5524 Or, you can just amend the variable::
5555 variable corresponding to each package to assign files to the
5556 package. If a file matches the :term:`FILES` variable for more than one
5560 Packages in the variable's list that are empty (i.e. where none of
5564 :term:`ALLOW_EMPTY` variable.
5573 variable, but a package with the module name is never actually
5584 For an example of how to use the :term:`PACKAGES_DYNAMIC` variable when
5592 variable or prepend to the ``populate_packages`` function in order to
5602 parallel compilation on the local build host. This variable is
5613 variable to be equal to the number of cores the build system uses.
5619 the :term:`PARALLEL_MAKE` variable within the recipe as a workaround. For
5625 override this variable to gain optimal parallelism during builds.
5627 CPUs, you might want to make sure the :term:`PARALLEL_MAKE` variable is
5637 parallel installation. This variable defaults to the value of
5649 clear the :term:`PARALLEL_MAKEINST` variable within the recipe as a
5656 variable to one of two values: "noop" and "user".
5664 Set this variable in your ``local.conf`` file.
5674 If you wish to use an alternative patching tool, set the variable in
5682 The epoch of the recipe. By default, this variable is unset. The
5683 variable is used to make upgrades possible when the versioning scheme
5686 :term:`PE` is the default value of the :term:`PKGE` variable.
5702 ``bash-4.2-r1/``). This variable is comprised of the following:
5707 class, this variable identifies packages that contain the pixbuf
5710 ``${``\ :term:`PN`\ ``}``). Use this variable if the
5719 When using the :term:`PKG` variable, you must use a package name override.
5727 ``pkg-config`` reads this variable from the environment.
5793 This variable can have two separate functions depending on the
5802 The variable refers to a package name in the context of a file
5805 If applicable, the :term:`PN` variable also contains any special suffix
5821 :term:`SDK_DIR` variable for more information.
5833 :term:`SDK_DIR` variable for more information.
5836 The revision of the recipe. The default value for this variable is
5850 The :term:`PR` variable primarily becomes significant when a package
5871 If multiple recipes provide the same item, this variable determines
5873 preferred provider). You should always suffix this variable with the
5874 name of the provided item. And, you should define the variable using
5881 The :term:`PREFERRED_PROVIDER` variable is set with the name (:term:`PN`) of
5902 If there are multiple versions of a recipe available, this variable
5904 suffix the variable with the :term:`PN` you want to select (`python` in
5908 The :term:`PREFERRED_VERSION` variable supports limited wildcard use
5940 Sometimes the :term:`PREFERRED_VERSION` variable can be set by
6005 variable is typically used when software being built by a recipe has
6012 Libraries specified in this variable should be specified by their
6062 The :term:`PREFERRED_PROVIDER` variable is
6069 special functionality beyond ordinary variable assignments. For
6084 :term:`PRSERV_HOST` variable is set::
6089 set the variable if you want to automatically start a local :ref:`PR
6106 this variable directly. Enabling and disabling building Package Tests
6118 :term:`PV` is the default value of the :term:`PKGV` variable.
6132 default, the ABI is "m". You do not have to set this variable as the
6143 be "python3". You do not have to set this variable as the
6146 The variable allows recipes to use common infrastructure such as the
6192 :term:`RCONFLICTS` variable::
6247 variable. For an example of the default list of packages created from
6248 a recipe, see the :term:`PACKAGES` variable.
6250 Because the :term:`RDEPENDS` variable applies to packages being built,
6251 you should always use the variable in a form with an attached package
6261 :term:`RDEPENDS` variable has the ``${PN}-dev`` package name as part of
6262 the variable.
6273 in the :term:`PACKAGES` variable. The :term:`PKG` variable
6284 :term:`RDEPENDS` variable::
6309 :term:`DEPENDS` variable. You can also see the
6317 putting the reason why in this variable in a recipe allows
6325 class, this variable identifies distribution features that must exist
6328 :term:`REQUIRED_DISTRO_FEATURES` variable lists a feature that does not
6334 If there are multiple versions of a recipe available, this variable
6345 With ``rm_work`` enabled, this variable specifies a list of recipes
6362 You can override the default by setting the variable in any layer or
6377 The :term:`ROOTFS` variable is an optional variable used with the
6390 :term:`IMAGE_ROOTFS` variable for more
6403 :term:`IMAGE_ROOTFS` variable for more
6418 :term:`IMAGE_ROOTFS` variable for more
6431 :term:`IMAGE_ROOTFS` variable for more
6445 variable in conjunction with a package name override. Here is an
6455 the :term:`RDEPENDS` variable.
6468 :term:`RPROVIDES` variable, or an error will occur
6472 Because the :term:`RRECOMMENDS` variable applies to packages being built,
6473 you should always attach an override to the variable to specify the
6490 :term:`RRECOMMENDS` variable::
6509 this variable to determine which package should be installed to
6512 the other package to the :term:`RCONFLICTS` variable.
6514 As with all package-controlling variables, you must use this variable
6523 :term:`RREPLACES` variable::
6546 variable in conjunction with a package name override. Here is an
6599 set this variable. Instead, use :term:`SDKMACHINE`.
6618 the variable as follows::
6635 If you set the variable to "minimal", you need to ensure
6665 variable significantly increases build time because all of world
6666 needs to be built. Enabling the variable also slightly increases
6678 The :term:`SDK_INCLUDE_TOOLCHAIN` variable defaults to "0" if
6698 class defines the variable as follows::
6712 This variable is set automatically and should not normally be
6725 :term:`SDK_DIR` variable for more information.
6743 :term:`SDK_RECRDEP_TASKS` variable, the above four tasks are always added
6745 :term:`SDK_RECRDEP_TASKS` variable (e.g. you are defining additional
6753 The OpenEmbedded build system automatically sets this variable based
6757 variable yourself.
6780 The :term:`SDK_TARGETS` variable is an internal variable and typically
6786 :term:`DISTRO` variable and is set in the
6822 variable and is set in the
6837 Equivalent to :term:`IMAGE_FEATURES`. However, this variable applies to
6850 The variable defaults to :term:`BUILD_ARCH` so that SDKs are built for the
6856 variable in your distribution configuration file. If you do, the
6873 management utilities can make use of this variable.
6878 value of the :term:`TARGET_CFLAGS` variable.
6880 The :term:`SELECTED_OPTIMIZATION` variable takes the value of
6894 The :term:`SERIAL_CONSOLE` variable is deprecated. Please use the
6895 :term:`SERIAL_CONSOLES` variable.
6908 ``/proc/console`` before enabling them using getty. This variable
6915 This variable is currently only supported with SysVinit (i.e. not
6924 :ref:`setuptools3 <ref-classes-setuptools3>` class, this variable can
6930 :ref:`setuptools3 <ref-classes-setuptools3>` class, this variable can
6936 :ref:`setuptools3 <ref-classes-setuptools3>` class, this variable should
6965 Use of this variable is one mechanism to remove dependencies that
6977 tasks run to build the recipe. Use of this variable is one way to
6983 If you add an inappropriate variable to this list, the software
7000 To enable file removal, set the variable to "1" in your
7009 recipe. Specify the :term:`PN` value as a variable flag (``varflag``)
7014 variable in your ``local.conf`` file or distribution configuration.
7021 Chip). You typically set this variable in a common ``.inc`` file that
7027 variable to appear in :term:`MACHINEOVERRIDES`.
7034 You will see this variable referenced in the default values of
7043 You will see this variable referenced in the default values of
7050 Many upstream projects already support this variable.
7071 variable and :term:`COMPATIBLE_HOST` variables
7078 variable unless you are creating a source mirror. In other words,
7079 do not set the variable during a normal build.
7086 To use this variable, you must globally inherit the
7185 variable.
7191 as the generation of the :term:`BPN` variable.
7212 The :term:`SPL_BINARY` variable helps form
7222 See the BitBake manual for the initial description for this variable:
7264 sure to extend the :term:`FILESPATH` variable by also using the
7265 :term:`FILESEXTRAPATHS` variable from within your append file.
7271 variable to "0" disables this behavior.
7274 The date of the source code used to build the package. This variable
7282 The :term:`SRCPV` variable is defined in the ``meta/conf/bitbake.conf``
7297 variable applies to Subversion, Git, Mercurial, and Bazaar only. Note
7306 of software using :term:`SRCREV`, see the :term:`AUTOREV` variable
7339 This variable allows to specify indirect dependencies to exclude
7368 "1". Using the :term:`SSTATE_MIRROR_ALLOW_NETWORK` variable is useful if
7376 data. This variable works like fetcher :term:`MIRRORS`
7408 hardcoded installation paths. The variable uses a space-separated
7416 by the :term:`SSTATE_SCAN_FILES` variable. Typically, recipes add files
7418 than the variable being comprehensively set. The
7475 :term:`SYSROOT_DIRS` variable.
7540 system. The :term:`STAGING_DIR_HOST` variable points to the sysroot used
7566 the :term:`STAGING_KERNEL_BUILDDIR` variable to find these artifacts
7599 :term:`PV`, and :term:`PR` for related variable
7614 :term:`DESCRIPTION` variable if :term:`DESCRIPTION` is
7623 console other than the default, set this variable in your recipe as
7629 this variable to null but then checks for a value later.
7633 this variable in your recipe. If you want to list multiple options,
7636 The :ref:`syslinux <ref-classes-syslinux>` class uses this variable
7641 serial, set this variable to an empty string in your recipe. The
7642 variable's default value is set in the
7647 The class checks for and uses the variable as needed.
7651 variable's default value is set in the
7656 The class checks for and uses the variable as needed.
7660 you use the boot menu. You need to set this variable in your recipe.
7663 variable and if found, the OpenEmbedded build system installs the
7689 can use this variable to exclude certain subdirectories of
7739 this variable specifies whether the specified service in
7747 You can disable the service by setting the variable to "disable".
7751 "systemd-boot", the :term:`SYSTEMD_BOOT_CFG` variable specifies the
7763 "systemd-boot", the :term:`SYSTEMD_BOOT_ENTRIES` variable specifies a
7776 "systemd-boot", the :term:`SYSTEMD_BOOT_TIMEOUT` variable specifies the
7788 this variable locates the systemd unit files when they are not found
7790 variable is set such that the systemd unit files are assumed to
7801 this variable specifies the systemd service name for a package.
7821 This variable points to a directory were BitBake places temporary
7823 particular recipe. The variable is typically set as follows::
7829 file sets this variable.
7831 The :term:`T` variable is not to be confused with the
7832 :term:`TMPDIR` variable, which points to the root of
7851 :term:`TUNE_ARCH` variable.
7870 would not otherwise respect the exported :term:`LDFLAGS` variable.
7877 variable allows the kernel (and associated modules) to use a
7885 :term:`CFLAGS` is set to the value of this variable by
7889 variable in the environment to the :term:`TARGET_CFLAGS` value so that
7896 value of this variable by default.
7899 :term:`CPPFLAGS` variable in the environment to the :term:`TARGET_CPPFLAGS`
7906 :term:`CXXFLAGS` is set to the value of this variable
7910 :term:`CXXFLAGS` variable in the environment to the :term:`TARGET_CXXFLAGS`
7916 which include most ARM CPUs, the variable must be set to "soft". If
7931 :term:`LDFLAGS` is set to the value of this variable
7935 :term:`LDFLAGS` variable in the environment to the
7940 Specifies the target's operating system. The variable can be set to
7954 - For native recipes, the build system sets the variable to the
7958 variable to the value of :term:`SDK_PREFIX`.
7965 The OpenEmbedded build system automatically sets this variable based
7972 You do not need to set the :term:`TARGET_SYS` variable yourself.
8010 variable's default value is "default", which uses that internal
8025 The :term:`TCMODE` variable is similar to :term:`TCLIBC`,
8038 the ``meta`` layer and then set the ``EXTERNAL_TOOLCHAIN`` variable
8048 the :term:`TEST_EXPORT_ONLY` variable is set
8051 The :term:`TEST_EXPORT_DIR` variable defaults to
8055 Specifies to export the tests only. Set this variable to "1" if you
8061 :term:`TEST_LOG_DIR` variable defaults to ``"${WORKDIR}/testimage"``.
8104 ``/dev/ttyUSB0`` at 115200bps, you would set the variable as follows::
8119 variable needs to be set to the IP address of the build machine (i.e.
8124 The :term:`TEST_SERVER_IP` variable is only used for a small number of
8206 variable has no effect when :term:`TEST_TARGET` is
8224 Using the variable also adds in dependencies so that any SDK for
8229 over ``ssh``. You can set this variable to "1" in your ``local.conf``
8244 located. Do not manually set this variable.
8252 This variable is the base directory the OpenEmbedded build system
8254 shared state cache). By default, the :term:`TMPDIR` variable points to
8273 This variable lists packages the OpenEmbedded build system uses when
8275 packages specified by this variable are part of the toolchain set
8283 set in this variable, but you can add additional packages to the
8296 Note that this variable applies to building an SDK, not an eSDK,
8301 This variable allows to extend what is installed in the host
8306 This variable defines the name used for the toolchain output. The
8308 the :term:`TOOLCHAIN_OUTPUTNAME` variable as follows::
8318 This variable lists packages the OpenEmbedded build system uses when
8321 variable to add individual packages to the part of the SDK that runs
8336 variable is used where the architecture is needed in a value where
8341 Do not edit this variable.
8418 See the :term:`DEFAULTTUNE` variable for more information.
8498 image creation, the :term:`UBOOT_DTB_LOADADDRESS` variable is used in
8505 image creation, the :term:`UBOOT_DTBO_LOADADDRESS` variable is used in
8511 creation, the :term:`UBOOT_ENTRYPOINT` variable is passed as a
8516 creation, the :term:`UBOOT_LOADADDRESS` variable is passed as a
8530 configuration. You typically set this variable from the machine
8534 section in the U-Boot README for valid values for this variable.
8567 :term:`UBOOT_RD_ENTRYPOINT` variable is used
8575 :term:`UBOOT_RD_LOADADDRESS` variable is used
8602 not specifically set this variable, the OpenEmbedded build process
8630 you rarely need to set this variable in individual recipes.
8651 You can use the :term:`UPSTREAM_CHECK_GITTAGREGEX` variable to provide a
8659 Use the :term:`UPSTREAM_CHECK_REGEX` variable to specify a different
8699 use this variable.
8736 :term:`USERADD_ERROR_DYNAMIC` variable is by default not set. If you plan
8738 set the :term:`USERADD_ERROR_DYNAMIC` variable in your ``local.conf``
8769 variable as follows in your ``local.conf`` file::
8776 Setting the :term:`USERADDEXTENSION` variable to "useradd-staticids"
8781 this variable specifies the individual packages within the recipe
8784 You must set this variable if the recipe inherits the class. For
8793 variable, you need to set one or more of the :term:`USERADD_PARAM`,
8798 this variable specifies for a package what parameters should pass to
8820 variable as follows in your ``local.conf`` file::
8826 Setting the :term:`USERADDEXTENSION` variable to "useradd-staticids"
8835 (``gid``) values, set the variable as follows in your ``local.conf``
8840 Setting this variable to use static ``uid`` and ``gid``
8849 :term:`USERADD_ERROR_DYNAMIC` variable.
8857 variable to "no" to make the log directory persistent.
8861 warnings by the OpenEmbedded build system. You set this variable in
8863 can control with this variable, see the
8876 When placed in the recipe that builds your image, this variable lists
8877 build-time dependencies. The :term:`WKS_FILE_DEPENDS` variable is only
8880 to Wic). If your recipe does not create Wic images, the variable has
8883 The :term:`WKS_FILE_DEPENDS` variable is similar to the
8884 :term:`DEPENDS` variable. When you use the variable in
8886 :term:`WKS_FILE_DEPENDS` variable are added to the :term:`DEPENDS` variable.
8888 With the :term:`WKS_FILE_DEPENDS` variable, you have the possibility to