From f10615345ecec03c8d045292952a9f7ebaaada43 Mon Sep 17 00:00:00 2001
From: Paul Eggleton <paul.eggleton@linux.intel.com>
Date: Wed, 10 Oct 2012 14:27:44 -0700
Subject: documentation: poky-ref-manual - DISTRO description extended.

Extend the description of the DISTRO variable so that it mentions that
this points to a .conf file under conf/distro and mentions what happens
if the value is left blank.

(From yocto-docs rev: 50f8f0394d8d849e0a227d6c9ffcdc3cccb7e307)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
---
 documentation/poky-ref-manual/ref-variables.xml | 15 ++++++++++++++-
 1 file changed, 14 insertions(+), 1 deletion(-)

(limited to 'documentation')

diff --git a/documentation/poky-ref-manual/ref-variables.xml b/documentation/poky-ref-manual/ref-variables.xml
index 7d60758226..2baed3788c 100644
--- a/documentation/poky-ref-manual/ref-variables.xml
+++ b/documentation/poky-ref-manual/ref-variables.xml
@@ -456,7 +456,20 @@
 
         <glossentry id='var-DISTRO'><glossterm>DISTRO</glossterm>
             <glossdef>
-                <para>The short name of the distribution.</para>
+                <para>
+                    The short name of the distribution. 
+                    This variable corresponds to a file with the
+                    extension <filename>.conf</filename>
+                    located in a <filename>conf/distro</filename> directory
+                    within the metadata that contains the distribution configuration. 
+                    The
+                    value must not contain spaces, and is typically all lower-case.
+                </para>
+                <para>
+                    If the variable is blank, a set of default configuration
+                    will be used, which is specified
+                    within <filename>meta/conf/distro/defaultsetup.conf</filename>.
+                </para>
             </glossdef>
         </glossentry>
 
-- 
cgit v1.2.3-54-g00ecf