ref-manual: Updated the DISTROOVERRIDES variable description.

Fixes [YOCTO #10176]

Provided a more complete description of this variable.

(From yocto-docs rev: 164bf11250c965aadd1ee1573267aa31daa8a4e8)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
Scott Rifenbark 2016-09-01 11:58:36 -07:00 committed by Richard Purdie
parent 2233924ee6
commit 3fa0f9d3ee
1 changed files with 18 additions and 10 deletions

View File

@ -3423,20 +3423,28 @@
<glossentry id='var-DISTROOVERRIDES'><glossterm>DISTROOVERRIDES</glossterm>
<info>
DISTROOVERRIDES[doc] = "Lists overrides specific to the current distribution. By default, the variable list includes the value of the DISTRO variable."
DISTROOVERRIDES[doc] = "A colon-separated list of overrides specific to the current distribution."
</info>
<glossdef>
<para role="glossdeffirst">
<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
This variable lists overrides specific to the current
distribution.
By default, the variable list includes the value of the
<filename><link linkend='var-DISTRO'>DISTRO</link></filename>
variable.
You can extend the variable to apply any variable overrides
you want as part of the distribution and are not
already in <filename>OVERRIDES</filename> through
some other means.
A colon-separated list of overrides specific to the
current distribution.
By default, this list includes the value of
<link linkend='var-DISTRO'><filename>DISTRO</filename></link>.
</para>
<para>
You can extend <filename>DISTROOVERRIDES</filename>
to add extra overrides that should apply to
the distribution.
</para>
<para>
The underlying mechanism behind
<filename>DISTROOVERRIDES</filename> is simply that it
is included in the default value of
<link linkend='var-OVERRIDES'><filename>OVERRIDES</filename></link>.
</para>
</glossdef>
</glossentry>