diff options
Diffstat (limited to 'documentation/ref-manual/variables.rst')
-rw-r--r-- | documentation/ref-manual/variables.rst | 59 |
1 files changed, 31 insertions, 28 deletions
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst index 5c75dac0fe..f8da00c7ce 100644 --- a/documentation/ref-manual/variables.rst +++ b/documentation/ref-manual/variables.rst | |||
@@ -773,7 +773,7 @@ system and gives an overview of their function and contents. | |||
773 | and `glob <https://docs.python.org/3/library/glob.html>`__. | 773 | and `glob <https://docs.python.org/3/library/glob.html>`__. |
774 | 774 | ||
775 | For more information on how this variable works, see | 775 | For more information on how this variable works, see |
776 | ``meta/classes/binconfig.bbclass`` in the :term:`Source Directory`. | 776 | ``meta/classes-recipe/binconfig.bbclass`` in the :term:`Source Directory`. |
777 | You can also find general | 777 | You can also find general |
778 | information on the class in the | 778 | information on the class in the |
779 | ":ref:`ref-classes-binconfig`" section. | 779 | ":ref:`ref-classes-binconfig`" section. |
@@ -2062,7 +2062,7 @@ system and gives an overview of their function and contents. | |||
2062 | available are xz and bz2. | 2062 | available are xz and bz2. |
2063 | 2063 | ||
2064 | For information on policies and on how to use this variable, see the | 2064 | For information on policies and on how to use this variable, see the |
2065 | comments in the ``meta/classes/compress_doc.bbclass`` file. | 2065 | comments in the ``meta/classes-recipe/compress_doc.bbclass`` file. |
2066 | 2066 | ||
2067 | :term:`EFI_PROVIDER` | 2067 | :term:`EFI_PROVIDER` |
2068 | When building bootable images (i.e. where ``hddimg``, ``iso``, or | 2068 | When building bootable images (i.e. where ``hddimg``, ``iso``, or |
@@ -2230,7 +2230,7 @@ system and gives an overview of their function and contents. | |||
2230 | variable tells the OpenEmbedded build system to prefer the installed | 2230 | variable tells the OpenEmbedded build system to prefer the installed |
2231 | external tools. See the | 2231 | external tools. See the |
2232 | :ref:`kernel-yocto <ref-classes-kernel-yocto>` class in | 2232 | :ref:`kernel-yocto <ref-classes-kernel-yocto>` class in |
2233 | ``meta/classes`` to see how the variable is used. | 2233 | ``meta/classes-recipe`` to see how the variable is used. |
2234 | 2234 | ||
2235 | :term:`EXTERNALSRC` | 2235 | :term:`EXTERNALSRC` |
2236 | When inheriting the :ref:`externalsrc <ref-classes-externalsrc>` | 2236 | When inheriting the :ref:`externalsrc <ref-classes-externalsrc>` |
@@ -2607,7 +2607,7 @@ system and gives an overview of their function and contents. | |||
2607 | :term:`SRC_URI` statements. | 2607 | :term:`SRC_URI` statements. |
2608 | 2608 | ||
2609 | The default value for the :term:`FILESPATH` variable is defined in the | 2609 | The default value for the :term:`FILESPATH` variable is defined in the |
2610 | :ref:`ref-classes-base` class found in ``meta/classes`` in the | 2610 | :ref:`ref-classes-base` class found in ``meta/classes-global`` in the |
2611 | :term:`Source Directory`:: | 2611 | :term:`Source Directory`:: |
2612 | 2612 | ||
2613 | FILESPATH = "${@base_set_filespath(["${FILE_DIRNAME}/${BP}", \ | 2613 | FILESPATH = "${@base_set_filespath(["${FILE_DIRNAME}/${BP}", \ |
@@ -3097,16 +3097,11 @@ system and gives an overview of their function and contents. | |||
3097 | ":term:`DISTRO` :term:`DISTRO_VERSION`". | 3097 | ":term:`DISTRO` :term:`DISTRO_VERSION`". |
3098 | 3098 | ||
3099 | :term:`IMAGE_CLASSES` | 3099 | :term:`IMAGE_CLASSES` |
3100 | A list of classes that all images should inherit. You typically use | 3100 | A list of classes that all images should inherit. This is typically used |
3101 | this variable to specify the list of classes that register the | 3101 | to enable functionality across all image recipes. |
3102 | different types of images the OpenEmbedded build system creates. | ||
3103 | 3102 | ||
3104 | The default value for :term:`IMAGE_CLASSES` is ``image_types``. You can | 3103 | Classes specified in :term:`IMAGE_CLASSES` must be located in the |
3105 | set this variable in your ``local.conf`` or in a distribution | 3104 | ``classes-recipe/`` or ``classes/`` subdirectories. |
3106 | configuration file. | ||
3107 | |||
3108 | For more information, see ``meta/classes/image_types.bbclass`` in the | ||
3109 | :term:`Source Directory`. | ||
3110 | 3105 | ||
3111 | :term:`IMAGE_CMD` | 3106 | :term:`IMAGE_CMD` |
3112 | Specifies the command to create the image file for a specific image | 3107 | Specifies the command to create the image file for a specific image |
@@ -3122,7 +3117,7 @@ system and gives an overview of their function and contents. | |||
3122 | You typically do not need to set this variable unless you are adding | 3117 | You typically do not need to set this variable unless you are adding |
3123 | support for a new image type. For more examples on how to set this | 3118 | support for a new image type. For more examples on how to set this |
3124 | variable, see the :ref:`image_types <ref-classes-image_types>` | 3119 | variable, see the :ref:`image_types <ref-classes-image_types>` |
3125 | class file, which is ``meta/classes/image_types.bbclass``. | 3120 | class file, which is ``meta/classes-recipe/image_types.bbclass``. |
3126 | 3121 | ||
3127 | :term:`IMAGE_DEVICE_TABLES` | 3122 | :term:`IMAGE_DEVICE_TABLES` |
3128 | Specifies one or more files that contain custom device tables that | 3123 | Specifies one or more files that contain custom device tables that |
@@ -3518,7 +3513,7 @@ system and gives an overview of their function and contents. | |||
3518 | - wic.lzma | 3513 | - wic.lzma |
3519 | 3514 | ||
3520 | For more information about these types of images, see | 3515 | For more information about these types of images, see |
3521 | ``meta/classes/image_types*.bbclass`` in the :term:`Source Directory`. | 3516 | ``meta/classes-recipe/image_types*.bbclass`` in the :term:`Source Directory`. |
3522 | 3517 | ||
3523 | :term:`IMAGE_VERSION_SUFFIX` | 3518 | :term:`IMAGE_VERSION_SUFFIX` |
3524 | Version suffix that is part of the default :term:`IMAGE_NAME` and | 3519 | Version suffix that is part of the default :term:`IMAGE_NAME` and |
@@ -3617,6 +3612,8 @@ system and gives an overview of their function and contents. | |||
3617 | functions in the class or classes are not executed for the base | 3612 | functions in the class or classes are not executed for the base |
3618 | configuration and in each individual recipe. The OpenEmbedded build | 3613 | configuration and in each individual recipe. The OpenEmbedded build |
3619 | system ignores changes to :term:`INHERIT` in individual recipes. | 3614 | system ignores changes to :term:`INHERIT` in individual recipes. |
3615 | Classes inherited using :term:`INHERIT` must be located in the | ||
3616 | ``classes-global/`` or ``classes/`` subdirectories. | ||
3620 | 3617 | ||
3621 | For more information on :term:`INHERIT`, see the | 3618 | For more information on :term:`INHERIT`, see the |
3622 | :ref:`bitbake:bitbake-user-manual/bitbake-user-manual-metadata:\`\`inherit\`\` configuration directive`" | 3619 | :ref:`bitbake:bitbake-user-manual/bitbake-user-manual-metadata:\`\`inherit\`\` configuration directive`" |
@@ -3626,6 +3623,9 @@ system and gives an overview of their function and contents. | |||
3626 | Lists classes that will be inherited at the distribution level. It is | 3623 | Lists classes that will be inherited at the distribution level. It is |
3627 | unlikely that you want to edit this variable. | 3624 | unlikely that you want to edit this variable. |
3628 | 3625 | ||
3626 | Classes specified in :term:`INHERIT_DISTRO` must be located in the | ||
3627 | ``classes-global/`` or ``classes/`` subdirectories. | ||
3628 | |||
3629 | The default value of the variable is set as follows in the | 3629 | The default value of the variable is set as follows in the |
3630 | ``meta/conf/distro/defaultsetup.conf`` file:: | 3630 | ``meta/conf/distro/defaultsetup.conf`` file:: |
3631 | 3631 | ||
@@ -3841,7 +3841,7 @@ system and gives an overview of their function and contents. | |||
3841 | 3841 | ||
3842 | :term:`INITRAMFS_LINK_NAME` | 3842 | :term:`INITRAMFS_LINK_NAME` |
3843 | The link name of the initial RAM filesystem image. This variable is | 3843 | The link name of the initial RAM filesystem image. This variable is |
3844 | set in the ``meta/classes/kernel-artifact-names.bbclass`` file as | 3844 | set in the ``meta/classes-recipe/kernel-artifact-names.bbclass`` file as |
3845 | follows:: | 3845 | follows:: |
3846 | 3846 | ||
3847 | INITRAMFS_LINK_NAME ?= "initramfs-${KERNEL_ARTIFACT_LINK_NAME}" | 3847 | INITRAMFS_LINK_NAME ?= "initramfs-${KERNEL_ARTIFACT_LINK_NAME}" |
@@ -3867,7 +3867,7 @@ system and gives an overview of their function and contents. | |||
3867 | 3867 | ||
3868 | :term:`INITRAMFS_NAME` | 3868 | :term:`INITRAMFS_NAME` |
3869 | The base name of the initial RAM filesystem image. This variable is | 3869 | The base name of the initial RAM filesystem image. This variable is |
3870 | set in the ``meta/classes/kernel-artifact-names.bbclass`` file as | 3870 | set in the ``meta/classes-recipe/kernel-artifact-names.bbclass`` file as |
3871 | follows:: | 3871 | follows:: |
3872 | 3872 | ||
3873 | INITRAMFS_NAME ?= "initramfs-${KERNEL_ARTIFACT_NAME}" | 3873 | INITRAMFS_NAME ?= "initramfs-${KERNEL_ARTIFACT_NAME}" |
@@ -4077,7 +4077,7 @@ system and gives an overview of their function and contents. | |||
4077 | variable. | 4077 | variable. |
4078 | 4078 | ||
4079 | The value of :term:`KERNEL_ARTIFACT_NAME`, which is set in the | 4079 | The value of :term:`KERNEL_ARTIFACT_NAME`, which is set in the |
4080 | ``meta/classes/kernel-artifact-names.bbclass`` file, has the | 4080 | ``meta/classes-recipe/kernel-artifact-names.bbclass`` file, has the |
4081 | following default value:: | 4081 | following default value:: |
4082 | 4082 | ||
4083 | KERNEL_ARTIFACT_NAME ?= "${PKGE}-${PKGV}-${PKGR}-${MACHINE}${IMAGE_VERSION_SUFFIX}" | 4083 | KERNEL_ARTIFACT_NAME ?= "${PKGE}-${PKGV}-${PKGR}-${MACHINE}${IMAGE_VERSION_SUFFIX}" |
@@ -4090,7 +4090,7 @@ system and gives an overview of their function and contents. | |||
4090 | :ref:`kernel <ref-classes-kernel>` class should inherit. You | 4090 | :ref:`kernel <ref-classes-kernel>` class should inherit. You |
4091 | typically append this variable to enable extended image types. An | 4091 | typically append this variable to enable extended image types. An |
4092 | example is the "kernel-fitimage", which enables fitImage support and | 4092 | example is the "kernel-fitimage", which enables fitImage support and |
4093 | resides in ``meta/classes/kernel-fitimage.bbclass``. You can register | 4093 | resides in ``meta/classes-recipe/kernel-fitimage.bbclass``. You can register |
4094 | custom kernel image types with the :ref:`kernel <ref-classes-kernel>` class using this | 4094 | custom kernel image types with the :ref:`kernel <ref-classes-kernel>` class using this |
4095 | variable. | 4095 | variable. |
4096 | 4096 | ||
@@ -4120,7 +4120,7 @@ system and gives an overview of their function and contents. | |||
4120 | 4120 | ||
4121 | :term:`KERNEL_DTB_LINK_NAME` | 4121 | :term:`KERNEL_DTB_LINK_NAME` |
4122 | The link name of the kernel device tree binary (DTB). This variable | 4122 | The link name of the kernel device tree binary (DTB). This variable |
4123 | is set in the ``meta/classes/kernel-artifact-names.bbclass`` file as | 4123 | is set in the ``meta/classes-recipe/kernel-artifact-names.bbclass`` file as |
4124 | follows:: | 4124 | follows:: |
4125 | 4125 | ||
4126 | KERNEL_DTB_LINK_NAME ?= "${KERNEL_ARTIFACT_LINK_NAME}" | 4126 | KERNEL_DTB_LINK_NAME ?= "${KERNEL_ARTIFACT_LINK_NAME}" |
@@ -4136,7 +4136,7 @@ system and gives an overview of their function and contents. | |||
4136 | 4136 | ||
4137 | :term:`KERNEL_DTB_NAME` | 4137 | :term:`KERNEL_DTB_NAME` |
4138 | The base name of the kernel device tree binary (DTB). This variable | 4138 | The base name of the kernel device tree binary (DTB). This variable |
4139 | is set in the ``meta/classes/kernel-artifact-names.bbclass`` file as | 4139 | is set in the ``meta/classes-recipe/kernel-artifact-names.bbclass`` file as |
4140 | follows:: | 4140 | follows:: |
4141 | 4141 | ||
4142 | KERNEL_DTB_NAME ?= "${KERNEL_ARTIFACT_NAME}" | 4142 | KERNEL_DTB_NAME ?= "${KERNEL_ARTIFACT_NAME}" |
@@ -4187,7 +4187,7 @@ system and gives an overview of their function and contents. | |||
4187 | 4187 | ||
4188 | :term:`KERNEL_FIT_LINK_NAME` | 4188 | :term:`KERNEL_FIT_LINK_NAME` |
4189 | The link name of the kernel flattened image tree (FIT) image. This | 4189 | The link name of the kernel flattened image tree (FIT) image. This |
4190 | variable is set in the ``meta/classes/kernel-artifact-names.bbclass`` | 4190 | variable is set in the ``meta/classes-recipe/kernel-artifact-names.bbclass`` |
4191 | file as follows:: | 4191 | file as follows:: |
4192 | 4192 | ||
4193 | KERNEL_FIT_LINK_NAME ?= "${KERNEL_ARTIFACT_LINK_NAME}" | 4193 | KERNEL_FIT_LINK_NAME ?= "${KERNEL_ARTIFACT_LINK_NAME}" |
@@ -4203,7 +4203,7 @@ system and gives an overview of their function and contents. | |||
4203 | 4203 | ||
4204 | :term:`KERNEL_FIT_NAME` | 4204 | :term:`KERNEL_FIT_NAME` |
4205 | The base name of the kernel flattened image tree (FIT) image. This | 4205 | The base name of the kernel flattened image tree (FIT) image. This |
4206 | variable is set in the ``meta/classes/kernel-artifact-names.bbclass`` | 4206 | variable is set in the ``meta/classes-recipe/kernel-artifact-names.bbclass`` |
4207 | file as follows:: | 4207 | file as follows:: |
4208 | 4208 | ||
4209 | KERNEL_FIT_NAME ?= "${KERNEL_ARTIFACT_NAME}" | 4209 | KERNEL_FIT_NAME ?= "${KERNEL_ARTIFACT_NAME}" |
@@ -4215,7 +4215,7 @@ system and gives an overview of their function and contents. | |||
4215 | 4215 | ||
4216 | :term:`KERNEL_IMAGE_LINK_NAME` | 4216 | :term:`KERNEL_IMAGE_LINK_NAME` |
4217 | The link name for the kernel image. This variable is set in the | 4217 | The link name for the kernel image. This variable is set in the |
4218 | ``meta/classes/kernel-artifact-names.bbclass`` file as follows:: | 4218 | ``meta/classes-recipe/kernel-artifact-names.bbclass`` file as follows:: |
4219 | 4219 | ||
4220 | KERNEL_IMAGE_LINK_NAME ?= "${KERNEL_ARTIFACT_LINK_NAME}" | 4220 | KERNEL_IMAGE_LINK_NAME ?= "${KERNEL_ARTIFACT_LINK_NAME}" |
4221 | 4221 | ||
@@ -4243,7 +4243,7 @@ system and gives an overview of their function and contents. | |||
4243 | 4243 | ||
4244 | :term:`KERNEL_IMAGE_NAME` | 4244 | :term:`KERNEL_IMAGE_NAME` |
4245 | The base name of the kernel image. This variable is set in the | 4245 | The base name of the kernel image. This variable is set in the |
4246 | ``meta/classes/kernel-artifact-names.bbclass`` file as follows:: | 4246 | ``meta/classes-recipe/kernel-artifact-names.bbclass`` file as follows:: |
4247 | 4247 | ||
4248 | KERNEL_IMAGE_NAME ?= "${KERNEL_ARTIFACT_NAME}" | 4248 | KERNEL_IMAGE_NAME ?= "${KERNEL_ARTIFACT_NAME}" |
4249 | 4249 | ||
@@ -4978,7 +4978,7 @@ system and gives an overview of their function and contents. | |||
4978 | 4978 | ||
4979 | :term:`MODULE_TARBALL_LINK_NAME` | 4979 | :term:`MODULE_TARBALL_LINK_NAME` |
4980 | The link name of the kernel module tarball. This variable is set in | 4980 | The link name of the kernel module tarball. This variable is set in |
4981 | the ``meta/classes/kernel-artifact-names.bbclass`` file as follows:: | 4981 | the ``meta/classes-recipe/kernel-artifact-names.bbclass`` file as follows:: |
4982 | 4982 | ||
4983 | MODULE_TARBALL_LINK_NAME ?= "${KERNEL_ARTIFACT_LINK_NAME}" | 4983 | MODULE_TARBALL_LINK_NAME ?= "${KERNEL_ARTIFACT_LINK_NAME}" |
4984 | 4984 | ||
@@ -4992,7 +4992,7 @@ system and gives an overview of their function and contents. | |||
4992 | 4992 | ||
4993 | :term:`MODULE_TARBALL_NAME` | 4993 | :term:`MODULE_TARBALL_NAME` |
4994 | The base name of the kernel module tarball. This variable is set in | 4994 | The base name of the kernel module tarball. This variable is set in |
4995 | the ``meta/classes/kernel-artifact-names.bbclass`` file as follows:: | 4995 | the ``meta/classes-recipe/kernel-artifact-names.bbclass`` file as follows:: |
4996 | 4996 | ||
4997 | MODULE_TARBALL_NAME ?= "${KERNEL_ARTIFACT_NAME}" | 4997 | MODULE_TARBALL_NAME ?= "${KERNEL_ARTIFACT_NAME}" |
4998 | 4998 | ||
@@ -5127,7 +5127,7 @@ system and gives an overview of their function and contents. | |||
5127 | ``sysroots/`` directory so that all builds that use the script will | 5127 | ``sysroots/`` directory so that all builds that use the script will |
5128 | use the correct directories for the cross compiling layout. | 5128 | use the correct directories for the cross compiling layout. |
5129 | 5129 | ||
5130 | See the ``meta/classes/binconfig.bbclass`` in the | 5130 | See the ``meta/classes-recipe/binconfig.bbclass`` in the |
5131 | :term:`Source Directory` for details on how this class | 5131 | :term:`Source Directory` for details on how this class |
5132 | applies these additional sed command arguments. | 5132 | applies these additional sed command arguments. |
5133 | 5133 | ||
@@ -8783,6 +8783,9 @@ system and gives an overview of their function and contents. | |||
8783 | A list of classes to globally inherit. These classes are used by the | 8783 | A list of classes to globally inherit. These classes are used by the |
8784 | OpenEmbedded build system to enable extra features. | 8784 | OpenEmbedded build system to enable extra features. |
8785 | 8785 | ||
8786 | Classes inherited using :term:`USER_CLASSES` must be located in the | ||
8787 | ``classes-global/`` or ``classes/`` subdirectories. | ||
8788 | |||
8786 | The default list is set in your ``local.conf`` file:: | 8789 | The default list is set in your ``local.conf`` file:: |
8787 | 8790 | ||
8788 | USER_CLASSES ?= "buildstats" | 8791 | USER_CLASSES ?= "buildstats" |