ref-manual: Added BUILDHISTORY_DIR_IMAGE to glossary.

(From yocto-docs rev: 2665537abc2db910596e8979fca367d1c8ab2931)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>

1 files changed, 24 insertions, 0 deletions

diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml
index 4e78c3e7f3..c9fc58f7eb 100644
--- a/documentation/ref-manual/ref-variables.xml
+++ b/documentation/ref-manual/ref-variables.xml
@@ -917,6 +917,30 @@
             </glossdef>
         </glossentry>
 
+        <glossentry id='var-BUILDHISTORY_DIR_IMAGE'><glossterm>BUILDHISTORY_DIR_IMAGE</glossterm>
+            <glossdef>
+                <para>
+                    When inheriting the
+                    <link linkend='ref-classes-buildhistory'><filename>buildhistory</filename></link>
+                    class, specifies the base name of the image analyzed using
+                    build history feature.
+                    For more information on how the variable works, see the
+                    <filename>buildhistory.class</filename>.
+                    For more information on how build history works, see the
+                    "<link linkend='maintaining-build-output-quality'>Maintaining Build Output Quality</link>"
+                    section.
+                </para>
+
+                <para>
+                    By default, the <filename>buildhistory</filename> class
+                    sets the image name as follows:
+                    <literallayout class='monospaced'>
+     BUILDHISTORY_DIR_IMAGE = "${BUILDHISTORY_DIR}/images/${MACHINE_ARCH}/${TCLIBC}/${IMAGE_BASENAME}"
+                    </literallayout>
+                </para>
+            </glossdef>
+        </glossentry>
+
         <glossentry id='var-BUILDHISTORY_FEATURES'><glossterm>BUILDHISTORY_FEATURES</glossterm>
             <glossdef>
                 <para>