summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2014-03-11 12:57:14 -0600
committerRichard Purdie <richard.purdie@linuxfoundation.org>2014-03-25 12:29:38 +0000
commit708dd324e9fcb5c1d545a2ff9fd5deff9ca5303f (patch)
treeee855e0a7d3aeed240294802d9ee4caa8b56cf26
parent2f643ad571d11cd25521fef79a51798387ad1ebf (diff)
downloadpoky-708dd324e9fcb5c1d545a2ff9fd5deff9ca5303f.tar.gz
ref-manual: New variables added and some edits as well
Fixes [YOCTO #5931] Added descriptions for the following variables in the glossary: * MODULE_IMAGE_BASE_NAME * KERNEL_IMAGE_BASE_NAME * PKGE * PKGV * PKGR * PKG The first two are for the bug. The remainder needed to be added as they were referenced from the first two (except for PKG, which I was told needed to be added anyway. I also fixed a couple formatting issues in there for some other variables. (From yocto-docs rev: c488b57a2ae5a5d1ef4b0da0ecaa9589c3106a45) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
-rw-r--r--documentation/ref-manual/ref-variables.xml105
1 files changed, 101 insertions, 4 deletions
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml
index 9420050f06..033661af1c 100644
--- a/documentation/ref-manual/ref-variables.xml
+++ b/documentation/ref-manual/ref-variables.xml
@@ -3652,6 +3652,29 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
3652 </glossdef> 3652 </glossdef>
3653 </glossentry> 3653 </glossentry>
3654 3654
3655 <glossentry id='var-KERNEL_IMAGE_BASE_NAME'><glossterm>KERNEL_IMAGE_BASE_NAME</glossterm>
3656 <glossdef>
3657 <para>
3658 The base name of the kernel image.
3659 This variable is set in the
3660 <link linkend='ref-classes-kernel'>kernel</link> class
3661 as follows:
3662 <literallayout class='monospaced'>
3663 KERNEL_IMAGE_BASE_NAME ?= "${KERNEL_IMAGETYPE}-${PKGE}-${PKGV}-${PKGR}-${MACHINE}-${DATETIME}"
3664 </literallayout>
3665 See the
3666 <link linkend='var-KERNEL_IMAGETYPE'><filename>KERNEL_IMAGETYPE</filename></link>,
3667 <link linkend='var-PKGE'><filename>PKGE</filename></link>,
3668 <link linkend='var-PKGV'><filename>PKGV</filename></link>,
3669 <link linkend='var-PKGR'><filename>PKGR</filename></link>,
3670 <link linkend='var-MACHINE'><filename>MACHINE</filename></link>,
3671 and
3672 <link linkend='var-DATETIME'><filename>DATETIME</filename></link>
3673 variables for additional information.
3674 </para>
3675 </glossdef>
3676 </glossentry>
3677
3655 <glossentry id='var-KERNEL_IMAGETYPE'><glossterm>KERNEL_IMAGETYPE</glossterm> 3678 <glossentry id='var-KERNEL_IMAGETYPE'><glossterm>KERNEL_IMAGETYPE</glossterm>
3656 <glossdef> 3679 <glossdef>
3657 <para>The type of kernel to build for a device, usually set by the 3680 <para>The type of kernel to build for a device, usually set by the
@@ -4438,6 +4461,28 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
4438 </glossdef> 4461 </glossdef>
4439 </glossentry> 4462 </glossentry>
4440 4463
4464 <glossentry id='var-MODULE_IMAGE_BASE_NAME'><glossterm>MODULE_IMAGE_BASE_NAME</glossterm>
4465 <glossdef>
4466 <para>
4467 The base name of the kernel modules tarball.
4468 This variable is set in the
4469 <link linkend='ref-classes-kernel'>kernel</link> class
4470 as follows:
4471 <literallayout class='monospaced'>
4472 MODULE_IMAGE_BASE_NAME ?= "modules-${PKGE}-${PKGV}-${PKGR}-${MACHINE}-${DATETIME}"
4473 </literallayout>
4474 See the
4475 <link linkend='var-PKGE'><filename>PKGE</filename></link>,
4476 <link linkend='var-PKGV'><filename>PKGV</filename></link>,
4477 <link linkend='var-PKGR'><filename>PKGR</filename></link>,
4478 <link linkend='var-MACHINE'><filename>MACHINE</filename></link>,
4479 and
4480 <link linkend='var-DATETIME'><filename>DATETIME</filename></link>
4481 variables for additional information.
4482 </para>
4483 </glossdef>
4484 </glossentry>
4485
4441 <glossentry id='var-MODULE_TARBALL_DEPLOY'><glossterm>MODULE_TARBALL_DEPLOY</glossterm> 4486 <glossentry id='var-MODULE_TARBALL_DEPLOY'><glossterm>MODULE_TARBALL_DEPLOY</glossterm>
4442 <glossdef> 4487 <glossdef>
4443 <para> 4488 <para>
@@ -5145,9 +5190,9 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
5145 <glossentry id='var-PE'><glossterm>PE</glossterm> 5190 <glossentry id='var-PE'><glossterm>PE</glossterm>
5146 <glossdef> 5191 <glossdef>
5147 <para> 5192 <para>
5148 the epoch of the recipe. 5193 The epoch of the recipe.
5149 By default, this variable is unset. 5194 By default, this variable is unset.
5150 The field is used to make upgrades possible when the 5195 The variable is used to make upgrades possible when the
5151 versioning scheme changes in some backwards incompatible 5196 versioning scheme changes in some backwards incompatible
5152 way. 5197 way.
5153 </para> 5198 </para>
@@ -5183,6 +5228,23 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
5183 </glossdef> 5228 </glossdef>
5184 </glossentry> 5229 </glossentry>
5185 5230
5231 <glossentry id='var-PKG'><glossterm>PKG</glossterm>
5232 <glossdef>
5233 <para>
5234 The name of the resulting package created by the
5235 OpenEmbedded build system.
5236 <note>
5237 When using the <filename>PKG</filename> variable, you
5238 must use a package name override.
5239 </note>
5240 For example, when the
5241 <link linkend='ref-classes-debian'><filename>debian</filename></link>
5242 class renames the output package, it does so by setting
5243 <filename>PKG_&lt;packagename&gt;</filename>.
5244 </para>
5245 </glossdef>
5246 </glossentry>
5247
5186 <glossentry id='var-PKGD'><glossterm>PKGD</glossterm> 5248 <glossentry id='var-PKGD'><glossterm>PKGD</glossterm>
5187 <glossdef> 5249 <glossdef>
5188 <para> 5250 <para>
@@ -5255,6 +5317,39 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
5255 </glossdef> 5317 </glossdef>
5256 </glossentry> 5318 </glossentry>
5257 5319
5320 <glossentry id='var-PKGE'><glossterm>PKGE</glossterm>
5321 <glossdef>
5322 <para>
5323 The epoch of the output package built by the
5324 OpenEmbedded build system.
5325 By default, <filename>PKGE</filename> is set to
5326 <link linkend='var-PE'><filename>PE</filename></link>.
5327 </para>
5328 </glossdef>
5329 </glossentry>
5330
5331 <glossentry id='var-PKGR'><glossterm>PKGR</glossterm>
5332 <glossdef>
5333 <para>
5334 The revision of the output package built by the
5335 OpenEmbedded build system.
5336 By default, <filename>PKGR</filename> is set to
5337 <link linkend='var-PR'><filename>PR</filename></link>.
5338 </para>
5339 </glossdef>
5340 </glossentry>
5341
5342 <glossentry id='var-PKGV'><glossterm>PKGV</glossterm>
5343 <glossdef>
5344 <para>
5345 The version of the output package built by the
5346 OpenEmbedded build system.
5347 By default, <filename>PKGV</filename> is set to
5348 <link linkend='var-PV'><filename>PV</filename></link>.
5349 </para>
5350 </glossdef>
5351 </glossentry>
5352
5258 <glossentry id='var-PN'><glossterm>PN</glossterm> 5353 <glossentry id='var-PN'><glossterm>PN</glossterm>
5259 <glossdef> 5354 <glossdef>
5260 <para>This variable can have two separate functions depending on the context: a recipe 5355 <para>This variable can have two separate functions depending on the context: a recipe
@@ -5305,7 +5400,8 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
5305 5400
5306 <glossentry id='var-PR'><glossterm>PR</glossterm> 5401 <glossentry id='var-PR'><glossterm>PR</glossterm>
5307 <glossdef> 5402 <glossdef>
5308 <para>The revision of the recipe. 5403 <para>
5404 The revision of the recipe.
5309 The default value for this variable is "r0". 5405 The default value for this variable is "r0".
5310 </para> 5406 </para>
5311 </glossdef> 5407 </glossdef>
@@ -5464,7 +5560,8 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
5464 5560
5465 <glossentry id='var-PV'><glossterm>PV</glossterm> 5561 <glossentry id='var-PV'><glossterm>PV</glossterm>
5466 <glossdef> 5562 <glossdef>
5467 <para>The version of the recipe. 5563 <para>
5564 The version of the recipe.
5468 The version is normally extracted from the recipe filename. 5565 The version is normally extracted from the recipe filename.
5469 For example, if the recipe is named 5566 For example, if the recipe is named
5470 <filename>expat_2.0.1.bb</filename>, then the default value of <filename>PV</filename> 5567 <filename>expat_2.0.1.bb</filename>, then the default value of <filename>PV</filename>