From 532aff1df2ba9c92f6c7a1b0f40c29bf521605cb Mon Sep 17 00:00:00 2001 From: Paul Eggleton Date: Wed, 5 Sep 2012 11:32:48 -0700 Subject: 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 Signed-off-by: Richard Purdie --- documentation/poky-ref-manual/ref-variables.xml | 49 ++++++++++++++++--------- 1 file changed, 32 insertions(+), 17 deletions(-) (limited to 'documentation') 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 @@ conjunction with a package name override. Here is an example: - ALLOW_EMPTY_${PN} + ALLOW_EMPTY_${PN} = "1" @@ -76,9 +76,13 @@ AUTOREV - Specifies to use the current (newest) source revision. - This variable is with the SRCREV - variable. + When SRCREV + 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: + + SRCREV = "${AUTOREV}" + + @@ -1478,7 +1482,7 @@ recipes-graphics/xorg-font/xorg-font-common.inc:INC_PR = "r2" PACKAGE_ARCH - The architecture of the resulting package. + The architecture of the resulting package or packages. @@ -1541,14 +1545,17 @@ recipes-graphics/xorg-font/xorg-font-common.inc:INC_PR = "r2" PN - The name of the package. + The name of the recipe. The name is normally extracted from the recipe file name. + For example, if the recipe is named + expat_2.0.1.bb, then the default value of PN + will be "expat". PR - The revision of the package. + The revision of the recipe. The default value for this variable is "r0". @@ -1556,13 +1563,13 @@ recipes-graphics/xorg-font/xorg-font-common.inc:INC_PR = "r2" PV - The version of the package. - The version is normally extracted from the recipe name. + The version of the recipe. + The version is normally extracted from the recipe filename. For example, if the recipe is named - expat_2.0.1.bb, then PV - will be 2.0.1. + expat_2.0.1.bb, then the default value of PV + will be "2.0.1". PV 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 (i.e. development) version from a source code repository (e.g. Git or Subversion). @@ -1571,7 +1578,7 @@ recipes-graphics/xorg-font/xorg-font-common.inc:INC_PR = "r2" PE - 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. @@ -1586,7 +1593,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 - $PN of the recipe + PN of the recipe to which you want to give precedence. Here is an example: @@ -1601,9 +1608,9 @@ recipes-graphics/xorg-font/xorg-font-common.inc:INC_PR = "r2" 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 $PN + The variable must always be suffixed with the PN for which to select, and should be set to the - $PV to which you want to give precedence. + PV to which you want to give precedence. You can use the "%" character as a wildcard to match any number of characters, which can be useful when specifying versions that contain long revision number that could @@ -1626,9 +1633,17 @@ recipes-graphics/xorg-font/xorg-font-common.inc:INC_PR = "r2" RCONFLICTS - The list of packages that conflict with this package. + 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. + + Like all package-controlling variables, you must always use them in + conjunction with a package name override. + Here is an example: + + RCONFLICTS_${PN} = "another-conflicting-package-name" + + -- cgit v1.2.3-54-g00ecf