summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual/ref-variables.xml
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2015-02-13 08:54:56 -0800
committerRichard Purdie <richard.purdie@linuxfoundation.org>2015-02-17 15:17:03 +0000
commitf03c8374a9286f719f4978d145eefaf1beeca2bc (patch)
tree43851a2f01aaca0a687587be8ec6221ea113b5fb /documentation/ref-manual/ref-variables.xml
parent586992d24e3f0b8d0dfa194f7609fae0364ec390 (diff)
downloadpoky-f03c8374a9286f719f4978d145eefaf1beeca2bc.tar.gz
ref-manual: Updates to AUTOREV and SRCREV variable descriptions
Fixes [YOCTO #7306] Added an example for when the user tries to inherit the most recent version of software through use of the SRCREV variable. When using SRCREV = "${AUTOREV}" PV does not always get ${SRCPV}, which it need in order to fetch the latest software. I added a clarifying example to explain this situation. This commit also has a small change to fix a broken link to EXTERNAL_TOOLCHAIN. We do not documentat that variable so I removed the link. (From yocto-docs rev: 82f66a7193d0e40ffd65547223d4d9b10fdcf9bd) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/ref-manual/ref-variables.xml')
-rw-r--r--documentation/ref-manual/ref-variables.xml40
1 files changed, 33 insertions, 7 deletions
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml
index 971a89806d..582f528ca0 100644
--- a/documentation/ref-manual/ref-variables.xml
+++ b/documentation/ref-manual/ref-variables.xml
@@ -396,7 +396,9 @@
396 AUTOREV[doc] = "When SRCREV is set to the value of this variable, it specifies to use the latest source revision in the repository." 396 AUTOREV[doc] = "When SRCREV is set to the value of this variable, it specifies to use the latest source revision in the repository."
397 </info> 397 </info>
398 <glossdef> 398 <glossdef>
399 <para>When <filename><link linkend='var-SRCREV'>SRCREV</link></filename> 399 <para>
400 When
401 <filename><link linkend='var-SRCREV'>SRCREV</link></filename>
400 is set to the value of this variable, it specifies to use 402 is set to the value of this variable, it specifies to use
401 the latest source revision in the repository. 403 the latest source revision in the repository.
402 Here is an example: 404 Here is an example:
@@ -404,6 +406,21 @@
404 SRCREV = "${AUTOREV}" 406 SRCREV = "${AUTOREV}"
405 </literallayout> 407 </literallayout>
406 </para> 408 </para>
409
410 <para>
411 If you use the previous statement to inherit the latest
412 version of software, you need to be sure
413 <link linkend='var-PV'><filename>PV</filename></link>
414 contains
415 <filename>${</filename><link linkend='var-SRCPV'><filename>SRCPV</filename></link><filename>}</filename>.
416 For example, suppose you have a kernel recipe that needs
417 to inherit the latest kernel and you use the previous
418 statement.
419 In this example, <filename>${SRCPV}</filename> does not
420 get into <filename>PV</filename>.
421 Consequently, you need to change <filename>PV</filename>
422 so that it does contain <filename>${SRCPV}</filename>.
423 </para>
407 </glossdef> 424 </glossdef>
408 </glossentry> 425 </glossentry>
409 426
@@ -10035,13 +10052,22 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
10035 <glossdef> 10052 <glossdef>
10036 <para> 10053 <para>
10037 The revision of the source code used to build the package. 10054 The revision of the source code used to build the package.
10038 This variable applies to Subversion, Git, Mercurial and Bazaar 10055 This variable applies to Subversion, Git, Mercurial and
10039 only. 10056 Bazaar only.
10040 Note that if you wish to build a fixed revision and you wish 10057 Note that if you want to build a fixed revision and you
10041 to avoid performing a query on the remote repository every time 10058 want to avoid performing a query on the remote repository
10042 BitBake parses your recipe, you should specify a <filename>SRCREV</filename> that is a 10059 every time BitBake parses your recipe, you should specify
10060 a <filename>SRCREV</filename> that is a
10043 full revision identifier and not just a tag. 10061 full revision identifier and not just a tag.
10044 </para> 10062 </para>
10063
10064 <note>
10065 For information on limitations when inheriting the latest
10066 revision of software using <filename>SRCREV</filename>,
10067 see the
10068 <link linkend='var-AUTOREV'><filename>AUTOREV</filename></link>
10069 variable description.
10070 </note>
10045 </glossdef> 10071 </glossdef>
10046 </glossentry> 10072 </glossentry>
10047 10073
@@ -11165,7 +11191,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
11165 In summary, you must be sure to add the layer to your 11191 In summary, you must be sure to add the layer to your
11166 <filename>bblayers.conf</filename> file in front of the 11192 <filename>bblayers.conf</filename> file in front of the
11167 <filename>meta</filename> layer and then set the 11193 <filename>meta</filename> layer and then set the
11168 <link linkend='var-EXTERNAL_TOOLCHAIN'><filename>EXTERNAL_TOOLCHAIN</filename></link> 11194 <filename>EXTERNAL_TOOLCHAIN</filename>
11169 variable in your <filename>local.conf</filename> file 11195 variable in your <filename>local.conf</filename> file
11170 to the location in which you installed the toolchain. 11196 to the location in which you installed the toolchain.
11171 </para> 11197 </para>