ref-manual: Updated the DISTRO variable description.

This needed some work to be more descriptive.

(From yocto-docs rev: 00acc5f28a87c10572f1df4bf801c16f5b861f8e)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
Scott Rifenbark 2013-11-21 16:01:42 -08:00 committed by Richard Purdie
parent 2ae9f689a1
commit 859980e7db
1 changed files with 32 additions and 10 deletions

View File

@ -1277,18 +1277,40 @@
<glossdef>
<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
This variable corresponds to a distribution
configuration file whose root name is the same as the
variable's argument and whose filename extension is
<filename>.conf</filename>.
For example, the distribution configuration file for the
Poky distribution is named <filename>poky.conf</filename>
and resides in the
<filename>meta-yocto/conf/distro</filename> directory of
the
<ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>.
</para>
<para>
Within that <filename>poky.conf</filename> file, the
<filename>DISTRO</filename> variable is set as follows:
<literallayout class='monospaced'>
DISTRO = "poky"
</literallayout>
</para>
<para>
Distribution configuration files are located in a
<filename>conf/distro</filename> directory within the
<ulink url='&YOCTO_DOCS_DEV_URL;#metadata'>Metadata</ulink>
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>.
The value for <filename>DISTRO</filename> must not contain
spaces, and is typically all lower-case.
<note>
If the <filename>DISTRO</filename> variable is blank, a set
of default configurations are used, which are specified
within
<filename>meta/conf/distro/defaultsetup.conf</filename>
also in the Source Directory.
</note>
</para>
</glossdef>
</glossentry>