summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorPaul Eggleton <paul.eggleton@linux.intel.com>2012-09-05 11:32:48 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2012-09-14 09:50:48 +0100
commit532aff1df2ba9c92f6c7a1b0f40c29bf521605cb (patch)
treee6a460fcdcfb3821322126bd2e6b4106deb41bf4
parent97fc511b0182a2e0206f2f05706c08fdbede0a3d (diff)
downloadpoky-532aff1df2ba9c92f6c7a1b0f40c29bf521605cb.tar.gz
documentation/poky-ref-manual/ref-variables.xml: variable edits
* For PE/PV/PR/PN these pertain to a recipe ("package" was used here historically). * References to variables should not be prefixed with $ in the text * Add text about suffixing RCONFLICTS as per other package variables * Make ALLOW_EMPTY example complete * Clarify and add example for AUTOREV In addition to Paul's patch, I re-worded two instances. One to get rid of "package(s)", which is poor form. And a second to get rid of "unstable/development", which is also poor form. (From yocto-docs rev: 498349f8d82f46433626521d148ff6c1d72e2b1c) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
-rw-r--r--documentation/poky-ref-manual/ref-variables.xml49
1 files changed, 32 insertions, 17 deletions
diff --git a/documentation/poky-ref-manual/ref-variables.xml b/documentation/poky-ref-manual/ref-variables.xml
index a804757006..16d91e0cef 100644
--- a/documentation/poky-ref-manual/ref-variables.xml
+++ b/documentation/poky-ref-manual/ref-variables.xml
@@ -61,7 +61,7 @@
61 conjunction with a package name override. 61 conjunction with a package name override.
62 Here is an example: 62 Here is an example:
63 <literallayout class='monospaced'> 63 <literallayout class='monospaced'>
64 ALLOW_EMPTY_${PN} 64 ALLOW_EMPTY_${PN} = "1"
65 </literallayout> 65 </literallayout>
66 </para> 66 </para>
67 </glossdef> 67 </glossdef>
@@ -76,9 +76,13 @@
76 76
77 <glossentry id='var-AUTOREV'><glossterm>AUTOREV</glossterm> 77 <glossentry id='var-AUTOREV'><glossterm>AUTOREV</glossterm>
78 <glossdef> 78 <glossdef>
79 <para>Specifies to use the current (newest) source revision. 79 <para>When <filename><link linkend='var-SRCREV'>SRCREV</link></filename>
80 This variable is with the <filename><link linkend='var-SRCREV'>SRCREV</link></filename> 80 is set to the value of this variable, it specifies that the latest
81 variable.</para> 81 source revision in the repository should be used. Here is an example:
82 <literallayout class='monospaced'>
83 SRCREV = "${AUTOREV}"
84 </literallayout>
85 </para>
82 </glossdef> 86 </glossdef>
83 </glossentry> 87 </glossentry>
84 88
@@ -1478,7 +1482,7 @@ recipes-graphics/xorg-font/xorg-font-common.inc:INC_PR = "r2"
1478 1482
1479 <glossentry id='var-PACKAGE_ARCH'><glossterm>PACKAGE_ARCH</glossterm> 1483 <glossentry id='var-PACKAGE_ARCH'><glossterm>PACKAGE_ARCH</glossterm>
1480 <glossdef> 1484 <glossdef>
1481 <para>The architecture of the resulting package.</para> 1485 <para>The architecture of the resulting package or packages.</para>
1482 </glossdef> 1486 </glossdef>
1483 </glossentry> 1487 </glossentry>
1484 1488
@@ -1541,14 +1545,17 @@ recipes-graphics/xorg-font/xorg-font-common.inc:INC_PR = "r2"
1541 1545
1542 <glossentry id='var-PN'><glossterm>PN</glossterm> 1546 <glossentry id='var-PN'><glossterm>PN</glossterm>
1543 <glossdef> 1547 <glossdef>
1544 <para>The name of the package. 1548 <para>The name of the recipe. The name is normally extracted from the recipe file name.
1549 For example, if the recipe is named
1550 <filename>expat_2.0.1.bb</filename>, then the default value of <filename>PN</filename>
1551 will be "expat".
1545 </para> 1552 </para>
1546 </glossdef> 1553 </glossdef>
1547 </glossentry> 1554 </glossentry>
1548 1555
1549 <glossentry id='var-PR'><glossterm>PR</glossterm> 1556 <glossentry id='var-PR'><glossterm>PR</glossterm>
1550 <glossdef> 1557 <glossdef>
1551 <para>The revision of the package. 1558 <para>The revision of the recipe.
1552 The default value for this variable is "r0". 1559 The default value for this variable is "r0".
1553 </para> 1560 </para>
1554 </glossdef> 1561 </glossdef>
@@ -1556,13 +1563,13 @@ recipes-graphics/xorg-font/xorg-font-common.inc:INC_PR = "r2"
1556 1563
1557 <glossentry id='var-PV'><glossterm>PV</glossterm> 1564 <glossentry id='var-PV'><glossterm>PV</glossterm>
1558 <glossdef> 1565 <glossdef>
1559 <para>The version of the package. 1566 <para>The version of the recipe.
1560 The version is normally extracted from the recipe name. 1567 The version is normally extracted from the recipe filename.
1561 For example, if the recipe is named 1568 For example, if the recipe is named
1562 <filename>expat_2.0.1.bb</filename>, then <filename>PV</filename> 1569 <filename>expat_2.0.1.bb</filename>, then the default value of <filename>PV</filename>
1563 will be <filename>2.0.1</filename>. 1570 will be "2.0.1".
1564 <filename>PV</filename> is generally not overridden within 1571 <filename>PV</filename> is generally not overridden within
1565 a recipe unless it is building an unstable version from a source code repository 1572 a recipe unless it is building an unstable (i.e. development) version from a source code repository
1566 (e.g. Git or Subversion). 1573 (e.g. Git or Subversion).
1567 </para> 1574 </para>
1568 </glossdef> 1575 </glossdef>
@@ -1571,7 +1578,7 @@ recipes-graphics/xorg-font/xorg-font-common.inc:INC_PR = "r2"
1571 <glossentry id='var-PE'><glossterm>PE</glossterm> 1578 <glossentry id='var-PE'><glossterm>PE</glossterm>
1572 <glossdef> 1579 <glossdef>
1573 <para> 1580 <para>
1574 the epoch of the package. 1581 the epoch of the recipe.
1575 The default value is "0". 1582 The default value is "0".
1576 The field is used to make upgrades possible when the versioning scheme changes in 1583 The field is used to make upgrades possible when the versioning scheme changes in
1577 some backwards incompatible way. 1584 some backwards incompatible way.
@@ -1586,7 +1593,7 @@ recipes-graphics/xorg-font/xorg-font-common.inc:INC_PR = "r2"
1586 determines which recipe should be given preference. 1593 determines which recipe should be given preference.
1587 The variable must always be suffixed with the name of the 1594 The variable must always be suffixed with the name of the
1588 provided item, and should be set to the 1595 provided item, and should be set to the
1589 <filename>$PN</filename> of the recipe 1596 <filename>PN</filename> of the recipe
1590 to which you want to give precedence. 1597 to which you want to give precedence.
1591 Here is an example: 1598 Here is an example:
1592 <literallayout class='monospaced'> 1599 <literallayout class='monospaced'>
@@ -1601,9 +1608,9 @@ recipes-graphics/xorg-font/xorg-font-common.inc:INC_PR = "r2"
1601 <para> 1608 <para>
1602 If there are multiple versions of recipes available, this 1609 If there are multiple versions of recipes available, this
1603 variable determines which recipe should be given preference. 1610 variable determines which recipe should be given preference.
1604 The variable must always be suffixed with the <filename>$PN</filename> 1611 The variable must always be suffixed with the <filename>PN</filename>
1605 for which to select, and should be set to the 1612 for which to select, and should be set to the
1606 <filename>$PV</filename> to which you want to give precedence. 1613 <filename>PV</filename> to which you want to give precedence.
1607 You can use the "<filename>%</filename>" character as a wildcard 1614 You can use the "<filename>%</filename>" character as a wildcard
1608 to match any number of characters, which can be useful when 1615 to match any number of characters, which can be useful when
1609 specifying versions that contain long revision number that could 1616 specifying versions that contain long revision number that could
@@ -1626,9 +1633,17 @@ recipes-graphics/xorg-font/xorg-font-common.inc:INC_PR = "r2"
1626 1633
1627 <glossentry id='var-RCONFLICTS'><glossterm>RCONFLICTS</glossterm> 1634 <glossentry id='var-RCONFLICTS'><glossterm>RCONFLICTS</glossterm>
1628 <glossdef> 1635 <glossdef>
1629 <para>The list of packages that conflict with this package. 1636 <para>The list of packages that conflict with a package.
1630 Note that the package will not be installed if the conflicting packages are not 1637 Note that the package will not be installed if the conflicting packages are not
1631 first removed.</para> 1638 first removed.</para>
1639 <para>
1640 Like all package-controlling variables, you must always use them in
1641 conjunction with a package name override.
1642 Here is an example:
1643 <literallayout class='monospaced'>
1644 RCONFLICTS_${PN} = "another-conflicting-package-name"
1645 </literallayout>
1646 </para>
1632 </glossdef> 1647 </glossdef>
1633 </glossentry> 1648 </glossentry>
1634 1649