handbook: document the LAYERDIR variable

LAYERDIR is one of the few variables which requires immediate expansion and is
worth documenting explicitly.

Signed-off-by: Joshua Lock <josh@linux.intel.com>

1 files changed, 9 insertions, 0 deletions

diff --git a/handbook/ref-variables.xml b/handbook/ref-variables.xml
index 7bbcdb81f0..e4523bfdc1 100644
--- a/handbook/ref-variables.xml
+++ b/handbook/ref-variables.xml
@@ -403,6 +403,15 @@
 
     <glossdiv id='var-glossary-l'><title>L</title>
 
+        <glossentry id='var-LAYERDIR'><glossterm>LAYERDIR</glossterm>
+            <glossdef>
+                <para>When used inside a layer.conf gives the path of the
+                current layer. This variable requires immediate expansion
+                (see the Bitbake manual) as lazy expansion can result in
+                the expansion happening in the wrong directory and therefore
+                giving the wrong value.</para>
+            </glossdef>
+        </glossentry>
         <glossentry id='var-LICENSE'><glossterm>LICENSE</glossterm>
             <glossdef>
                 <para>List of package source licenses.</para>