summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorScott Rifenbark <srifenbark@gmail.com>2018-07-13 12:06:08 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2018-08-15 10:28:12 +0100
commitc90bfdf5d4620839fe086d5014e9ebf60589da32 (patch)
tree3ef80f9a09241eab0ee0df4e6437aea66090a395 /documentation
parent84178b1fd5905e144dc48acbec803871793ef957 (diff)
downloadpoky-c90bfdf5d4620839fe086d5014e9ebf60589da32.tar.gz
ref-manual: Updated DISTRO_NAME variable description.
I provided some real detail on this variable. It was woefully brief. (From yocto-docs rev: 6b40243984b7cc69a291b6f90ed04b45b7ce3ac5) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
-rw-r--r--documentation/ref-manual/ref-variables.xml40
1 files changed, 40 insertions, 0 deletions
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml
index 708cd900d0..62ceacf7b3 100644
--- a/documentation/ref-manual/ref-variables.xml
+++ b/documentation/ref-manual/ref-variables.xml
@@ -3938,6 +3938,46 @@
3938 <para role="glossdeffirst"> 3938 <para role="glossdeffirst">
3939<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> 3939<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
3940 The long name of the distribution. 3940 The long name of the distribution.
3941 For information on the short name of the distribution, see
3942 the
3943 <link linkend='var-DISTRO'><filename>DISTRO</filename></link>
3944 variable.
3945 </para>
3946
3947 <para>
3948 The <filename>DISTRO_NAME</filename> variable corresponds
3949 to a distribution configuration file whose root name is the
3950 same as the variable's argument and whose filename
3951 extension is <filename>.conf</filename>.
3952 For example, the distribution configuration file for the
3953 Poky distribution is named <filename>poky.conf</filename>
3954 and resides in the
3955 <filename>meta-poky/conf/distro</filename> directory of
3956 the
3957 <link linkend='source-directory'>Source Directory</link>.
3958 </para>
3959
3960 <para>
3961 Within that <filename>poky.conf</filename> file, the
3962 <filename>DISTRO_NAME</filename> variable is set as
3963 follows:
3964 <literallayout class='monospaced'>
3965 DISTRO_NAME = "Poky (Yocto Project Reference Distro)"
3966 </literallayout>
3967 </para>
3968
3969 <para>
3970 Distribution configuration files are located in a
3971 <filename>conf/distro</filename> directory within the
3972 <link linkend='metadata'>Metadata</link>
3973 that contains the distribution configuration.
3974 <note>
3975 If the <filename>DISTRO_NAME</filename> variable is
3976 blank, a set of default configurations are used, which
3977 are specified within
3978 <filename>meta/conf/distro/defaultsetup.conf</filename>
3979 also in the Source Directory.
3980 </note>
3941 </para> 3981 </para>
3942 </glossdef> 3982 </glossdef>
3943 </glossentry> 3983 </glossentry>