summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorScott Rifenbark <srifenbark@gmail.com>2016-06-08 08:34:14 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2016-06-21 12:59:07 +0100
commitf33db8b6eb983e639a82d62aad4d235c61caca96 (patch)
tree66b39713eedf1560911929c7b41c051049856c3e /documentation
parent508e8908c20f65b797c93895cec44b496380fcd9 (diff)
downloadpoky-f33db8b6eb983e639a82d62aad4d235c61caca96.tar.gz
ref-manual: Updates to the UPSTREAM_CHECK_* variables
I applied some grammar edits and re-wordings as directed by technical reviews. Fixes [YOCTO #9671] (From yocto-docs rev: b5a5d3d3b311cb83ed61bfd247fbf802027fe5c4) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
-rw-r--r--documentation/ref-manual/ref-variables.xml47
1 files changed, 28 insertions, 19 deletions
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml
index 996526924c..d5ff132e43 100644
--- a/documentation/ref-manual/ref-variables.xml
+++ b/documentation/ref-manual/ref-variables.xml
@@ -14319,17 +14319,20 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
14319 <glossdef> 14319 <glossdef>
14320 <para role="glossdeffirst"> 14320 <para role="glossdeffirst">
14321<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> 14321<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
14322 For recipes inheriting the 14322 For recipes that use the
14323 <link linkend='ref-classes-distrodata'><filename>distrodata</filename></link> 14323 <link linkend='ref-classes-distrodata'><filename>distrodata</filename></link>
14324 class, the <filename>UPSTREAM_CHECK_GITTAGREGEX</filename> 14324 class, this variable causes the OpenEmbedded build system
14325 variable causes the OpenEmbedded build system to use Git 14325 to check for what the latest upstream version is by calling
14326 tabs to determine which upstream release version to 14326 <filename>bitbake -c checkpkg</filename>.
14327 fetch when fetching source code from an upstream Git 14327 When source code is provided from Git repositories, the
14328 repository. 14328 latest upstream version is determined by picking the latest
14329 You can use this regular expression to filter only 14329 tag from the list of all repository tags.
14330 relevant tags: 14330 You can use the <filename>UPSTREAM_CHECK_GITTAGREGEX</filename>
14331 variable to provide a regular expression to filter only the
14332 relevant tags should the default filter not work
14333 correctly.
14331 <literallayout class='monospaced'> 14334 <literallayout class='monospaced'>
14332 UPSTREAM_CHECK_GITTAGREGEX-<replaceable>recipe</replaceable> = "git_tag_regex" 14335 UPSTREAM_CHECK_GITTAGREGEX = "git_tag_regex"
14333 </literallayout> 14336 </literallayout>
14334 </para> 14337 </para>
14335 </glossdef> 14338 </glossdef>
@@ -14337,19 +14340,19 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
14337 14340
14338 <glossentry id='var-UPSTREAM_CHECK_REGEX'><glossterm>UPSTREAM_CHECK_REGEX</glossterm> 14341 <glossentry id='var-UPSTREAM_CHECK_REGEX'><glossterm>UPSTREAM_CHECK_REGEX</glossterm>
14339 <info> 14342 <info>
14340 UPSTREAM_CHECK_REGEX[doc] = "The regular expression the package checking system uses to parse the page pointed to by UPSTREAM_CHECK_URI_pn." 14343 UPSTREAM_CHECK_REGEX[doc] = "The regular expression the package checking system uses to parse the page pointed to by UPSTREAM_CHECK_URI."
14341 </info> 14344 </info>
14342 <glossdef> 14345 <glossdef>
14343 <para role="glossdeffirst"> 14346 <para role="glossdeffirst">
14344<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> 14347<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
14345 For recipes inheriting the 14348 For recipes that use the
14346 <link linkend='ref-classes-distrodata'><filename>distrodata</filename></link> 14349 <link linkend='ref-classes-distrodata'><filename>distrodata</filename></link>
14347 class, the <filename>UPSTREAM_CHECK_REGEX</filename> 14350 class, the <filename>UPSTREAM_CHECK_REGEX</filename>
14348 variable causes the package checking system to use the 14351 variable causes the package checking system to use the
14349 regular expression to parse the page found using 14352 regular expression to parse the page found using
14350 <link linkend='var-UPSTREAM_CHECK_URI'><filename>UPSTREAM_CHECK_URI</filename></link>. 14353 <link linkend='var-UPSTREAM_CHECK_URI'><filename>UPSTREAM_CHECK_URI</filename></link>.
14351 <literallayout class='monospaced'> 14354 <literallayout class='monospaced'>
14352 UPSTREAM_CHECK_REGEX-<replaceable>recipe</replaceable> = "package_regex" 14355 UPSTREAM_CHECK_REGEX = "package_regex"
14353 </literallayout> 14356 </literallayout>
14354 </para> 14357 </para>
14355 </glossdef> 14358 </glossdef>
@@ -14362,14 +14365,20 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
14362 <glossdef> 14365 <glossdef>
14363 <para role="glossdeffirst"> 14366 <para role="glossdeffirst">
14364<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> 14367<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
14365 For recipes inheriting the 14368 For recipes that use the
14366 <link linkend='ref-classes-distrodata'><filename>distrodata</filename></link> 14369 <link linkend='ref-classes-distrodata'><filename>distrodata</filename></link>
14367 class, the <filename>UPSTREAM_CHECK_URI</filename> 14370 class, this variable causes the OpenEmbedded build system
14368 variable causes the package checking system to get the 14371 to check for what the latest upstream version is by calling
14369 latest version of the package when source files are 14372 <filename>bitbake -c checkpkg</filename>.
14370 fetched from an upstream Git repository. 14373 When the source code is provided from tarballs, the latest
14371 <literallayout class='monospaced'> 14374 version is determined by fetching the directory listing
14372 UPSTREAM_CHECK_URI-<replaceable>recipe</replaceable> = "recipe_url" 14375 where the tarball is and attempting to find a later tarball.
14376 When this approach does not work,
14377 you can use <filename>UPSTREAM_CHECK_URI</filename> to
14378 provide a different URI that contains the link to the
14379 latest tarball.
14380 <literallayout class='monospaced'>
14381 UPSTREAM_CHECK_URI = "recipe_url"
14373 </literallayout> 14382 </literallayout>
14374 </para> 14383 </para>
14375 </glossdef> 14384 </glossdef>