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" + INITRAMFS_LINK_NAME + + INITRAMFS_LINK_NAME[doc] = "The link name of the initial RAM filesystem image." + + + + + The link name of the initial RAM filesystem image. + This variable is set in the + meta/classes/kernel-artifact-names.bbclass + file as follows: + + INITRAMFS_LINK_NAME ?= "initramfs-${KERNEL_ARTIFACT_LINK_NAME}" + + The value of the KERNEL_ARTIFACT_LINK_NAME + variable, which is set in the same file, has the following + value: + + KERNEL_ARTIFACT_LINK_NAME ?= "${MACHINE}" + + + + + See the + MACHINE + variable for additional information. + + + + + INITRAMFS_NAME + + INITRAMFS_NAME[doc] = "The base name of the initial RAM filesystem image." + + + + + The base name of the initial RAM filesystem image. + This variable is set in the + meta/classes/kernel-artifact-names.bbclass + file as follows: + + INITRAMFS_NAME ?= "initramfs-${KERNEL_ARTIFACT_NAME}" + + The value of the KERNEL_ARTIFACT_NAME + variable, which is set in the same file, has the following + value: + + KERNEL_ARTIFACT_NAME ?= "${PKGE}-${PKGV}-${PKGR}-${MACHINE}${IMAGE_VERSION_SUFFIX}" + + + + + See the + PKGE, + PKGV, + PKGR, + and + MACHINE + variables for additional information. + + + + INITRD 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" + KERNEL_DTB_LINK_NAME + + KERNEL_DTB_LINK_NAME[doc] = "The link name of the kernel device tree binary (DTB)." + + + + + The link name of the kernel device tree binary (DTB). + This variable is set in the + meta/classes/kernel-artifact-names.bbclass + file as follows: + + KERNEL_DTB_LINK_NAME ?= "${KERNEL_ARTIFACT_LINK_NAME}" + + The value of the KERNEL_ARTIFACT_LINK_NAME + variable, which is set in the same file, has the following + value: + + KERNEL_ARTIFACT_LINK_NAME ?= "${MACHINE}" + + + + + See the + MACHINE + variable for additional information. + + + + + KERNEL_DTB_NAME + + KERNEL_DTB_NAME[doc] = "The base name of the kernel device tree binary (DTB)." + + + + + The base name of the kernel device tree binary (DTB). + This variable is set in the + meta/classes/kernel-artifact-names.bbclass + file as follows: + + KERNEL_DTB_NAME ?= "${KERNEL_ARTIFACT_NAME}" + + The value of the KERNEL_ARTIFACT_NAME + variable, which is set in the same file, has the following + value: + + KERNEL_ARTIFACT_NAME ?= "${PKGE}-${PKGV}-${PKGR}-${MACHINE}${IMAGE_VERSION_SUFFIX}" + + + + + See the + PKGE, + PKGV, + PKGR, + and + MACHINE + variables for additional information. + + + + KERNEL_EXTRA_ARGS 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" - KERNEL_IMAGE_BASE_NAME + KERNEL_FIT_LINK_NAME - 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." - - See the - KERNEL_IMAGE_NAME - variable for information. - The KERNEL_IMAGE_BASE_NAME - variable's name has changed for Yocto Project 2.6 - release and forward. - - Prior to the 2.6 release of Yocto Project, this variable - was set in the - kernel class - as follows: + The link name of the kernel flattened image tree (FIT) image. + This variable is set in the + meta/classes/kernel-artifact-names.bbclass + file as follows: - KERNEL_IMAGE_BASE_NAME ?= "${PKGE}-${PKGV}-${PKGR}-${MACHINE}-${DATETIME}" + KERNEL_FIT_LINK_NAME ?= "${KERNEL_ARTIFACT_LINK_NAME}" + + The value of the KERNEL_ARTIFACT_LINK_NAME + variable, which is set in the same file, has the following + value: + + KERNEL_ARTIFACT_LINK_NAME ?= "${MACHINE}" + + + + + See the + MACHINE + variable for additional information. + + + + + KERNEL_FIT_NAME + + KERNEL_FIT_NAME[doc] = "The base name of the kernel flattened image tree (FIT) image." + + + + + The base name of the kernel flattened image tree (FIT) image. + This variable is set in the + meta/classes/kernel-artifact-names.bbclass + file as follows: + + KERNEL_FIT_NAME ?= "${KERNEL_ARTIFACT_NAME}" + + The value of the KERNEL_ARTIFACT_NAME + variable, which is set in the same file, has the following + value: + + KERNEL_ARTIFACT_NAME ?= "${PKGE}-${PKGV}-${PKGR}-${MACHINE}${IMAGE_VERSION_SUFFIX}" @@ -7542,14 +7698,43 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" PKGE, PKGV, PKGR, - MACHINE, and - DATETIME + MACHINE variables for additional information. + KERNEL_IMAGE_LINK_NAME + + KERNEL_IMAGE_LINK_NAME[doc] = "The link name for the kernel image." + + + + + The link name for the kernel image. + This variable is set in the + meta/classes/kernel-artifact-names.bbclass + file as follows: + + KERNEL_IMAGE_LINK_NAME ?= "${KERNEL_ARTIFACT_LINK_NAME}" + + The value of the KERNEL_ARTIFACT_LINK_NAME + variable, which is set in the same file, has the following + value: + + KERNEL_ARTIFACT_LINK_NAME ?= "${MACHINE}" + + + + + See the + MACHINE + variable for additional information. + + + + KERNEL_IMAGE_MAXSIZE KERNEL_IMAGE_MAXSIZE[doc] = "The maximum allowable size in kilobytes of the kernel image file." @@ -9028,35 +9213,6 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" - MODULE_IMAGE_BASE_NAME - - MODULE_IMAGE_BASE_NAME[doc] = "The base name of the kernel modules tarball." - - - - - The base name of the kernel modules tarball. - This variable is set in the - kernel class - as follows: - - MODULE_IMAGE_BASE_NAME ?= "modules-${PKGE}-${PKGV}-${PKGR}-${MACHINE}-${DATETIME}" - - - - - See the - PKGE, - PKGV, - PKGR, - MACHINE, - and - DATETIME - variables for additional information. - - - - MODULE_TARBALL_DEPLOY 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." @@ -9073,6 +9229,70 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" + MODULE_TARBALL_LINK_NAME + + MODULE_TARBALL_LINK_NAME[doc] = "The link name of the module tarball." + + + + + The link name of the module tarball. + This variable is set in the + meta/classes/kernel-artifact-names.bbclass + file as follows: + + MODULE_TARBALL_LINK_NAME ?= "${KERNEL_ARTIFACT_LINK_NAME}" + + The value of the KERNEL_ARTIFACT_LINK_NAME + variable, which is set in the same file, has the following + value: + + KERNEL_ARTIFACT_LINK_NAME ?= "${MACHINE}" + + + + + See the + MACHINE + variable for additional information. + + + + + MODULE_TARBALL_NAME + + MODULE_TARBALL_NAME[doc] = "The base name of the module tarball." + + + + + The base name of the module tarball. + This variable is set in the + meta/classes/kernel-artifact-names.bbclass + file as follows: + + MODULE_TARBALL_NAME ?= "${KERNEL_ARTIFACT_NAME}" + + The value of the KERNEL_ARTIFACT_NAME + variable, which is set in the same file, has the following + value: + + KERNEL_ARTIFACT_NAME ?= "${PKGE}-${PKGV}-${PKGR}-${MACHINE}${IMAGE_VERSION_SUFFIX}" + + + + + See the + PKGE, + PKGV, + PKGR, + and + MACHINE + variables for additional information. + + + +