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:
parent
2ae9f689a1
commit
859980e7db
|
@ -1277,18 +1277,40 @@
|
||||||
<glossdef>
|
<glossdef>
|
||||||
<para>
|
<para>
|
||||||
The short name of the distribution.
|
The short name of the distribution.
|
||||||
This variable corresponds to a file with the
|
This variable corresponds to a distribution
|
||||||
extension <filename>.conf</filename>
|
configuration file whose root name is the same as the
|
||||||
located in a <filename>conf/distro</filename> directory
|
variable's argument and whose filename extension is
|
||||||
within the
|
<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>
|
<ulink url='&YOCTO_DOCS_DEV_URL;#metadata'>Metadata</ulink>
|
||||||
that contains the distribution configuration.
|
that contains the distribution configuration.
|
||||||
The value must not contain spaces, and is typically all lower-case.
|
The value for <filename>DISTRO</filename> must not contain
|
||||||
</para>
|
spaces, and is typically all lower-case.
|
||||||
<para>
|
<note>
|
||||||
If the variable is blank, a set of default configuration
|
If the <filename>DISTRO</filename> variable is blank, a set
|
||||||
will be used, which is specified
|
of default configurations are used, which are specified
|
||||||
within <filename>meta/conf/distro/defaultsetup.conf</filename>.
|
within
|
||||||
|
<filename>meta/conf/distro/defaultsetup.conf</filename>
|
||||||
|
also in the Source Directory.
|
||||||
|
</note>
|
||||||
</para>
|
</para>
|
||||||
</glossdef>
|
</glossdef>
|
||||||
</glossentry>
|
</glossentry>
|
||||||
|
|
Loading…
Reference in New Issue