summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2012-10-17 21:22:01 (GMT)
committerRichard Purdie <richard.purdie@linuxfoundation.org>2012-10-18 11:15:07 (GMT)
commited96f96db04126d1b1844d1890a73e80e7d14df6 (patch)
tree82797060ca9ab73b7c7ad312308c88b6af88c728 /documentation
parent26868e8050567fcf0e0296bdaf7a6b04aa37d44f (diff)
downloadpoky-ed96f96db04126d1b1844d1890a73e80e7d14df6.tar.gz
documentation: poky-ref-manual - edits to MACHINE type variables.
Did some editing that helps clarify variables that deal with the MACHINE. (From yocto-docs rev: f1f63acffc952cc7d755fc6dd555379572fddaf0) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
-rw-r--r--documentation/poky-ref-manual/ref-variables.xml99
1 files changed, 69 insertions, 30 deletions
diff --git a/documentation/poky-ref-manual/ref-variables.xml b/documentation/poky-ref-manual/ref-variables.xml
index eb4f2d4..50e3400 100644
--- a/documentation/poky-ref-manual/ref-variables.xml
+++ b/documentation/poky-ref-manual/ref-variables.xml
@@ -1415,11 +1415,42 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
1415 <glossentry id='var-MACHINE'><glossterm>MACHINE</glossterm> 1415 <glossentry id='var-MACHINE'><glossterm>MACHINE</glossterm>
1416 <glossdef> 1416 <glossdef>
1417 <para> 1417 <para>
1418 Specifies the target device. 1418 Specifies the target device for which the image is built.
1419 This variable corresponds to a file with the 1419 You define <filename>MACHINE</filename> in the
1420 extension <filename>.conf</filename> located in a 1420 <filename>local.conf</filename> file found in the
1421 <filename>conf/machine</filename> directory 1421 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>.
1422 within the metadata that contains the target device configuration. 1422 By default, <filename>MACHINE</filename> is set to
1423 "qemux86", which is a basic x86 architecture to be run on
1424 the emulator (QEMU):
1425 <literallayout class='monospaced'>
1426 MACHINE ?= "qemux86"
1427 </literallayout>
1428 The variable corresponds to a machine configuration file of the
1429 same name, through which machine-specific configurations are set.
1430 Thus, when <filename>MACHINE</filename> is set to "qemux86" there
1431 exists the corresponding <filename>qemux86.conf</filename> machine
1432 configuration file, which can be found in the
1433 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>
1434 in <filename>meta/conf/machine</filename>.
1435 </para>
1436
1437 <para>
1438 The possible settings for <filename>MACHINE</filename> that ship with
1439 the Yocto Project as defined in the <filename>local.conf</filename>
1440 include the following:
1441 <literallayout class='monospaced'>
1442 MACHINE ?= "qemuarm"
1443 MACHINE ?= "qemumips"
1444 MACHINE ?= "qemuppc"
1445 MACHINE ?= "qemux86"
1446 MACHINE ?= "qemux86-64"
1447 MACHINE ?= "atom-pc"
1448 MACHINE ?= "beagleboard"
1449 MACHINE ?= "mpc8315e-rdb"
1450 MACHINE ?= "routerstationpro"
1451 </literallayout>
1452 The last four are target machines for hardware boards used
1453 for demonstration.
1423 </para> 1454 </para>
1424 </glossdef> 1455 </glossdef>
1425 </glossentry> 1456 </glossentry>
@@ -1433,7 +1464,8 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
1433 The build process depends on these packages being present. 1464 The build process depends on these packages being present.
1434 Furthermore, because this is a "machine essential" variable, the list of 1465 Furthermore, because this is a "machine essential" variable, the list of
1435 packages are essential for the machine to boot. 1466 packages are essential for the machine to boot.
1436 The impact of this variable affects images based on <filename>packagegroup-core-boot</filename>, 1467 The impact of this variable affects images based on
1468 <filename>packagegroup-core-boot</filename>,
1437 including the <filename>core-image-minimal</filename> image. 1469 including the <filename>core-image-minimal</filename> image.
1438 </para> 1470 </para>
1439 <para> 1471 <para>
@@ -1444,11 +1476,10 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
1444 In other words, the image will not build if a file in this list is not found. 1476 In other words, the image will not build if a file in this list is not found.
1445 </para> 1477 </para>
1446 <para> 1478 <para>
1447 For example, suppose the machine for which you are building requires 1479 As an example, suppose the machine for which you are building requires
1448 a specific program to be run during boot to initialise the hardware. 1480 <filename>example-init</filename> to be run during boot to initialize the hardware.
1449 In this case, assuming the package name for the program was 1481 In this case, you would use the following in the machine's
1450 <filename>example-init</filename>, you would use the following in the 1482 <filename>.conf</filename> configuration file:
1451 <filename>.conf</filename> file for the machine:
1452 <literallayout class='monospaced'> 1483 <literallayout class='monospaced'>
1453 MACHINE_ESSENTIAL_EXTRA_RDEPENDS += "example-init" 1484 MACHINE_ESSENTIAL_EXTRA_RDEPENDS += "example-init"
1454 </literallayout> 1485 </literallayout>
@@ -1463,9 +1494,10 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
1463 A list of recommended machine-specific packages to install as part of 1494 A list of recommended machine-specific packages to install as part of
1464 the image being built. 1495 the image being built.
1465 The build process does not depend on these packages being present. 1496 The build process does not depend on these packages being present.
1466 Furthermore, because this is a "machine essential" variable, the list of 1497 However, because this is a "machine essential" variable, the list of
1467 packages are essential for the machine to boot. 1498 packages are essential for the machine to boot.
1468 The impact of this variable affects images based on <filename>packagegroup-core-boot</filename>, 1499 The impact of this variable affects images based on
1500 <filename>packagegroup-core-boot</filename>,
1469 including the <filename>core-image-minimal</filename> image. 1501 including the <filename>core-image-minimal</filename> image.
1470 </para> 1502 </para>
1471 <para> 1503 <para>
@@ -1480,16 +1512,18 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
1480 </para> 1512 </para>
1481 <para> 1513 <para>
1482 Consider an example where you have a custom kernel where a specific touchscreen 1514 Consider an example where you have a custom kernel where a specific touchscreen
1483 driver is required for the machine to be usable, but may be built as a module or 1515 driver is required for the machine to be usable.
1516 However, the driver can be built as a module or
1484 into the kernel depending on the kernel configuration. 1517 into the kernel depending on the kernel configuration.
1485 If the driver is built as a module, you want it to be installed. 1518 If the driver is built as a module, you want it to be installed.
1486 However if 1519 But, when the driver is built into the kernel, you still want the
1487 the driver is built into the kernel you still want the build to succeed. 1520 build to succeed.
1488 This variable sets up a "recommends" relationship so that in the latter case, 1521 This variable sets up a "recommends" relationship so that in the latter case,
1489 the build will not fail due to the missing package. 1522 the build will not fail due to the missing package.
1490 To accomplish this, assuming the package for the module was called 1523 To accomplish this, assuming the package for the module was called
1491 <filename>kernel-module-ab123</filename>, you would use the 1524 <filename>kernel-module-ab123</filename>, you would use the
1492 following in the <filename>.conf</filename> file for the machine: 1525 following in the machine's <filename>.conf</filename> configuration
1526 file:
1493 <literallayout class='monospaced'> 1527 <literallayout class='monospaced'>
1494 MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS += "kernel-module-ab123" 1528 MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS += "kernel-module-ab123"
1495 </literallayout> 1529 </literallayout>
@@ -1504,16 +1538,19 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
1504 <glossentry id='var-MACHINE_EXTRA_RDEPENDS'><glossterm>MACHINE_EXTRA_RDEPENDS</glossterm> 1538 <glossentry id='var-MACHINE_EXTRA_RDEPENDS'><glossterm>MACHINE_EXTRA_RDEPENDS</glossterm>
1505 <glossdef> 1539 <glossdef>
1506 <para> 1540 <para>
1507 A list of machine-specific packages that are not essential for booting to install as 1541 A list of machine-specific packages to install as part of the
1508 part of the image being built. 1542 image being built that are not essential for the machine to boot.
1509 The build process for more fully-featured images depends on them being present. 1543 However, the build process for more fully-featured images
1510 The impact of this variable affects all images based on 1544 depends on the packages being present.
1545 </para>
1546 <para>
1547 This variable affects all images based on
1511 <filename>packagegroup-base</filename>, which does not include the 1548 <filename>packagegroup-base</filename>, which does not include the
1512 <filename>core-image-minimal</filename> or <filename>core-image-basic</filename> 1549 <filename>core-image-minimal</filename> or <filename>core-image-basic</filename>
1513 images. 1550 images.
1514 </para> 1551 </para>
1515 <para> 1552 <para>
1516 This variable is similar to the 1553 The variable is similar to the
1517 <filename><link linkend='var-MACHINE_EXTRA_RRECOMMENDS'>MACHINE_EXTRA_RRECOMMENDS</link></filename> 1554 <filename><link linkend='var-MACHINE_EXTRA_RRECOMMENDS'>MACHINE_EXTRA_RRECOMMENDS</link></filename>
1518 variable with the exception that the image being built has a build 1555 variable with the exception that the image being built has a build
1519 dependency on the variable's list of packages. 1556 dependency on the variable's list of packages.
@@ -1541,11 +1578,12 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
1541 <glossdef> 1578 <glossdef>
1542 <para></para> 1579 <para></para>
1543 <para> 1580 <para>
1544 A list of machine-specific packages that are not essential for booting 1581 A list of machine-specific packages to install as part of the
1545 to install as part of the image being built, if present. 1582 image being built that are not essential for booting the machine.
1546 The image being built has no build dependency on the list of packages 1583 The image being built has no build dependency on this list of packages.
1547 with this variable. 1584 </para>
1548 The impact of this variable affects only images based on 1585 <para>
1586 This variable affects only images based on
1549 <filename>packagegroup-base</filename>, which does not include the 1587 <filename>packagegroup-base</filename>, which does not include the
1550 <filename>core-image-minimal</filename> or <filename>core-image-basic</filename> 1588 <filename>core-image-minimal</filename> or <filename>core-image-basic</filename>
1551 images. 1589 images.
@@ -1577,9 +1615,10 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
1577 1615
1578 <glossentry id='var-MACHINE_FEATURES'><glossterm>MACHINE_FEATURES</glossterm> 1616 <glossentry id='var-MACHINE_FEATURES'><glossterm>MACHINE_FEATURES</glossterm>
1579 <glossdef> 1617 <glossdef>
1580 <para>Specifies the list of device features. 1618 <para>Specifies the list of hardware features the
1581 See the "<link linkend='ref-features-machine'>Machine</link>" section for 1619 <link linkend='var-MACHINE'>MACHINE</link> supports.
1582 more information.</para> 1620 For a list of valid features you can provide, see the
1621 "<link linkend='ref-features-machine'>Machine</link>" section.</para>
1583 </glossdef> 1622 </glossdef>
1584 </glossentry> 1623 </glossentry>
1585 1624