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.

Signed-off-by: Paul Eggleton <paul.eggle...@linux.intel.com>
---
 documentation/poky-ref-manual/ref-variables.xml |   11 ++++++++++-
 1 file changed, 10 insertions(+), 1 deletion(-)

diff --git a/documentation/poky-ref-manual/ref-variables.xml 
b/documentation/poky-ref-manual/ref-variables.xml
index 0bb3094..ba81f96 100644
--- a/documentation/poky-ref-manual/ref-variables.xml
+++ b/documentation/poky-ref-manual/ref-variables.xml
@@ -448,7 +448,16 @@
 
         <glossentry id='var-DISTRO'><glossterm>DISTRO</glossterm>
             <glossdef>
-                <para>The short name of the distribution.</para>
+                <para>
+                    The short name of the distribution. This corresponds to a 
file with the
+                    extension .conf 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 blank, a set of default configuration will be used, 
which is specified
+                    within 
<filename>meta/conf/distro/defaultsetup.conf</filename>.
+                </para>
             </glossdef>
         </glossentry>
 
-- 
1.7.9.5

_______________________________________________
yocto mailing list
yocto@yoctoproject.org
https://lists.yoctoproject.org/listinfo/yocto

Reply via email to