summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--documentation/ref-manual/ref-variables.xml42
1 files changed, 32 insertions, 10 deletions
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml
index 55f135683d..3499b78a20 100644
--- a/documentation/ref-manual/ref-variables.xml
+++ b/documentation/ref-manual/ref-variables.xml
@@ -1277,18 +1277,40 @@
1277 <glossdef> 1277 <glossdef>
1278 <para> 1278 <para>
1279 The short name of the distribution. 1279 The short name of the distribution.
1280 This variable corresponds to a file with the 1280 This variable corresponds to a distribution
1281 extension <filename>.conf</filename> 1281 configuration file whose root name is the same as the
1282 located in a <filename>conf/distro</filename> directory 1282 variable's argument and whose filename extension is
1283 within the 1283 <filename>.conf</filename>.
1284 <ulink url='&YOCTO_DOCS_DEV_URL;#metadata'>Metadata</ulink> 1284 For example, the distribution configuration file for the
1285 that contains the distribution configuration. 1285 Poky distribution is named <filename>poky.conf</filename>
1286 The value must not contain spaces, and is typically all lower-case. 1286 and resides in the
1287 <filename>meta-yocto/conf/distro</filename> directory of
1288 the
1289 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>.
1290 </para>
1291
1292 <para>
1293 Within that <filename>poky.conf</filename> file, the
1294 <filename>DISTRO</filename> variable is set as follows:
1295 <literallayout class='monospaced'>
1296 DISTRO = "poky"
1297 </literallayout>
1287 </para> 1298 </para>
1299
1288 <para> 1300 <para>
1289 If the variable is blank, a set of default configuration 1301 Distribution configuration files are located in a
1290 will be used, which is specified 1302 <filename>conf/distro</filename> directory within the
1291 within <filename>meta/conf/distro/defaultsetup.conf</filename>. 1303 <ulink url='&YOCTO_DOCS_DEV_URL;#metadata'>Metadata</ulink>
1304 that contains the distribution configuration.
1305 The value for <filename>DISTRO</filename> must not contain
1306 spaces, and is typically all lower-case.
1307 <note>
1308 If the <filename>DISTRO</filename> variable is blank, a set
1309 of default configurations are used, which are specified
1310 within
1311 <filename>meta/conf/distro/defaultsetup.conf</filename>
1312 also in the Source Directory.
1313 </note>
1292 </para> 1314 </para>
1293 </glossdef> 1315 </glossdef>
1294 </glossentry> 1316 </glossentry>