summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorScott Rifenbark <srifenbark@gmail.com>2018-11-08 00:47:49 (GMT)
committerRichard Purdie <richard.purdie@linuxfoundation.org>2018-11-22 12:20:51 (GMT)
commitab2b5029e7dc9afcf8aed4b958b6b7fdae17ae3d (patch)
treede05d5b18d240f1e7894db17b9ea4970bc6f4e86 /documentation
parentf148a5750d61c77d35e99a0785a91b264e05ceda (diff)
downloadpoky-ab2b5029e7dc9afcf8aed4b958b6b7fdae17ae3d.tar.gz
ref-manual: Added new artifact naming variables to glossary.
(From yocto-docs rev: ed122fae8ec6e9eb38c196decfc6f5016945f4ee) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
-rw-r--r--documentation/ref-manual/ref-variables.xml294
1 files changed, 257 insertions, 37 deletions
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml
index 9b86eb8..48783e7 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"
7024 </glossdef> 7024 </glossdef>
7025 </glossentry> 7025 </glossentry>
7026 7026
7027 <glossentry id='var-INITRAMFS_LINK_NAME'><glossterm>INITRAMFS_LINK_NAME</glossterm>
7028 <info>
7029 INITRAMFS_LINK_NAME[doc] = "The link name of the initial RAM filesystem image."
7030 </info>
7031 <glossdef>
7032 <para role="glossdeffirst">
7033<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
7034 The link name of the initial RAM filesystem image.
7035 This variable is set in the
7036 <filename>meta/classes/kernel-artifact-names.bbclass</filename>
7037 file as follows:
7038 <literallayout class='monospaced'>
7039 INITRAMFS_LINK_NAME ?= "initramfs-${KERNEL_ARTIFACT_LINK_NAME}"
7040 </literallayout>
7041 The value of the <filename>KERNEL_ARTIFACT_LINK_NAME</filename>
7042 variable, which is set in the same file, has the following
7043 value:
7044 <literallayout class='monospaced'>
7045 KERNEL_ARTIFACT_LINK_NAME ?= "${MACHINE}"
7046 </literallayout>
7047 </para>
7048
7049 <para>
7050 See the
7051 <link linkend='var-MACHINE'><filename>MACHINE</filename></link>
7052 variable for additional information.
7053 </para>
7054 </glossdef>
7055 </glossentry>
7056
7057 <glossentry id='var-INITRAMFS_NAME'><glossterm>INITRAMFS_NAME</glossterm>
7058 <info>
7059 INITRAMFS_NAME[doc] = "The base name of the initial RAM filesystem image."
7060 </info>
7061 <glossdef>
7062 <para role="glossdeffirst">
7063<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
7064 The base name of the initial RAM filesystem image.
7065 This variable is set in the
7066 <filename>meta/classes/kernel-artifact-names.bbclass</filename>
7067 file as follows:
7068 <literallayout class='monospaced'>
7069 INITRAMFS_NAME ?= "initramfs-${KERNEL_ARTIFACT_NAME}"
7070 </literallayout>
7071 The value of the <filename>KERNEL_ARTIFACT_NAME</filename>
7072 variable, which is set in the same file, has the following
7073 value:
7074 <literallayout class='monospaced'>
7075 KERNEL_ARTIFACT_NAME ?= "${PKGE}-${PKGV}-${PKGR}-${MACHINE}${IMAGE_VERSION_SUFFIX}"
7076 </literallayout>
7077 </para>
7078
7079 <para>
7080 See the
7081 <link linkend='var-PKGE'><filename>PKGE</filename></link>,
7082 <link linkend='var-PKGV'><filename>PKGV</filename></link>,
7083 <link linkend='var-PKGR'><filename>PKGR</filename></link>,
7084 and
7085 <link linkend='var-MACHINE'><filename>MACHINE</filename></link>
7086 variables for additional information.
7087 </para>
7088 </glossdef>
7089 </glossentry>
7090
7027 <glossentry id='var-INITRD'><glossterm>INITRD</glossterm> 7091 <glossentry id='var-INITRD'><glossterm>INITRD</glossterm>
7028 <info> 7092 <info>
7029 INITRD[doc] = "Indicates a list of filesystem images to concatenate and use as an initial RAM disk (initrd)." 7093 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"
7449 </glossdef> 7513 </glossdef>
7450 </glossentry> 7514 </glossentry>
7451 7515
7516 <glossentry id='var-KERNEL_DTB_LINK_NAME'><glossterm>KERNEL_DTB_LINK_NAME</glossterm>
7517 <info>
7518 KERNEL_DTB_LINK_NAME[doc] = "The link name of the kernel device tree binary (DTB)."
7519 </info>
7520 <glossdef>
7521 <para role="glossdeffirst">
7522<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
7523 The link name of the kernel device tree binary (DTB).
7524 This variable is set in the
7525 <filename>meta/classes/kernel-artifact-names.bbclass</filename>
7526 file as follows:
7527 <literallayout class='monospaced'>
7528 KERNEL_DTB_LINK_NAME ?= "${KERNEL_ARTIFACT_LINK_NAME}"
7529 </literallayout>
7530 The value of the <filename>KERNEL_ARTIFACT_LINK_NAME</filename>
7531 variable, which is set in the same file, has the following
7532 value:
7533 <literallayout class='monospaced'>
7534 KERNEL_ARTIFACT_LINK_NAME ?= "${MACHINE}"
7535 </literallayout>
7536 </para>
7537
7538 <para>
7539 See the
7540 <link linkend='var-MACHINE'><filename>MACHINE</filename></link>
7541 variable for additional information.
7542 </para>
7543 </glossdef>
7544 </glossentry>
7545
7546 <glossentry id='var-KERNEL_DTB_NAME'><glossterm>KERNEL_DTB_NAME</glossterm>
7547 <info>
7548 KERNEL_DTB_NAME[doc] = "The base name of the kernel device tree binary (DTB)."
7549 </info>
7550 <glossdef>
7551 <para role="glossdeffirst">
7552<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
7553 The base name of the kernel device tree binary (DTB).
7554 This variable is set in the
7555 <filename>meta/classes/kernel-artifact-names.bbclass</filename>
7556 file as follows:
7557 <literallayout class='monospaced'>
7558 KERNEL_DTB_NAME ?= "${KERNEL_ARTIFACT_NAME}"
7559 </literallayout>
7560 The value of the <filename>KERNEL_ARTIFACT_NAME</filename>
7561 variable, which is set in the same file, has the following
7562 value:
7563 <literallayout class='monospaced'>
7564 KERNEL_ARTIFACT_NAME ?= "${PKGE}-${PKGV}-${PKGR}-${MACHINE}${IMAGE_VERSION_SUFFIX}"
7565 </literallayout>
7566 </para>
7567
7568 <para>
7569 See the
7570 <link linkend='var-PKGE'><filename>PKGE</filename></link>,
7571 <link linkend='var-PKGV'><filename>PKGV</filename></link>,
7572 <link linkend='var-PKGR'><filename>PKGR</filename></link>,
7573 and
7574 <link linkend='var-MACHINE'><filename>MACHINE</filename></link>
7575 variables for additional information.
7576 </para>
7577 </glossdef>
7578 </glossentry>
7579
7452 <glossentry id='var-KERNEL_EXTRA_ARGS'><glossterm>KERNEL_EXTRA_ARGS</glossterm> 7580 <glossentry id='var-KERNEL_EXTRA_ARGS'><glossterm>KERNEL_EXTRA_ARGS</glossterm>
7453 <info> 7581 <info>
7454 KERNEL_EXTRA_ARGS[doc] = "Specifies additional make command-line arguments the OpenEmbedded build system passes on when compiling the kernel." 7582 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"
7513 </glossdef> 7641 </glossdef>
7514 </glossentry> 7642 </glossentry>
7515 7643
7516 <glossentry id='var-KERNEL_IMAGE_BASE_NAME'><glossterm>KERNEL_IMAGE_BASE_NAME</glossterm> 7644 <glossentry id='var-KERNEL_FIT_LINK_NAME'><glossterm>KERNEL_FIT_LINK_NAME</glossterm>
7517 <info> 7645 <info>
7518 KERNEL_IMAGE_BASE_NAME[doc] = "The base name of the kernel image. Deprecated for Yocto Project 2.6 release and forward." 7646 KERNEL_FIT_LINK_NAME[doc] = "The link name of the kernel flattened image tree (FIT) image."
7519 </info> 7647 </info>
7520 <glossdef> 7648 <glossdef>
7521 <para role="glossdeffirst"> 7649 <para role="glossdeffirst">
7522<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> 7650<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
7523 <note> 7651 The link name of the kernel flattened image tree (FIT) image.
7524 See the 7652 This variable is set in the
7525 <link linkend='var-KERNEL_IMAGE_NAME'><filename>KERNEL_IMAGE_NAME</filename></link> 7653 <filename>meta/classes/kernel-artifact-names.bbclass</filename>
7526 variable for information. 7654 file as follows:
7527 The <filename>KERNEL_IMAGE_BASE_NAME</filename>
7528 variable's name has changed for Yocto Project 2.6
7529 release and forward.
7530 </note>
7531 Prior to the 2.6 release of Yocto Project, this variable
7532 was set in the
7533 <link linkend='ref-classes-kernel'>kernel</link> class
7534 as follows:
7535 <literallayout class='monospaced'> 7655 <literallayout class='monospaced'>
7536 KERNEL_IMAGE_BASE_NAME ?= "${PKGE}-${PKGV}-${PKGR}-${MACHINE}-${DATETIME}" 7656 KERNEL_FIT_LINK_NAME ?= "${KERNEL_ARTIFACT_LINK_NAME}"
7657 </literallayout>
7658 The value of the <filename>KERNEL_ARTIFACT_LINK_NAME</filename>
7659 variable, which is set in the same file, has the following
7660 value:
7661 <literallayout class='monospaced'>
7662 KERNEL_ARTIFACT_LINK_NAME ?= "${MACHINE}"
7663 </literallayout>
7664 </para>
7665
7666 <para>
7667 See the
7668 <link linkend='var-MACHINE'><filename>MACHINE</filename></link>
7669 variable for additional information.
7670 </para>
7671 </glossdef>
7672 </glossentry>
7673
7674 <glossentry id='var-KERNEL_FIT_NAME'><glossterm>KERNEL_FIT_NAME</glossterm>
7675 <info>
7676 KERNEL_FIT_NAME[doc] = "The base name of the kernel flattened image tree (FIT) image."
7677 </info>
7678 <glossdef>
7679 <para role="glossdeffirst">
7680<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
7681 The base name of the kernel flattened image tree (FIT) image.
7682 This variable is set in the
7683 <filename>meta/classes/kernel-artifact-names.bbclass</filename>
7684 file as follows:
7685 <literallayout class='monospaced'>
7686 KERNEL_FIT_NAME ?= "${KERNEL_ARTIFACT_NAME}"
7687 </literallayout>
7688 The value of the <filename>KERNEL_ARTIFACT_NAME</filename>
7689 variable, which is set in the same file, has the following
7690 value:
7691 <literallayout class='monospaced'>
7692 KERNEL_ARTIFACT_NAME ?= "${PKGE}-${PKGV}-${PKGR}-${MACHINE}${IMAGE_VERSION_SUFFIX}"
7537 </literallayout> 7693 </literallayout>
7538 </para> 7694 </para>
7539 7695
@@ -7542,14 +7698,43 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
7542 <link linkend='var-PKGE'><filename>PKGE</filename></link>, 7698 <link linkend='var-PKGE'><filename>PKGE</filename></link>,
7543 <link linkend='var-PKGV'><filename>PKGV</filename></link>, 7699 <link linkend='var-PKGV'><filename>PKGV</filename></link>,
7544 <link linkend='var-PKGR'><filename>PKGR</filename></link>, 7700 <link linkend='var-PKGR'><filename>PKGR</filename></link>,
7545 <link linkend='var-MACHINE'><filename>MACHINE</filename></link>,
7546 and 7701 and
7547 <link linkend='var-DATETIME'><filename>DATETIME</filename></link> 7702 <link linkend='var-MACHINE'><filename>MACHINE</filename></link>
7548 variables for additional information. 7703 variables for additional information.
7549 </para> 7704 </para>
7550 </glossdef> 7705 </glossdef>
7551 </glossentry> 7706 </glossentry>
7552 7707
7708 <glossentry id='var-KERNEL_IMAGE_LINK_NAME'><glossterm>KERNEL_IMAGE_LINK_NAME</glossterm>
7709 <info>
7710 KERNEL_IMAGE_LINK_NAME[doc] = "The link name for the kernel image."
7711 </info>
7712 <glossdef>
7713 <para role="glossdeffirst">
7714<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
7715 The link name for the kernel image.
7716 This variable is set in the
7717 <filename>meta/classes/kernel-artifact-names.bbclass</filename>
7718 file as follows:
7719 <literallayout class='monospaced'>
7720 KERNEL_IMAGE_LINK_NAME ?= "${KERNEL_ARTIFACT_LINK_NAME}"
7721 </literallayout>
7722 The value of the <filename>KERNEL_ARTIFACT_LINK_NAME</filename>
7723 variable, which is set in the same file, has the following
7724 value:
7725 <literallayout class='monospaced'>
7726 KERNEL_ARTIFACT_LINK_NAME ?= "${MACHINE}"
7727 </literallayout>
7728 </para>
7729
7730 <para>
7731 See the
7732 <link linkend='var-MACHINE'><filename>MACHINE</filename></link>
7733 variable for additional information.
7734 </para>
7735 </glossdef>
7736 </glossentry>
7737
7553 <glossentry id='var-KERNEL_IMAGE_MAXSIZE'><glossterm>KERNEL_IMAGE_MAXSIZE</glossterm> 7738 <glossentry id='var-KERNEL_IMAGE_MAXSIZE'><glossterm>KERNEL_IMAGE_MAXSIZE</glossterm>
7554 <info> 7739 <info>
7555 KERNEL_IMAGE_MAXSIZE[doc] = "The maximum allowable size in kilobytes of the kernel image file." 7740 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"
9028 </glossdef> 9213 </glossdef>
9029 </glossentry> 9214 </glossentry>
9030 9215
9031 <glossentry id='var-MODULE_IMAGE_BASE_NAME'><glossterm>MODULE_IMAGE_BASE_NAME</glossterm> 9216 <glossentry id='var-MODULE_TARBALL_DEPLOY'><glossterm>MODULE_TARBALL_DEPLOY</glossterm>
9217 <info>
9218 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."
9219 </info>
9220 <glossdef>
9221 <para role="glossdeffirst">
9222<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
9223 Controls creation of the <filename>modules-*.tgz</filename>
9224 file.
9225 Set this variable to "0" to disable creation of this
9226 file, which contains all of the kernel modules resulting
9227 from a kernel build.
9228 </para>
9229 </glossdef>
9230 </glossentry>
9231
9232 <glossentry id='var-MODULE_TARBALL_LINK_NAME'><glossterm>MODULE_TARBALL_LINK_NAME</glossterm>
9032 <info> 9233 <info>
9033 MODULE_IMAGE_BASE_NAME[doc] = "The base name of the kernel modules tarball." 9234 MODULE_TARBALL_LINK_NAME[doc] = "The link name of the module tarball."
9034 </info> 9235 </info>
9035 <glossdef> 9236 <glossdef>
9036 <para role="glossdeffirst"> 9237 <para role="glossdeffirst">
9037<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> 9238<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
9038 The base name of the kernel modules tarball. 9239 The link name of the module tarball.
9039 This variable is set in the 9240 This variable is set in the
9040 <link linkend='ref-classes-kernel'>kernel</link> class 9241 <filename>meta/classes/kernel-artifact-names.bbclass</filename>
9041 as follows: 9242 file as follows:
9042 <literallayout class='monospaced'> 9243 <literallayout class='monospaced'>
9043 MODULE_IMAGE_BASE_NAME ?= "modules-${PKGE}-${PKGV}-${PKGR}-${MACHINE}-${DATETIME}" 9244 MODULE_TARBALL_LINK_NAME ?= "${KERNEL_ARTIFACT_LINK_NAME}"
9245 </literallayout>
9246 The value of the <filename>KERNEL_ARTIFACT_LINK_NAME</filename>
9247 variable, which is set in the same file, has the following
9248 value:
9249 <literallayout class='monospaced'>
9250 KERNEL_ARTIFACT_LINK_NAME ?= "${MACHINE}"
9044 </literallayout> 9251 </literallayout>
9045 </para> 9252 </para>
9046 9253
9047 <para> 9254 <para>
9048 See the 9255 See the
9049 <link linkend='var-PKGE'><filename>PKGE</filename></link>, 9256 <link linkend='var-MACHINE'><filename>MACHINE</filename></link>
9050 <link linkend='var-PKGV'><filename>PKGV</filename></link>, 9257 variable for additional information.
9051 <link linkend='var-PKGR'><filename>PKGR</filename></link>,
9052 <link linkend='var-MACHINE'><filename>MACHINE</filename></link>,
9053 and
9054 <link linkend='var-DATETIME'><filename>DATETIME</filename></link>
9055 variables for additional information.
9056 </para> 9258 </para>
9057 </glossdef> 9259 </glossdef>
9058 </glossentry> 9260 </glossentry>
9059 9261
9060 <glossentry id='var-MODULE_TARBALL_DEPLOY'><glossterm>MODULE_TARBALL_DEPLOY</glossterm> 9262 <glossentry id='var-MODULE_TARBALL_NAME'><glossterm>MODULE_TARBALL_NAME</glossterm>
9061 <info> 9263 <info>
9062 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." 9264 MODULE_TARBALL_NAME[doc] = "The base name of the module tarball."
9063 </info> 9265 </info>
9064 <glossdef> 9266 <glossdef>
9065 <para role="glossdeffirst"> 9267 <para role="glossdeffirst">
9066<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> 9268<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
9067 Controls creation of the <filename>modules-*.tgz</filename> 9269 The base name of the module tarball.
9068 file. 9270 This variable is set in the
9069 Set this variable to "0" to disable creation of this 9271 <filename>meta/classes/kernel-artifact-names.bbclass</filename>
9070 file, which contains all of the kernel modules resulting 9272 file as follows:
9071 from a kernel build. 9273 <literallayout class='monospaced'>
9274 MODULE_TARBALL_NAME ?= "${KERNEL_ARTIFACT_NAME}"
9275 </literallayout>
9276 The value of the <filename>KERNEL_ARTIFACT_NAME</filename>
9277 variable, which is set in the same file, has the following
9278 value:
9279 <literallayout class='monospaced'>
9280 KERNEL_ARTIFACT_NAME ?= "${PKGE}-${PKGV}-${PKGR}-${MACHINE}${IMAGE_VERSION_SUFFIX}"
9281 </literallayout>
9282 </para>
9283
9284 <para>
9285 See the
9286 <link linkend='var-PKGE'><filename>PKGE</filename></link>,
9287 <link linkend='var-PKGV'><filename>PKGV</filename></link>,
9288 <link linkend='var-PKGR'><filename>PKGR</filename></link>,
9289 and
9290 <link linkend='var-MACHINE'><filename>MACHINE</filename></link>
9291 variables for additional information.
9072 </para> 9292 </para>
9073 </glossdef> 9293 </glossdef>
9074 </glossentry> 9294 </glossentry>