summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual/variables.rst
diff options
context:
space:
mode:
Diffstat (limited to 'documentation/ref-manual/variables.rst')
-rw-r--r--documentation/ref-manual/variables.rst124
1 files changed, 119 insertions, 5 deletions
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index 1b655e4a3a..340058f39f 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -1806,7 +1806,7 @@ system and gives an overview of their function and contents.
1806 ``${TMPDIR}/deploy``. 1806 ``${TMPDIR}/deploy``.
1807 1807
1808 For more information on the structure of the Build Directory, see 1808 For more information on the structure of the Build Directory, see
1809 ":ref:`ref-manual/structure:the build directory --- \`\`build/\`\``" section. 1809 ":ref:`ref-manual/structure:the build directory --- ``build/```" section.
1810 For more detail on the contents of the ``deploy`` directory, see the 1810 For more detail on the contents of the ``deploy`` directory, see the
1811 ":ref:`overview-manual/concepts:images`", 1811 ":ref:`overview-manual/concepts:images`",
1812 ":ref:`overview-manual/concepts:package feeds`", and 1812 ":ref:`overview-manual/concepts:package feeds`", and
@@ -1850,7 +1850,7 @@ system and gives an overview of their function and contents.
1850 <ref-classes-image>` class. 1850 <ref-classes-image>` class.
1851 1851
1852 For more information on the structure of the Build Directory, see 1852 For more information on the structure of the Build Directory, see
1853 ":ref:`ref-manual/structure:the build directory --- \`\`build/\`\``" section. 1853 ":ref:`ref-manual/structure:the build directory --- ``build/```" section.
1854 For more detail on the contents of the ``deploy`` directory, see the 1854 For more detail on the contents of the ``deploy`` directory, see the
1855 ":ref:`overview-manual/concepts:images`" and 1855 ":ref:`overview-manual/concepts:images`" and
1856 ":ref:`overview-manual/concepts:application development sdk`" sections both in 1856 ":ref:`overview-manual/concepts:application development sdk`" sections both in
@@ -3617,6 +3617,36 @@ system and gives an overview of their function and contents.
3617 3617
3618 IMAGE_ROOTFS_EXTRA_SPACE = "41943040" 3618 IMAGE_ROOTFS_EXTRA_SPACE = "41943040"
3619 3619
3620 :term:`IMAGE_ROOTFS_MAXSIZE`
3621 Defines the maximum allowed size of the generated image in kilobytes.
3622 The build will fail if the generated image size exceeds this value.
3623
3624 The generated image size undergoes several calculation steps before being
3625 compared to :term:`IMAGE_ROOTFS_MAXSIZE`.
3626 In the first step, the size of the directory pointed to by :term:`IMAGE_ROOTFS`
3627 is calculated.
3628 In the second step, the result from the first step is multiplied
3629 by :term:`IMAGE_OVERHEAD_FACTOR`.
3630 In the third step, the result from the second step is compared with
3631 :term:`IMAGE_ROOTFS_SIZE`. The larger value of these is added to
3632 :term:`IMAGE_ROOTFS_EXTRA_SPACE`.
3633 In the fourth step, the result from the third step is checked for
3634 a decimal part. If it has one, it is rounded up to the next integer.
3635 If it does not, it is simply converted into an integer.
3636 In the fifth step, the :term:`IMAGE_ROOTFS_ALIGNMENT` is added to the result
3637 from the fourth step and "1" is subtracted.
3638 In the sixth step, the remainder of the division between the result
3639 from the fifth step and :term:`IMAGE_ROOTFS_ALIGNMENT` is subtracted from the
3640 result of the fifth step. In this way, the result from the fourth step is
3641 rounded up to the nearest multiple of :term:`IMAGE_ROOTFS_ALIGNMENT`.
3642
3643 Thus, if the :term:`IMAGE_ROOTFS_MAXSIZE` is set, is compared with the result
3644 of the above calculations and is independent of the final image type.
3645 No default value is set for :term:`IMAGE_ROOTFS_MAXSIZE`.
3646
3647 It's a good idea to set this variable for images that need to fit on a limited
3648 space (e.g. SD card, a fixed-size partition, ...).
3649
3620 :term:`IMAGE_ROOTFS_SIZE` 3650 :term:`IMAGE_ROOTFS_SIZE`
3621 Defines the size in Kbytes for the generated image. The OpenEmbedded 3651 Defines the size in Kbytes for the generated image. The OpenEmbedded
3622 build system determines the final size for the generated image using 3652 build system determines the final size for the generated image using
@@ -3822,6 +3852,23 @@ system and gives an overview of their function and contents.
3822 Set the variable to "1" to prevent the default dependencies from 3852 Set the variable to "1" to prevent the default dependencies from
3823 being added. 3853 being added.
3824 3854
3855 :term:`INHIBIT_DEFAULT_RUST_DEPS`
3856 Prevents the :ref:`ref-classes-rust` class from automatically adding
3857 its default build-time dependencies.
3858
3859 When a recipe inherits the :ref:`ref-classes-rust` class, several
3860 tools such as ``rust-native`` and ``${RUSTLIB_DEP}`` (only added when cross-compiling) are added
3861 to :term:`DEPENDS` to support the ``rust`` build process.
3862
3863 To prevent the build system from adding these dependencies automatically,
3864 set the :term:`INHIBIT_DEFAULT_RUST_DEPS` variable as follows::
3865
3866 INHIBIT_DEFAULT_RUST_DEPS = "1"
3867
3868 By default, the value of :term:`INHIBIT_DEFAULT_RUST_DEPS` is empty. Setting
3869 it to "0" does not disable inhibition. Only the empty string will disable
3870 inhibition.
3871
3825 :term:`INHIBIT_PACKAGE_DEBUG_SPLIT` 3872 :term:`INHIBIT_PACKAGE_DEBUG_SPLIT`
3826 Prevents the OpenEmbedded build system from splitting out debug 3873 Prevents the OpenEmbedded build system from splitting out debug
3827 information during packaging. By default, the build system splits out 3874 information during packaging. By default, the build system splits out
@@ -3869,6 +3916,25 @@ system and gives an overview of their function and contents.
3869 even if the toolchain's binaries are strippable, there are other files 3916 even if the toolchain's binaries are strippable, there are other files
3870 needed for the build that are not strippable. 3917 needed for the build that are not strippable.
3871 3918
3919 :term:`INHIBIT_UPDATERCD_BBCLASS`
3920 Prevents the :ref:`ref-classes-update-rc.d` class from automatically
3921 installing and registering SysV init scripts for packages.
3922
3923 When a recipe inherits the :ref:`ref-classes-update-rc.d` class, init
3924 scripts are typically installed and registered for the packages listed in
3925 :term:`INITSCRIPT_PACKAGES`. This ensures that the relevant
3926 services are started and stopped at the appropriate runlevels using the
3927 traditional SysV init system.
3928
3929 To prevent the build system from adding these scripts and configurations
3930 automatically, set the :term:`INHIBIT_UPDATERCD_BBCLASS` variable as follows::
3931
3932 INHIBIT_UPDATERCD_BBCLASS = "1"
3933
3934 By default, the value of :term:`INHIBIT_UPDATERCD_BBCLASS` is empty. Setting
3935 it to "0" does not disable inhibition. Only the empty string will disable
3936 inhibition.
3937
3872 :term:`INIT_MANAGER` 3938 :term:`INIT_MANAGER`
3873 Specifies the system init manager to use. Available options are: 3939 Specifies the system init manager to use. Available options are:
3874 3940
@@ -4010,6 +4076,20 @@ system and gives an overview of their function and contents.
4010 See the :term:`MACHINE` variable for additional 4076 See the :term:`MACHINE` variable for additional
4011 information. 4077 information.
4012 4078
4079 :term:`INITRAMFS_MAXSIZE`
4080 Defines the maximum allowed size of the :term:`Initramfs` image in Kbytes.
4081 The build will fail if the :term:`Initramfs` image size exceeds this value.
4082
4083 The :term:`Initramfs` image size undergoes several calculation steps before
4084 being compared to :term:`INITRAMFS_MAXSIZE`.
4085 These steps are the same as those used for :term:`IMAGE_ROOTFS_MAXSIZE`
4086 and are described in detail in that entry.
4087
4088 Thus, :term:`INITRAMFS_MAXSIZE` is compared with the result of the calculations
4089 and is independent of the final image type (e.g. compressed).
4090 A default value for :term:`INITRAMFS_MAXSIZE` is set in
4091 :oe_git:`meta/conf/bitbake.conf </openembedded-core/tree/meta/conf/bitbake.conf>`.
4092
4013 :term:`INITRAMFS_MULTICONFIG` 4093 :term:`INITRAMFS_MULTICONFIG`
4014 Defines the multiconfig to create a multiconfig dependency to be used by the :ref:`kernel <ref-classes-kernel>` class. 4094 Defines the multiconfig to create a multiconfig dependency to be used by the :ref:`kernel <ref-classes-kernel>` class.
4015 4095
@@ -6099,7 +6179,7 @@ system and gives an overview of their function and contents.
6099 For examples of how this data is used, see the 6179 For examples of how this data is used, see the
6100 ":ref:`overview-manual/concepts:automatically added runtime dependencies`" 6180 ":ref:`overview-manual/concepts:automatically added runtime dependencies`"
6101 section in the Yocto Project Overview and Concepts Manual and the 6181 section in the Yocto Project Overview and Concepts Manual and the
6102 ":ref:`dev-manual/debugging:viewing package information with \`\`oe-pkgdata-util\`\``" 6182 ":ref:`dev-manual/debugging:viewing package information with ``oe-pkgdata-util```"
6103 section in the Yocto Project Development Tasks Manual. For more 6183 section in the Yocto Project Development Tasks Manual. For more
6104 information on the shared, global-state directory, see 6184 information on the shared, global-state directory, see
6105 :term:`STAGING_DIR_HOST`. 6185 :term:`STAGING_DIR_HOST`.
@@ -7717,7 +7797,7 @@ system and gives an overview of their function and contents.
7717 class. 7797 class.
7718 7798
7719 :term:`SPL_SIGN_KEYNAME` 7799 :term:`SPL_SIGN_KEYNAME`
7720 The name of keys used by the :ref:`ref-classes-kernel-fitimage` class 7800 The name of keys used by the :ref:`ref-classes-uboot-sign` class
7721 for signing U-Boot FIT image stored in the :term:`SPL_SIGN_KEYDIR` 7801 for signing U-Boot FIT image stored in the :term:`SPL_SIGN_KEYDIR`
7722 directory. If we have for example a ``dev.key`` key and a ``dev.crt`` 7802 directory. If we have for example a ``dev.key`` key and a ``dev.crt``
7723 certificate stored in the :term:`SPL_SIGN_KEYDIR` directory, you will 7803 certificate stored in the :term:`SPL_SIGN_KEYDIR` directory, you will
@@ -8004,6 +8084,26 @@ system and gives an overview of their function and contents.
8004 For details on the process, see the 8084 For details on the process, see the
8005 :ref:`staging <ref-classes-staging>` class. 8085 :ref:`staging <ref-classes-staging>` class.
8006 8086
8087 :term:`SSTATE_SKIP_CREATION`
8088 The :term:`SSTATE_SKIP_CREATION` variable can be used to skip the
8089 creation of :ref:`shared state <overview-manual/concepts:shared state cache>`
8090 tarball files. It makes sense e.g. for image creation tasks as tarring images
8091 and keeping them in sstate would consume a lot of disk space.
8092
8093 In general it is not recommended to use this variable as missing sstate
8094 artefacts adversely impact the build, particularly for entries in the
8095 middle of dependency chains. The case it can make sense is where the
8096 size and time costs of the artefact are similar to just running the
8097 tasks. This generally only applies to end artefact output like images.
8098
8099 The syntax to disable it for one task is::
8100
8101 SSTATE_SKIP_CREATION:task-image-complete = "1"
8102
8103 The syntax to disable it for the whole recipe is::
8104
8105 SSTATE_SKIP_CREATION = "1"
8106
8007 :term:`STAGING_BASE_LIBDIR_NATIVE` 8107 :term:`STAGING_BASE_LIBDIR_NATIVE`
8008 Specifies the path to the ``/lib`` subdirectory of the sysroot 8108 Specifies the path to the ``/lib`` subdirectory of the sysroot
8009 directory for the build host. 8109 directory for the build host.
@@ -8909,7 +9009,7 @@ system and gives an overview of their function and contents.
8909 :doc:`/sdk-manual/index` manual. 9009 :doc:`/sdk-manual/index` manual.
8910 9010
8911 Note that this variable applies to building an SDK, not an eSDK, 9011 Note that this variable applies to building an SDK, not an eSDK,
8912 in which case the term:`TOOLCHAIN_HOST_TASK_ESDK` setting should be 9012 in which case the :term:`TOOLCHAIN_HOST_TASK_ESDK` setting should be
8913 used instead. 9013 used instead.
8914 9014
8915 :term:`TOOLCHAIN_HOST_TASK_ESDK` 9015 :term:`TOOLCHAIN_HOST_TASK_ESDK`
@@ -9579,6 +9679,20 @@ system and gives an overview of their function and contents.
9579 can control with this variable, see the 9679 can control with this variable, see the
9580 ":ref:`ref-classes-insane`" section. 9680 ":ref:`ref-classes-insane`" section.
9581 9681
9682 :term:`WIC_CREATE_EXTRA_ARGS`
9683 If the :term:`IMAGE_FSTYPES` variable contains "wic", the build
9684 will generate a
9685 :ref:`Wic image <dev-manual/wic:creating partitioned images using wic>`
9686 automatically when BitBake builds an image recipe. As part of
9687 this process BitBake will invoke the "`wic create`" command. The
9688 :term:`WIC_CREATE_EXTRA_ARGS` variable is placed at the end of this
9689 command which allows the user to supply additional arguments.
9690
9691 One such useful purpose for this mechanism is to add the ``-D`` (or
9692 ``--debug``) argument to the "`wic create`" command. This increases the
9693 amount of debugging information written out to the Wic log during the
9694 Wic creation process.
9695
9582 :term:`WKS_FILE` 9696 :term:`WKS_FILE`
9583 Specifies the location of the Wic kickstart file that is used by the 9697 Specifies the location of the Wic kickstart file that is used by the
9584 OpenEmbedded build system to create a partitioned image 9698 OpenEmbedded build system to create a partitioned image