summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorScott Rifenbark <srifenbark@gmail.com>2018-11-06 10:31:08 -0800
committerRichard Purdie <richard.purdie@linuxfoundation.org>2018-12-27 22:54:54 +0000
commit8b9e5b95e59449f5dc387c2585d6aa6ecaef1ccf (patch)
tree1a1ee899f86ee026fb589af2fa1c84a790b8d2e7
parentd6725d934d78d35b7e232ff8fdc51792ccac3d1e (diff)
downloadpoky-8b9e5b95e59449f5dc387c2585d6aa6ecaef1ccf.tar.gz
ref-manual: Added KERNEL_IMAGE_NAME description
The KERNEL_IMAGE_NAME variable is new and is effectively a renamed KERNEL_IMAGE_BASE_NAME variable now. I provided a new glossary description for the new variable. I updated the existing KERNEL_IMAGE_BASE_NAME description to note it has changed. We can't just delete the old variable as there are migration notes for previous releases of YP. (From yocto-docs rev: 2a7bc2dd274f23d58c997771175c37005763ed08) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
-rw-r--r--documentation/ref-manual/ref-variables.xml47
1 files changed, 44 insertions, 3 deletions
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml
index da23d563e6..562866f9ee 100644
--- a/documentation/ref-manual/ref-variables.xml
+++ b/documentation/ref-manual/ref-variables.xml
@@ -7515,13 +7515,20 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
7515 7515
7516 <glossentry id='var-KERNEL_IMAGE_BASE_NAME'><glossterm>KERNEL_IMAGE_BASE_NAME</glossterm> 7516 <glossentry id='var-KERNEL_IMAGE_BASE_NAME'><glossterm>KERNEL_IMAGE_BASE_NAME</glossterm>
7517 <info> 7517 <info>
7518 KERNEL_IMAGE_BASE_NAME[doc] = "The base name of the kernel image." 7518 KERNEL_IMAGE_BASE_NAME[doc] = "The base name of the kernel image. Deprecated post Yocto Project 2.6 release."
7519 </info> 7519 </info>
7520 <glossdef> 7520 <glossdef>
7521 <para role="glossdeffirst"> 7521 <para role="glossdeffirst">
7522<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> 7522<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
7523 The base name of the kernel image. 7523 <note>
7524 This variable is set in the 7524 See the
7525 <link linkend='var-KERNEL_IMAGE_NAME'><filename>KERNEL_IMAGE_NAME</filename></link>
7526 variable for information.
7527 The <filename>KERNEL_IMAGE_BASE_NAME</filename>
7528 variable's name has changed post Yocto Project 2.6.
7529 </note>
7530 Prior to the 2.6 release of Yocto Project, this variable
7531 was set in the
7525 <link linkend='ref-classes-kernel'>kernel</link> class 7532 <link linkend='ref-classes-kernel'>kernel</link> class
7526 as follows: 7533 as follows:
7527 <literallayout class='monospaced'> 7534 <literallayout class='monospaced'>
@@ -7573,6 +7580,40 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
7573 </glossdef> 7580 </glossdef>
7574 </glossentry> 7581 </glossentry>
7575 7582
7583 <glossentry id='var-KERNEL_IMAGE_NAME'><glossterm>KERNEL_IMAGE_NAME</glossterm>
7584 <info>
7585 KERNEL_IMAGE_NAME[doc] = "The base name of the kernel image."
7586 </info>
7587 <glossdef>
7588 <para role="glossdeffirst">
7589<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
7590 The base name of the kernel image.
7591 This variable is set in the
7592 <filename>meta/classes/kernel-artifact-names.bbclass</filename>
7593 file as follows:
7594 <literallayout class='monospaced'>
7595 KERNEL_IMAGE_NAME ?= "${KERNEL_ARTIFACT_NAME}"
7596 </literallayout>
7597 The value of the <filename>KERNEL_ARTIFACT_NAME</filename>
7598 variable, which is set in the same file, has the following
7599 value:
7600 <literallayout class='monospaced'>
7601 KERNEL_ARTIFACT_NAME ?= "${PKGE}-${PKGV}-${PKGR}-${MACHINE}${IMAGE_VERSION_SUFFIX}"
7602 </literallayout>
7603 </para>
7604
7605 <para>
7606 See the
7607 <link linkend='var-PKGE'><filename>PKGE</filename></link>,
7608 <link linkend='var-PKGV'><filename>PKGV</filename></link>,
7609 <link linkend='var-PKGR'><filename>PKGR</filename></link>,
7610 and
7611 <link linkend='var-MACHINE'><filename>MACHINE</filename></link>
7612 variables for additional information.
7613 </para>
7614 </glossdef>
7615 </glossentry>
7616
7576 <glossentry id='var-KERNEL_IMAGETYPE'><glossterm>KERNEL_IMAGETYPE</glossterm> 7617 <glossentry id='var-KERNEL_IMAGETYPE'><glossterm>KERNEL_IMAGETYPE</glossterm>
7577 <info> 7618 <info>
7578 KERNEL_IMAGETYPE[doc] = "The type of kernel to build for a device, usually set by the machine configuration files and defaults to 'zImage'." 7619 KERNEL_IMAGETYPE[doc] = "The type of kernel to build for a device, usually set by the machine configuration files and defaults to 'zImage'."