mirrors/poky
1
0
Fork 0
mirror of https://git.yoctoproject.org/poky synced 2026-06-01 00:59:48 +00:00
Code Issues Projects Releases Wiki Activity

ref-manual: Added KERNEL_IMAGE_NAME description

Browse Source 
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>
This commit is contained in:
Scott Rifenbark
2018-11-06 10:31:08 -08:00
committed by Richard Purdie
parent d6725d934d
commit 8b9e5b95e5
1 changed files with 44 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
documentation/ref-manual/ref-variables.xml
+44 -3
View File
@@ -7515,13 +7515,20 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
<glossentry id='var-KERNEL_IMAGE_BASE_NAME'><glossterm>KERNEL_IMAGE_BASE_NAME</glossterm> <glossentry id='var-KERNEL_IMAGE_BASE_NAME'><glossterm>KERNEL_IMAGE_BASE_NAME</glossterm>
<info> <info>
KERNEL_IMAGE_BASE_NAME[doc] = "The base name of the kernel image." KERNEL_IMAGE_BASE_NAME[doc] = "The base name of the kernel image. Deprecated post Yocto Project 2.6 release."
</info> </info>
<glossdef> <glossdef>
<para role="glossdeffirst"> <para role="glossdeffirst">
<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
The base name of the kernel image. <note>
This variable is set in the 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 post Yocto Project 2.6.
</note>
Prior to the 2.6 release of Yocto Project, this variable
was set in the
<link linkend='ref-classes-kernel'>kernel</link> class <link linkend='ref-classes-kernel'>kernel</link> class
as follows: as follows:
<literallayout class='monospaced'> <literallayout class='monospaced'>
@@ -7573,6 +7580,40 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
</glossdef> </glossdef>
</glossentry> </glossentry>
<glossentry id='var-KERNEL_IMAGE_NAME'><glossterm>KERNEL_IMAGE_NAME</glossterm>
<info>
KERNEL_IMAGE_NAME[doc] = "The base name of the kernel image."
</info>
<glossdef>
<para role="glossdeffirst">
<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
The base name of 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_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_IMAGETYPE'><glossterm>KERNEL_IMAGETYPE</glossterm> <glossentry id='var-KERNEL_IMAGETYPE'><glossterm>KERNEL_IMAGETYPE</glossterm>
<info> <info>
KERNEL_IMAGETYPE[doc] = "The type of kernel to build for a device, usually set by the machine configuration files and defaults to 'zImage'." KERNEL_IMAGETYPE[doc] = "The type of kernel to build for a device, usually set by the machine configuration files and defaults to 'zImage'."