* 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
Signed-off-by: Paul Eggleton <paul.eggle...@linux.intel.com>
---
documentation/poky-ref-manual/ref-variables.xml | 49 +++++++++++++++--------
1 file changed, 32 insertions(+), 17 deletions(-)
diff --git a/documentation/poky-ref-manual/ref-variables.xml
b/documentation/poky-ref-manual/ref-variables.xml
index 531ee8a..5165bf1 100644
--- a/documentation/poky-ref-manual/ref-variables.xml
+++ b/documentation/poky-ref-manual/ref-variables.xml
@@ -61,7 +61,7 @@
conjunction with a package name override.
Here is an example:
<literallayout class='monospaced'>
- ALLOW_EMPTY_${PN}
+ ALLOW_EMPTY_${PN} = "1"
</literallayout>
</para>
</glossdef>
@@ -76,9 +76,13 @@
<glossentry id='var-AUTOREV'><glossterm>AUTOREV</glossterm>
<glossdef>
- <para>Specifies to use the current (newest) source revision.
- This variable is with the <filename><link
linkend='var-SRCREV'>SRCREV</link></filename>
- variable.</para>
+ <para>When <filename><link
linkend='var-SRCREV'>SRCREV</link></filename>
+ is set to the value of this variable, it specifies that
the latest
+ source revision in the repository should be used. Here is
an example:
+ <literallayout class='monospaced'>
+ SRCREV = "${AUTOREV}"
+ </literallayout>
+ </para>
</glossdef>
</glossentry>
@@ -1478,7 +1482,7 @@ recipes-graphics/xorg-font/xorg-font-common.inc:INC_PR =
"r2"
<glossentry id='var-PACKAGE_ARCH'><glossterm>PACKAGE_ARCH</glossterm>
<glossdef>
- <para>The architecture of the resulting package.</para>
+ <para>The architecture of the resulting package(s).</para>
</glossdef>
</glossentry>
@@ -1536,14 +1540,17 @@ recipes-graphics/xorg-font/xorg-font-common.inc:INC_PR
= "r2"
<glossentry id='var-PN'><glossterm>PN</glossterm>
<glossdef>
- <para>The name of the package.
+ <para>The name of the recipe. The name is normally extracted
from the recipe file name.
+ For example, if the recipe is named
+ <filename>expat_2.0.1.bb</filename>, then the default
value of <filename>PN</filename>
+ will be "expat".
</para>
</glossdef>
</glossentry>
<glossentry id='var-PR'><glossterm>PR</glossterm>
<glossdef>
- <para>The revision of the package.
+ <para>The revision of the recipe.
The default value for this variable is "r0".
</para>
</glossdef>
@@ -1551,13 +1558,13 @@ recipes-graphics/xorg-font/xorg-font-common.inc:INC_PR
= "r2"
<glossentry id='var-PV'><glossterm>PV</glossterm>
<glossdef>
- <para>The version of the package.
- The version is normally extracted from the recipe name.
+ <para>The version of the recipe.
+ The version is normally extracted from the recipe file
name.
For example, if the recipe is named
- <filename>expat_2.0.1.bb</filename>, then
<filename>PV</filename>
- will be <filename>2.0.1</filename>.
+ <filename>expat_2.0.1.bb</filename>, then the default
value of <filename>PV</filename>
+ will be "2.0.1".
<filename>PV</filename> is generally not overridden within
- a recipe unless it is building an unstable version from a
source code repository
+ a recipe unless it is building an unstable/development
version from a source code repository
(e.g. Git or Subversion).
</para>
</glossdef>
@@ -1566,7 +1573,7 @@ recipes-graphics/xorg-font/xorg-font-common.inc:INC_PR =
"r2"
<glossentry id='var-PE'><glossterm>PE</glossterm>
<glossdef>
<para>
- the epoch of the package.
+ the epoch of the recipe.
The default value is "0".
The field is used to make upgrades possible when the
versioning scheme changes in
some backwards incompatible way.
@@ -1581,7 +1588,7 @@ recipes-graphics/xorg-font/xorg-font-common.inc:INC_PR =
"r2"
determines which recipe should be given preference.
The variable must always be suffixed with the name of the
provided item, and should be set to the
- <filename>$PN</filename> of the recipe
+ <filename>PN</filename> of the recipe
to which you want to give precedence.
Here is an example:
<literallayout class='monospaced'>
@@ -1596,9 +1603,9 @@ recipes-graphics/xorg-font/xorg-font-common.inc:INC_PR =
"r2"
<para>
If there are multiple versions of recipes available, this
variable determines which recipe should be given
preference.
- The variable must always be suffixed with the
<filename>$PN</filename>
+ The variable must always be suffixed with the
<filename>PN</filename>
for which to select, and should be set to the
- <filename>$PV</filename> to which you want to give
precedence.
+ <filename>PV</filename> to which you want to give
precedence.
You can use the "<filename>%</filename>" character as a
wildcard
to match any number of characters, which can be useful
when
specifying versions that contain long revision number that
could
@@ -1621,9 +1628,17 @@ recipes-graphics/xorg-font/xorg-font-common.inc:INC_PR =
"r2"
<glossentry id='var-RCONFLICTS'><glossterm>RCONFLICTS</glossterm>
<glossdef>
- <para>The list of packages that conflict with this package.
+ <para>The list of packages that conflict with a package.
Note that the package will not be installed if the
conflicting packages are not
first removed.</para>
+ <para>
+ Like all package-controlling variables, you must always use
them in
+ conjunction with a package name override.
+ Here is an example:
+ <literallayout class='monospaced'>
+ RCONFLICTS_${PN} = "another-conflicting-package-name"
+ </literallayout>
+ </para>
</glossdef>
</glossentry>
--
1.7.9.5
_______________________________________________
yocto mailing list
yocto@yoctoproject.org
https://lists.yoctoproject.org/listinfo/yocto
