ref-manual: New COREBASE variable entry added to glossary.

Fixes [YOCTO #4981]

(From yocto-docs rev: a3623887a3cfd3df47a09b8fd337a2741b5aaa42)

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

diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml
index f7217a4c0e825c61c01acc087656f27fd4483933..d285b16174b5dac28bf9f358c06d41bb23095c70 100644 (file)
--- a/documentation/ref-manual/ref-variables.xml
+++ b/documentation/ref-manual/ref-variables.xml
@@ -707,6 +707,28 @@ Core layer for images cannot be removed
             </glossdef>
         </glossentry>
 
+        <glossentry id='var-COREBASE'><glossterm>COREBASE</glossterm>
+            <glossdef>
+                <para>
+                    Specifies the parent directory of the OpenEmbedded
+                    Core Metadata layer (i.e. <filename>/meta</filename>).
+                </para>
+
+                <para>
+                    It is an important distinction that
+                    <filename>COREBASE</filename> points to the parent of this
+                    layer and not the layer itself.
+                    Consider an example where you have cloned the Poky Git
+                    repository and retained the <filename>poky</filename>
+                    name for your local copy of the repository.
+                    In this case, <filename>COREBASE</filename> points to
+                    the <filename>poky</filename> folder because it is the
+                    parent directory of the <filename>poky/meta</filename>
+                    layer.
+                </para>
+            </glossdef>
+        </glossentry>
+
     </glossdiv>
 
     <glossdiv id='var-glossary-d'><title>D</title>