From 2103d41b2e65240605bfb1b457e54f2540ac281f Mon Sep 17 00:00:00 2001
From: Scott Rifenbark <srifenbark@gmail.com>
Date: Fri, 9 Nov 2018 12:30:33 -0800
Subject: 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>
---
 documentation/ref-manual/ref-variables.xml | 112 ++++++++++++++---------------
 1 file changed, 53 insertions(+), 59 deletions(-)

(limited to 'documentation')

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"
                     <literallayout class='monospaced'>
      INITRAMFS_NAME ?= "initramfs-${KERNEL_ARTIFACT_NAME}"
                     </literallayout>
-                    The value of the <filename>KERNEL_ARTIFACT_NAME</filename>
+                    The value of the
+                    <link linkend='var-KERNEL_ARTIFACT_NAME'><filename>KERNEL_ARTIFACT_NAME</filename></link>
                     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>
 
@@ -7464,6 +7455,45 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
             </glossdef>
         </glossentry>
 
+        <glossentry id='var-KERNEL_ARTIFACT_NAME'><glossterm>KERNEL_ARTIFACT_NAME</glossterm>
+            <info>
+                KERNEL_ARTIFACT_NAME[doc] = "Specifies the name of all of the build artifacts."
+            </info>
+            <glossdef>
+                <para role="glossdeffirst">
+<!--                <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
+                    Specifies the name of all of the build artifacts.
+                    You can change the name of the artifacts by changing the
+                    <filename>KERNEL_ARTIFACT_NAME</filename> variable.
+                </para>
+
+                <para>
+                    The value of <filename>KERNEL_ARTIFACT_NAME</filename>,
+                    which is set in the
+                    <filename> meta/classes/kernel-artifact-names.bbclass</filename>
+                    file, has the following default 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.
+                    <note>
+                        The <filename>IMAGE_VERSION_SUFFIX</filename> variable
+                        is set to
+                        <link linkend='var-DATETIME'><filename>DATETIME</filename></link>.
+                    </note>
+                </para>
+            </glossdef>
+        </glossentry>
+
         <glossentry id='var-KERNEL_CLASSES'><glossterm>KERNEL_CLASSES</glossterm>
             <info>
                 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"
                     <literallayout class='monospaced'>
      KERNEL_DTB_NAME ?= "${KERNEL_ARTIFACT_NAME}"
                     </literallayout>
-                    The value of the <filename>KERNEL_ARTIFACT_NAME</filename>
+                    The value of the
+                    <link linkend='var-KERNEL_ARTIFACT_NAME'><filename>KERNEL_ARTIFACT_NAME</filename></link>
                     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>
 
@@ -7685,23 +7706,14 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
                     <literallayout class='monospaced'>
      KERNEL_FIT_NAME ?= "${KERNEL_ARTIFACT_NAME}"
                     </literallayout>
-                    The value of the <filename>KERNEL_ARTIFACT_NAME</filename>
+                    The value of the
+                    <link linkend='var-KERNEL_ARTIFACT_NAME'><filename>KERNEL_ARTIFACT_NAME</filename></link>
                     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>
 
@@ -7780,23 +7792,14 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
                     <literallayout class='monospaced'>
      KERNEL_IMAGE_NAME ?= "${KERNEL_ARTIFACT_NAME}"
                     </literallayout>
-                    The value of the <filename>KERNEL_ARTIFACT_NAME</filename>
+                    The value of the
+                    <link linkend='var-KERNEL_ARTIFACT_NAME'><filename>KERNEL_ARTIFACT_NAME</filename></link>
                     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>
 
@@ -9231,12 +9234,12 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
 
         <glossentry id='var-MODULE_TARBALL_LINK_NAME'><glossterm>MODULE_TARBALL_LINK_NAME</glossterm>
             <info>
-                MODULE_TARBALL_LINK_NAME[doc] = "The link name of the module tarball."
+                MODULE_TARBALL_LINK_NAME[doc] = "The link name of the kernel module tarball."
             </info>
             <glossdef>
                 <para role="glossdeffirst">
 <!--                <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
-                    The link name of the module tarball.
+                    The link name of the kernel module tarball.
                     This variable is set in the
                     <filename>meta/classes/kernel-artifact-names.bbclass</filename>
                     file as follows:
@@ -9261,35 +9264,26 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
 
         <glossentry id='var-MODULE_TARBALL_NAME'><glossterm>MODULE_TARBALL_NAME</glossterm>
             <info>
-                MODULE_TARBALL_NAME[doc] = "The base name of the module tarball."
+                MODULE_TARBALL_NAME[doc] = "The base name of the kernel module tarball."
             </info>
             <glossdef>
                 <para role="glossdeffirst">
 <!--                <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
-                    The base name of the module tarball.
+                    The base name of the kernel module tarball.
                     This variable is set in the
                     <filename>meta/classes/kernel-artifact-names.bbclass</filename>
                     file as follows:
                     <literallayout class='monospaced'>
      MODULE_TARBALL_NAME ?= "${KERNEL_ARTIFACT_NAME}"
                     </literallayout>
-                    The value of the <filename>KERNEL_ARTIFACT_NAME</filename>
+                    The value of the
+                    <link linkend='var-KERNEL_ARTIFACT_NAME'><filename>KERNEL_ARTIFACT_NAME</filename></link>
                     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>
 
-- 
cgit v1.2.3-54-g00ecf