From 6b3b444c355a34e632d66fdc7828d97d8b5b8aaa Mon Sep 17 00:00:00 2001
From: Scott Rifenbark <srifenbark@gmail.com>
Date: Wed, 8 Jun 2016 10:53:31 -0700
Subject: ref-manual: Updated the UPSTREAM_CHECK_* variables.

Fixes [YOCTO #9671]

(From yocto-docs rev: 0f7e086e126d210cde0bd0cbe3e56d0808138e28)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
---
 documentation/ref-manual/ref-variables.xml | 44 +++++++++++++++++-------------
 1 file changed, 25 insertions(+), 19 deletions(-)

(limited to 'documentation')

diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml
index d5ff132e43..2d16019caa 100644
--- a/documentation/ref-manual/ref-variables.xml
+++ b/documentation/ref-manual/ref-variables.xml
@@ -14319,15 +14319,18 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
             <glossdef>
                 <para role="glossdeffirst">
 <!--                <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
-                    For recipes that use the
+                    When the
                     <link linkend='ref-classes-distrodata'><filename>distrodata</filename></link>
-                    class, this variable causes the OpenEmbedded build system
-                    to check for what the latest upstream version is by calling
-                    <filename>bitbake -c checkpkg</filename>.
-                    When source code is provided from Git repositories, the
-                    latest upstream version is determined by picking the latest
-                    tag from the list of all repository tags.
-                    You can use the <filename>UPSTREAM_CHECK_GITTAGREGEX</filename>
+                    class is enabled globally, you can perform a per-recipe
+                    check for what the latest upstream source code version is
+                    by calling
+                    <filename>bitbake -c checkpkg</filename> <replaceable>recipe</replaceable>.
+                    If the recipe source code is provided from Git
+                    repositories, the OpenEmbedded build system determines the
+                    latest upstream version by picking the latest tag from the
+                    list of all repository tags.
+                    You can use the
+                    <filename>UPSTREAM_CHECK_GITTAGREGEX</filename>
                     variable to provide a regular expression to filter only the
                     relevant tags should the default filter not work
                     correctly.
@@ -14345,11 +14348,13 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
             <glossdef>
                 <para role="glossdeffirst">
 <!--                <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
-                    For recipes that use the
+                    When the
                     <link linkend='ref-classes-distrodata'><filename>distrodata</filename></link>
-                    class, the <filename>UPSTREAM_CHECK_REGEX</filename>
-                    variable causes the package checking system to use the
-                    regular expression to parse the page found using
+                    class is enabled globally, use the
+                    <filename>UPSTREAM_CHECK_REGEX</filename> variable to
+                    specify a different regular expression instead of the
+                    default one when the package checking system is parsing
+                    the page found using
                     <link linkend='var-UPSTREAM_CHECK_URI'><filename>UPSTREAM_CHECK_URI</filename></link>.
                     <literallayout class='monospaced'>
      UPSTREAM_CHECK_REGEX = "package_regex"
@@ -14365,16 +14370,17 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
             <glossdef>
                 <para role="glossdeffirst">
 <!--                <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
-                    For recipes that use the
+                    When the
                     <link linkend='ref-classes-distrodata'><filename>distrodata</filename></link>
-                    class, this variable causes the OpenEmbedded build system
-                    to check for what the latest upstream version is by calling
-                    <filename>bitbake -c checkpkg</filename>.
-                    When the source code is provided from tarballs, the latest
+                    class is enabled globally, you can perform a per-recipe
+                    check for what the latest upstream source code version is
+                    by calling <filename>bitbake -c checkpkg</filename>
+                    <replaceable>recipe</replaceable>.
+                    If the source code is provided from tarballs, the latest
                     version is determined by fetching the directory listing
                     where the tarball is and attempting to find a later tarball.
-                    When this approach does not work,
-                    you can use <filename>UPSTREAM_CHECK_URI</filename> to
+                    When this approach does not work, you can use
+                    <filename>UPSTREAM_CHECK_URI</filename> to
                     provide a different URI that contains the link to the
                     latest tarball.
                     <literallayout class='monospaced'>
-- 
cgit 1.2.3-korg