From 1d7983106c4f3e0f61d1a84e79cd5b08d4e2c052 Mon Sep 17 00:00:00 2001
From: Scott Rifenbark <srifenbark@gmail.com>
Date: Tue, 7 Jun 2016 15:28:26 -0700
Subject: ref-manual: Edits to UPSTREAM_CHECK_* variables.

Fixes [YOCTO #9671]

Applied some review comments to these three variables.
Edits to be sure to qualify that the variables only to recipes
who inherit the distrodata class.

(From yocto-docs rev: bb9a9866733e92d5c79bdc6b3b3c930468c0d616)

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

(limited to 'documentation')

diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml
index 385dd7f35d..996526924c 100644
--- a/documentation/ref-manual/ref-variables.xml
+++ b/documentation/ref-manual/ref-variables.xml
@@ -14312,55 +14312,64 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
             </glossdef>
         </glossentry>
 
-        <glossentry id='var-UPSTREAM_CHECK_GITTAGREGEX_pn'><glossterm>UPSTREAM_CHECK_GITTAGREGEX_pn</glossterm>
+        <glossentry id='var-UPSTREAM_CHECK_GITTAGREGEX'><glossterm>UPSTREAM_CHECK_GITTAGREGEX</glossterm>
             <info>
-               UPSTREAM_CHECK_GITTAGREGEX_pn[doc] = "Filters relevant Git tags when fetching source from an upstream Git repository."
+               UPSTREAM_CHECK_GITTAGREGEX[doc] = "Filters relevant Git tags when fetching source from an upstream Git repository."
             </info>
             <glossdef>
                 <para role="glossdeffirst">
 <!--                <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
-                    When the OpenEmbedded build system fetches source code
-                    from an upstream Git repository, the build system uses
-                    Git tags to determine which upstream release version to
-                    fetch.
+                    For recipes inheriting the
+                    <link linkend='ref-classes-distrodata'><filename>distrodata</filename></link>
+                    class, the <filename>UPSTREAM_CHECK_GITTAGREGEX</filename>
+                    variable causes the OpenEmbedded build system to use Git
+                    tabs to determine which upstream release version to
+                    fetch when fetching source code from an upstream Git
+                    repository.
                     You can use this regular expression to filter only
                     relevant tags:
                     <literallayout class='monospaced'>
-     UPSTREAM_CHECK_GITTAGREGEX_pn-<replaceable>recipe</replaceable> = "git_tag_regex"
+     UPSTREAM_CHECK_GITTAGREGEX-<replaceable>recipe</replaceable> = "git_tag_regex"
                     </literallayout>
                 </para>
             </glossdef>
         </glossentry>
 
-        <glossentry id='var-UPSTREAM_CHECK_REGEX_pn'><glossterm>UPSTREAM_CHECK_REGEX_pn</glossterm>
+        <glossentry id='var-UPSTREAM_CHECK_REGEX'><glossterm>UPSTREAM_CHECK_REGEX</glossterm>
             <info>
-               UPSTREAM_CHECK_REGEX_pn[doc] = "The regular expression the package checking system uses to parse the page pointed to by UPSTREAM_CHECK_URI_pn."
+               UPSTREAM_CHECK_REGEX[doc] = "The regular expression the package checking system uses to parse the page pointed to by UPSTREAM_CHECK_URI_pn."
             </info>
             <glossdef>
                 <para role="glossdeffirst">
 <!--                <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
-                    The regular expression used by the package checking system
-                    to parse the page found using
-                    <link linkend='var-UPSTREAM_CHECK_URI_pn'><filename>UPSTREAM_CHECK_URI_pn</filename></link>.
+                    For recipes inheriting 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
+                    <link linkend='var-UPSTREAM_CHECK_URI'><filename>UPSTREAM_CHECK_URI</filename></link>.
                     <literallayout class='monospaced'>
-     UPSTREAM_CHECK_REGEX_pn-<replaceable>recipe</replaceable> = "package_regex"
+     UPSTREAM_CHECK_REGEX-<replaceable>recipe</replaceable> = "package_regex"
                     </literallayout>
                 </para>
             </glossdef>
         </glossentry>
 
-        <glossentry id='var-UPSTREAM_CHECK_URI_pn'><glossterm>UPSTREAM_CHECK_URI_pn</glossterm>
+        <glossentry id='var-UPSTREAM_CHECK_URI'><glossterm>UPSTREAM_CHECK_URI</glossterm>
             <info>
-               UPSTREAM_CHECK_URI_pn[doc] = "The URL used by the package checking system to get the latest version of the package when source files are fetched from an upstream Git repository."
+               UPSTREAM_CHECK_URI[doc] = "The URL used by the package checking system to get the latest version of the package when source files are fetched from an upstream Git repository."
             </info>
             <glossdef>
                 <para role="glossdeffirst">
 <!--                <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
-                    The URL used by the package checking system to get the
+                    For recipes inheriting the
+                    <link linkend='ref-classes-distrodata'><filename>distrodata</filename></link>
+                    class, the <filename>UPSTREAM_CHECK_URI</filename>
+                    variable causes the package checking system to get the
                     latest version of the package when source files are
                     fetched from an upstream Git repository.
                     <literallayout class='monospaced'>
-     UPSTREAM_CHECK_URI_pn-<replaceable>recipe</replaceable> = "recipe_url"
+     UPSTREAM_CHECK_URI-<replaceable>recipe</replaceable> = "recipe_url"
                     </literallayout>
                 </para>
             </glossdef>
-- 
cgit v1.2.3-54-g00ecf