diff options
| -rw-r--r-- | documentation/ref-manual/ref-variables.xml | 294 |
1 files changed, 257 insertions, 37 deletions
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml index 9b86eb85cd..48783e7021 100644 --- a/documentation/ref-manual/ref-variables.xml +++ b/documentation/ref-manual/ref-variables.xml @@ -7024,6 +7024,70 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossdef> </glossentry> + <glossentry id='var-INITRAMFS_LINK_NAME'><glossterm>INITRAMFS_LINK_NAME</glossterm> + <info> + INITRAMFS_LINK_NAME[doc] = "The link name of the initial RAM filesystem image." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + The link name of the initial RAM filesystem image. + This variable is set in the + <filename>meta/classes/kernel-artifact-names.bbclass</filename> + file as follows: + <literallayout class='monospaced'> + INITRAMFS_LINK_NAME ?= "initramfs-${KERNEL_ARTIFACT_LINK_NAME}" + </literallayout> + The value of the <filename>KERNEL_ARTIFACT_LINK_NAME</filename> + variable, which is set in the same file, has the following + value: + <literallayout class='monospaced'> + KERNEL_ARTIFACT_LINK_NAME ?= "${MACHINE}" + </literallayout> + </para> + + <para> + See the + <link linkend='var-MACHINE'><filename>MACHINE</filename></link> + variable for additional information. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-INITRAMFS_NAME'><glossterm>INITRAMFS_NAME</glossterm> + <info> + INITRAMFS_NAME[doc] = "The base name of the initial RAM filesystem image." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + The base name of the initial RAM filesystem image. + This variable is set in the + <filename>meta/classes/kernel-artifact-names.bbclass</filename> + file as follows: + <literallayout class='monospaced'> + INITRAMFS_NAME ?= "initramfs-${KERNEL_ARTIFACT_NAME}" + </literallayout> + The value of the <filename>KERNEL_ARTIFACT_NAME</filename> + variable, which is set in the same file, has the following + value: + <literallayout class='monospaced'> + KERNEL_ARTIFACT_NAME ?= "${PKGE}-${PKGV}-${PKGR}-${MACHINE}${IMAGE_VERSION_SUFFIX}" + </literallayout> + </para> + + <para> + See the + <link linkend='var-PKGE'><filename>PKGE</filename></link>, + <link linkend='var-PKGV'><filename>PKGV</filename></link>, + <link linkend='var-PKGR'><filename>PKGR</filename></link>, + and + <link linkend='var-MACHINE'><filename>MACHINE</filename></link> + variables for additional information. + </para> + </glossdef> + </glossentry> + <glossentry id='var-INITRD'><glossterm>INITRD</glossterm> <info> INITRD[doc] = "Indicates a list of filesystem images to concatenate and use as an initial RAM disk (initrd)." @@ -7449,6 +7513,70 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossdef> </glossentry> + <glossentry id='var-KERNEL_DTB_LINK_NAME'><glossterm>KERNEL_DTB_LINK_NAME</glossterm> + <info> + KERNEL_DTB_LINK_NAME[doc] = "The link name of the kernel device tree binary (DTB)." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + The link name of the kernel device tree binary (DTB). + This variable is set in the + <filename>meta/classes/kernel-artifact-names.bbclass</filename> + file as follows: + <literallayout class='monospaced'> + KERNEL_DTB_LINK_NAME ?= "${KERNEL_ARTIFACT_LINK_NAME}" + </literallayout> + The value of the <filename>KERNEL_ARTIFACT_LINK_NAME</filename> + variable, which is set in the same file, has the following + value: + <literallayout class='monospaced'> + KERNEL_ARTIFACT_LINK_NAME ?= "${MACHINE}" + </literallayout> + </para> + + <para> + See the + <link linkend='var-MACHINE'><filename>MACHINE</filename></link> + variable for additional information. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-KERNEL_DTB_NAME'><glossterm>KERNEL_DTB_NAME</glossterm> + <info> + KERNEL_DTB_NAME[doc] = "The base name of the kernel device tree binary (DTB)." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + The base name of the kernel device tree binary (DTB). + This variable is set in the + <filename>meta/classes/kernel-artifact-names.bbclass</filename> + file as follows: + <literallayout class='monospaced'> + KERNEL_DTB_NAME ?= "${KERNEL_ARTIFACT_NAME}" + </literallayout> + The value of the <filename>KERNEL_ARTIFACT_NAME</filename> + variable, which is set in the same file, has the following + value: + <literallayout class='monospaced'> + KERNEL_ARTIFACT_NAME ?= "${PKGE}-${PKGV}-${PKGR}-${MACHINE}${IMAGE_VERSION_SUFFIX}" + </literallayout> + </para> + + <para> + See the + <link linkend='var-PKGE'><filename>PKGE</filename></link>, + <link linkend='var-PKGV'><filename>PKGV</filename></link>, + <link linkend='var-PKGR'><filename>PKGR</filename></link>, + and + <link linkend='var-MACHINE'><filename>MACHINE</filename></link> + variables for additional information. + </para> + </glossdef> + </glossentry> + <glossentry id='var-KERNEL_EXTRA_ARGS'><glossterm>KERNEL_EXTRA_ARGS</glossterm> <info> KERNEL_EXTRA_ARGS[doc] = "Specifies additional make command-line arguments the OpenEmbedded build system passes on when compiling the kernel." @@ -7513,27 +7641,55 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossdef> </glossentry> - <glossentry id='var-KERNEL_IMAGE_BASE_NAME'><glossterm>KERNEL_IMAGE_BASE_NAME</glossterm> + <glossentry id='var-KERNEL_FIT_LINK_NAME'><glossterm>KERNEL_FIT_LINK_NAME</glossterm> <info> - KERNEL_IMAGE_BASE_NAME[doc] = "The base name of the kernel image. Deprecated for Yocto Project 2.6 release and forward." + KERNEL_FIT_LINK_NAME[doc] = "The link name of the kernel flattened image tree (FIT) image." </info> <glossdef> <para role="glossdeffirst"> <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - <note> - See the - <link linkend='var-KERNEL_IMAGE_NAME'><filename>KERNEL_IMAGE_NAME</filename></link> - variable for information. - The <filename>KERNEL_IMAGE_BASE_NAME</filename> - variable's name has changed for Yocto Project 2.6 - release and forward. - </note> - Prior to the 2.6 release of Yocto Project, this variable - was set in the - <link linkend='ref-classes-kernel'>kernel</link> class - as follows: + The link name of the kernel flattened image tree (FIT) image. + This variable is set in the + <filename>meta/classes/kernel-artifact-names.bbclass</filename> + file as follows: <literallayout class='monospaced'> - KERNEL_IMAGE_BASE_NAME ?= "${PKGE}-${PKGV}-${PKGR}-${MACHINE}-${DATETIME}" + KERNEL_FIT_LINK_NAME ?= "${KERNEL_ARTIFACT_LINK_NAME}" + </literallayout> + The value of the <filename>KERNEL_ARTIFACT_LINK_NAME</filename> + variable, which is set in the same file, has the following + value: + <literallayout class='monospaced'> + KERNEL_ARTIFACT_LINK_NAME ?= "${MACHINE}" + </literallayout> + </para> + + <para> + See the + <link linkend='var-MACHINE'><filename>MACHINE</filename></link> + variable for additional information. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-KERNEL_FIT_NAME'><glossterm>KERNEL_FIT_NAME</glossterm> + <info> + KERNEL_FIT_NAME[doc] = "The base name of the kernel flattened image tree (FIT) image." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + The base name of the kernel flattened image tree (FIT) image. + This variable is set in the + <filename>meta/classes/kernel-artifact-names.bbclass</filename> + file as follows: + <literallayout class='monospaced'> + KERNEL_FIT_NAME ?= "${KERNEL_ARTIFACT_NAME}" + </literallayout> + The value of the <filename>KERNEL_ARTIFACT_NAME</filename> + variable, which is set in the same file, has the following + value: + <literallayout class='monospaced'> + KERNEL_ARTIFACT_NAME ?= "${PKGE}-${PKGV}-${PKGR}-${MACHINE}${IMAGE_VERSION_SUFFIX}" </literallayout> </para> @@ -7542,14 +7698,43 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" <link linkend='var-PKGE'><filename>PKGE</filename></link>, <link linkend='var-PKGV'><filename>PKGV</filename></link>, <link linkend='var-PKGR'><filename>PKGR</filename></link>, - <link linkend='var-MACHINE'><filename>MACHINE</filename></link>, and - <link linkend='var-DATETIME'><filename>DATETIME</filename></link> + <link linkend='var-MACHINE'><filename>MACHINE</filename></link> variables for additional information. </para> </glossdef> </glossentry> + <glossentry id='var-KERNEL_IMAGE_LINK_NAME'><glossterm>KERNEL_IMAGE_LINK_NAME</glossterm> + <info> + KERNEL_IMAGE_LINK_NAME[doc] = "The link name for the kernel image." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + The link name for the kernel image. + This variable is set in the + <filename>meta/classes/kernel-artifact-names.bbclass</filename> + file as follows: + <literallayout class='monospaced'> + KERNEL_IMAGE_LINK_NAME ?= "${KERNEL_ARTIFACT_LINK_NAME}" + </literallayout> + The value of the <filename>KERNEL_ARTIFACT_LINK_NAME</filename> + variable, which is set in the same file, has the following + value: + <literallayout class='monospaced'> + KERNEL_ARTIFACT_LINK_NAME ?= "${MACHINE}" + </literallayout> + </para> + + <para> + See the + <link linkend='var-MACHINE'><filename>MACHINE</filename></link> + variable for additional information. + </para> + </glossdef> + </glossentry> + <glossentry id='var-KERNEL_IMAGE_MAXSIZE'><glossterm>KERNEL_IMAGE_MAXSIZE</glossterm> <info> KERNEL_IMAGE_MAXSIZE[doc] = "The maximum allowable size in kilobytes of the kernel image file." @@ -9028,47 +9213,82 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </glossdef> </glossentry> - <glossentry id='var-MODULE_IMAGE_BASE_NAME'><glossterm>MODULE_IMAGE_BASE_NAME</glossterm> + <glossentry id='var-MODULE_TARBALL_DEPLOY'><glossterm>MODULE_TARBALL_DEPLOY</glossterm> + <info> + MODULE_TARBALL_DEPLOY[doc] = "Controls creation of the modules-*.tgz file. Set this variable to "0" to disable creation of this file, which contains all of the kernel modules resulting from a kernel build." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Controls creation of the <filename>modules-*.tgz</filename> + file. + Set this variable to "0" to disable creation of this + file, which contains all of the kernel modules resulting + from a kernel build. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-MODULE_TARBALL_LINK_NAME'><glossterm>MODULE_TARBALL_LINK_NAME</glossterm> <info> - MODULE_IMAGE_BASE_NAME[doc] = "The base name of the kernel modules tarball." + MODULE_TARBALL_LINK_NAME[doc] = "The link name of the module tarball." </info> <glossdef> <para role="glossdeffirst"> <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - The base name of the kernel modules tarball. + The link name of the module tarball. This variable is set in the - <link linkend='ref-classes-kernel'>kernel</link> class - as follows: + <filename>meta/classes/kernel-artifact-names.bbclass</filename> + file as follows: <literallayout class='monospaced'> - MODULE_IMAGE_BASE_NAME ?= "modules-${PKGE}-${PKGV}-${PKGR}-${MACHINE}-${DATETIME}" + MODULE_TARBALL_LINK_NAME ?= "${KERNEL_ARTIFACT_LINK_NAME}" + </literallayout> + The value of the <filename>KERNEL_ARTIFACT_LINK_NAME</filename> + variable, which is set in the same file, has the following + value: + <literallayout class='monospaced'> + KERNEL_ARTIFACT_LINK_NAME ?= "${MACHINE}" </literallayout> </para> <para> See the - <link linkend='var-PKGE'><filename>PKGE</filename></link>, - <link linkend='var-PKGV'><filename>PKGV</filename></link>, - <link linkend='var-PKGR'><filename>PKGR</filename></link>, - <link linkend='var-MACHINE'><filename>MACHINE</filename></link>, - and - <link linkend='var-DATETIME'><filename>DATETIME</filename></link> - variables for additional information. + <link linkend='var-MACHINE'><filename>MACHINE</filename></link> + variable for additional information. </para> </glossdef> </glossentry> - <glossentry id='var-MODULE_TARBALL_DEPLOY'><glossterm>MODULE_TARBALL_DEPLOY</glossterm> + <glossentry id='var-MODULE_TARBALL_NAME'><glossterm>MODULE_TARBALL_NAME</glossterm> <info> - MODULE_TARBALL_DEPLOY[doc] = "Controls creation of the modules-*.tgz file. Set this variable to "0" to disable creation of this file, which contains all of the kernel modules resulting from a kernel build." + MODULE_TARBALL_NAME[doc] = "The base name of the module tarball." </info> <glossdef> <para role="glossdeffirst"> <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Controls creation of the <filename>modules-*.tgz</filename> - file. - Set this variable to "0" to disable creation of this - file, which contains all of the kernel modules resulting - from a kernel build. + The base name of the module tarball. + This variable is set in the + <filename>meta/classes/kernel-artifact-names.bbclass</filename> + file as follows: + <literallayout class='monospaced'> + MODULE_TARBALL_NAME ?= "${KERNEL_ARTIFACT_NAME}" + </literallayout> + The value of the <filename>KERNEL_ARTIFACT_NAME</filename> + variable, which is set in the same file, has the following + value: + <literallayout class='monospaced'> + KERNEL_ARTIFACT_NAME ?= "${PKGE}-${PKGV}-${PKGR}-${MACHINE}${IMAGE_VERSION_SUFFIX}" + </literallayout> + </para> + + <para> + See the + <link linkend='var-PKGE'><filename>PKGE</filename></link>, + <link linkend='var-PKGV'><filename>PKGV</filename></link>, + <link linkend='var-PKGR'><filename>PKGR</filename></link>, + and + <link linkend='var-MACHINE'><filename>MACHINE</filename></link> + variables for additional information. </para> </glossdef> </glossentry> |