summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual
diff options
context:
space:
mode:
authorScott Rifenbark <srifenbark@gmail.com>2018-11-09 12:30:33 -0800
committerRichard Purdie <richard.purdie@linuxfoundation.org>2018-11-22 12:20:52 +0000
commit2103d41b2e65240605bfb1b457e54f2540ac281f (patch)
tree3d38194c92ab7f9c0c6a051833912351c91f1782 /documentation/ref-manual
parentb9834979b15fdaab29e25637d2af87ed2e54ecee (diff)
downloadpoky-2103d41b2e65240605bfb1b457e54f2540ac281f.tar.gz
ref-manual: Added KERNEL_ARTIFACT_NAME and adjusted referencing variables.
The KERNEL_ARTIFACT_NAME variable is used throughout to set the names of build artifacts. Rather than repeat informaiton about KERNEL_ARTIFACT_NAME in the many variables that use it, I added a new entry for the variable. This also impacted the descriptions of the variables that were repeating information. I updated those variable descriptions as well. (From yocto-docs rev: 5750d30be21e17fe21d89254925dc0e773c08e66) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/ref-manual')
-rw-r--r--documentation/ref-manual/ref-variables.xml112
1 files changed, 53 insertions, 59 deletions
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml
index 5f5852ab18..58c5418d16 100644
--- a/documentation/ref-manual/ref-variables.xml
+++ b/documentation/ref-manual/ref-variables.xml
@@ -7068,23 +7068,14 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
7068 <literallayout class='monospaced'> 7068 <literallayout class='monospaced'>
7069 INITRAMFS_NAME ?= "initramfs-${KERNEL_ARTIFACT_NAME}" 7069 INITRAMFS_NAME ?= "initramfs-${KERNEL_ARTIFACT_NAME}"
7070 </literallayout> 7070 </literallayout>
7071 The value of the <filename>KERNEL_ARTIFACT_NAME</filename> 7071 The value of the
7072 <link linkend='var-KERNEL_ARTIFACT_NAME'><filename>KERNEL_ARTIFACT_NAME</filename></link>
7072 variable, which is set in the same file, has the following 7073 variable, which is set in the same file, has the following
7073 value: 7074 value:
7074 <literallayout class='monospaced'> 7075 <literallayout class='monospaced'>
7075 KERNEL_ARTIFACT_NAME ?= "${PKGE}-${PKGV}-${PKGR}-${MACHINE}${IMAGE_VERSION_SUFFIX}" 7076 KERNEL_ARTIFACT_NAME ?= "${PKGE}-${PKGV}-${PKGR}-${MACHINE}${IMAGE_VERSION_SUFFIX}"
7076 </literallayout> 7077 </literallayout>
7077 </para> 7078 </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> 7079 </glossdef>
7089 </glossentry> 7080 </glossentry>
7090 7081
@@ -7464,6 +7455,45 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
7464 </glossdef> 7455 </glossdef>
7465 </glossentry> 7456 </glossentry>
7466 7457
7458 <glossentry id='var-KERNEL_ARTIFACT_NAME'><glossterm>KERNEL_ARTIFACT_NAME</glossterm>
7459 <info>
7460 KERNEL_ARTIFACT_NAME[doc] = "Specifies the name of all of the build artifacts."
7461 </info>
7462 <glossdef>
7463 <para role="glossdeffirst">
7464<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
7465 Specifies the name of all of the build artifacts.
7466 You can change the name of the artifacts by changing the
7467 <filename>KERNEL_ARTIFACT_NAME</filename> variable.
7468 </para>
7469
7470 <para>
7471 The value of <filename>KERNEL_ARTIFACT_NAME</filename>,
7472 which is set in the
7473 <filename> meta/classes/kernel-artifact-names.bbclass</filename>
7474 file, has the following default value:
7475 <literallayout class='monospaced'>
7476 KERNEL_ARTIFACT_NAME ?= "${PKGE}-${PKGV}-${PKGR}-${MACHINE}${IMAGE_VERSION_SUFFIX}"
7477 </literallayout>
7478 </para>
7479
7480 <para>
7481 See the
7482 <link linkend='var-PKGE'><filename>PKGE</filename></link>,
7483 <link linkend='var-PKGV'><filename>PKGV</filename></link>,
7484 <link linkend='var-PKGR'><filename>PKGR</filename></link>,
7485 and
7486 <link linkend='var-MACHINE'><filename>MACHINE</filename></link>
7487 variables for additional information.
7488 <note>
7489 The <filename>IMAGE_VERSION_SUFFIX</filename> variable
7490 is set to
7491 <link linkend='var-DATETIME'><filename>DATETIME</filename></link>.
7492 </note>
7493 </para>
7494 </glossdef>
7495 </glossentry>
7496
7467 <glossentry id='var-KERNEL_CLASSES'><glossterm>KERNEL_CLASSES</glossterm> 7497 <glossentry id='var-KERNEL_CLASSES'><glossterm>KERNEL_CLASSES</glossterm>
7468 <info> 7498 <info>
7469 KERNEL_CLASSES[doc] = "A list of classes defining kernel image types that kernel class should inherit." 7499 KERNEL_CLASSES[doc] = "A list of classes defining kernel image types that kernel class should inherit."
@@ -7557,23 +7587,14 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
7557 <literallayout class='monospaced'> 7587 <literallayout class='monospaced'>
7558 KERNEL_DTB_NAME ?= "${KERNEL_ARTIFACT_NAME}" 7588 KERNEL_DTB_NAME ?= "${KERNEL_ARTIFACT_NAME}"
7559 </literallayout> 7589 </literallayout>
7560 The value of the <filename>KERNEL_ARTIFACT_NAME</filename> 7590 The value of the
7591 <link linkend='var-KERNEL_ARTIFACT_NAME'><filename>KERNEL_ARTIFACT_NAME</filename></link>
7561 variable, which is set in the same file, has the following 7592 variable, which is set in the same file, has the following
7562 value: 7593 value:
7563 <literallayout class='monospaced'> 7594 <literallayout class='monospaced'>
7564 KERNEL_ARTIFACT_NAME ?= "${PKGE}-${PKGV}-${PKGR}-${MACHINE}${IMAGE_VERSION_SUFFIX}" 7595 KERNEL_ARTIFACT_NAME ?= "${PKGE}-${PKGV}-${PKGR}-${MACHINE}${IMAGE_VERSION_SUFFIX}"
7565 </literallayout> 7596 </literallayout>
7566 </para> 7597 </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> 7598 </glossdef>
7578 </glossentry> 7599 </glossentry>
7579 7600
@@ -7685,23 +7706,14 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
7685 <literallayout class='monospaced'> 7706 <literallayout class='monospaced'>
7686 KERNEL_FIT_NAME ?= "${KERNEL_ARTIFACT_NAME}" 7707 KERNEL_FIT_NAME ?= "${KERNEL_ARTIFACT_NAME}"
7687 </literallayout> 7708 </literallayout>
7688 The value of the <filename>KERNEL_ARTIFACT_NAME</filename> 7709 The value of the
7710 <link linkend='var-KERNEL_ARTIFACT_NAME'><filename>KERNEL_ARTIFACT_NAME</filename></link>
7689 variable, which is set in the same file, has the following 7711 variable, which is set in the same file, has the following
7690 value: 7712 value:
7691 <literallayout class='monospaced'> 7713 <literallayout class='monospaced'>
7692 KERNEL_ARTIFACT_NAME ?= "${PKGE}-${PKGV}-${PKGR}-${MACHINE}${IMAGE_VERSION_SUFFIX}" 7714 KERNEL_ARTIFACT_NAME ?= "${PKGE}-${PKGV}-${PKGR}-${MACHINE}${IMAGE_VERSION_SUFFIX}"
7693 </literallayout> 7715 </literallayout>
7694 </para> 7716 </para>
7695
7696 <para>
7697 See the
7698 <link linkend='var-PKGE'><filename>PKGE</filename></link>,
7699 <link linkend='var-PKGV'><filename>PKGV</filename></link>,
7700 <link linkend='var-PKGR'><filename>PKGR</filename></link>,
7701 and
7702 <link linkend='var-MACHINE'><filename>MACHINE</filename></link>
7703 variables for additional information.
7704 </para>
7705 </glossdef> 7717 </glossdef>
7706 </glossentry> 7718 </glossentry>
7707 7719
@@ -7780,23 +7792,14 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
7780 <literallayout class='monospaced'> 7792 <literallayout class='monospaced'>
7781 KERNEL_IMAGE_NAME ?= "${KERNEL_ARTIFACT_NAME}" 7793 KERNEL_IMAGE_NAME ?= "${KERNEL_ARTIFACT_NAME}"
7782 </literallayout> 7794 </literallayout>
7783 The value of the <filename>KERNEL_ARTIFACT_NAME</filename> 7795 The value of the
7796 <link linkend='var-KERNEL_ARTIFACT_NAME'><filename>KERNEL_ARTIFACT_NAME</filename></link>
7784 variable, which is set in the same file, has the following 7797 variable, which is set in the same file, has the following
7785 value: 7798 value:
7786 <literallayout class='monospaced'> 7799 <literallayout class='monospaced'>
7787 KERNEL_ARTIFACT_NAME ?= "${PKGE}-${PKGV}-${PKGR}-${MACHINE}${IMAGE_VERSION_SUFFIX}" 7800 KERNEL_ARTIFACT_NAME ?= "${PKGE}-${PKGV}-${PKGR}-${MACHINE}${IMAGE_VERSION_SUFFIX}"
7788 </literallayout> 7801 </literallayout>
7789 </para> 7802 </para>
7790
7791 <para>
7792 See the
7793 <link linkend='var-PKGE'><filename>PKGE</filename></link>,
7794 <link linkend='var-PKGV'><filename>PKGV</filename></link>,
7795 <link linkend='var-PKGR'><filename>PKGR</filename></link>,
7796 and
7797 <link linkend='var-MACHINE'><filename>MACHINE</filename></link>
7798 variables for additional information.
7799 </para>
7800 </glossdef> 7803 </glossdef>
7801 </glossentry> 7804 </glossentry>
7802 7805
@@ -9231,12 +9234,12 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
9231 9234
9232 <glossentry id='var-MODULE_TARBALL_LINK_NAME'><glossterm>MODULE_TARBALL_LINK_NAME</glossterm> 9235 <glossentry id='var-MODULE_TARBALL_LINK_NAME'><glossterm>MODULE_TARBALL_LINK_NAME</glossterm>
9233 <info> 9236 <info>
9234 MODULE_TARBALL_LINK_NAME[doc] = "The link name of the module tarball." 9237 MODULE_TARBALL_LINK_NAME[doc] = "The link name of the kernel module tarball."
9235 </info> 9238 </info>
9236 <glossdef> 9239 <glossdef>
9237 <para role="glossdeffirst"> 9240 <para role="glossdeffirst">
9238<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> 9241<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
9239 The link name of the module tarball. 9242 The link name of the kernel module tarball.
9240 This variable is set in the 9243 This variable is set in the
9241 <filename>meta/classes/kernel-artifact-names.bbclass</filename> 9244 <filename>meta/classes/kernel-artifact-names.bbclass</filename>
9242 file as follows: 9245 file as follows:
@@ -9261,35 +9264,26 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
9261 9264
9262 <glossentry id='var-MODULE_TARBALL_NAME'><glossterm>MODULE_TARBALL_NAME</glossterm> 9265 <glossentry id='var-MODULE_TARBALL_NAME'><glossterm>MODULE_TARBALL_NAME</glossterm>
9263 <info> 9266 <info>
9264 MODULE_TARBALL_NAME[doc] = "The base name of the module tarball." 9267 MODULE_TARBALL_NAME[doc] = "The base name of the kernel module tarball."
9265 </info> 9268 </info>
9266 <glossdef> 9269 <glossdef>
9267 <para role="glossdeffirst"> 9270 <para role="glossdeffirst">
9268<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> 9271<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
9269 The base name of the module tarball. 9272 The base name of the kernel module tarball.
9270 This variable is set in the 9273 This variable is set in the
9271 <filename>meta/classes/kernel-artifact-names.bbclass</filename> 9274 <filename>meta/classes/kernel-artifact-names.bbclass</filename>
9272 file as follows: 9275 file as follows:
9273 <literallayout class='monospaced'> 9276 <literallayout class='monospaced'>
9274 MODULE_TARBALL_NAME ?= "${KERNEL_ARTIFACT_NAME}" 9277 MODULE_TARBALL_NAME ?= "${KERNEL_ARTIFACT_NAME}"
9275 </literallayout> 9278 </literallayout>
9276 The value of the <filename>KERNEL_ARTIFACT_NAME</filename> 9279 The value of the
9280 <link linkend='var-KERNEL_ARTIFACT_NAME'><filename>KERNEL_ARTIFACT_NAME</filename></link>
9277 variable, which is set in the same file, has the following 9281 variable, which is set in the same file, has the following
9278 value: 9282 value:
9279 <literallayout class='monospaced'> 9283 <literallayout class='monospaced'>
9280 KERNEL_ARTIFACT_NAME ?= "${PKGE}-${PKGV}-${PKGR}-${MACHINE}${IMAGE_VERSION_SUFFIX}" 9284 KERNEL_ARTIFACT_NAME ?= "${PKGE}-${PKGV}-${PKGR}-${MACHINE}${IMAGE_VERSION_SUFFIX}"
9281 </literallayout> 9285 </literallayout>
9282 </para> 9286 </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.
9292 </para>
9293 </glossdef> 9287 </glossdef>
9294 </glossentry> 9288 </glossentry>
9295 9289