From: Scott Rifenbark <srifenbark@gmail.com>
Date: Tue, 7 Jun 2016 18:02:12 +0000 (-0700)
Subject: ref-manual: Added descriptions for three UPSTREAM* variables.
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=c735ade9981936e535452a0f59a5e127198790ac;p=thirdparty%2Fopenembedded%2Fopenembedded-core-contrib.git

ref-manual: Added descriptions for three UPSTREAM* variables.

Fixes [YOCTO #9671]

Put in descriptions for the following variables:

 * UPSTREAM_CHECK_GITTAGREGEX_pn
 * UPSTREAM_CHECK_URI_pn
 * UPSTREAM_CHECK_URI_pn

(From yocto-docs rev: e00470cbf98714236f3197dd538371488d8f03fb)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
---

diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml
index e29f359af10..385dd7f35d4 100644
--- a/documentation/ref-manual/ref-variables.xml
+++ b/documentation/ref-manual/ref-variables.xml
@@ -14312,6 +14312,60 @@ 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>
+            <info>
+               UPSTREAM_CHECK_GITTAGREGEX_pn[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.
+                    You can use this regular expression to filter only
+                    relevant tags:
+                    <literallayout class='monospaced'>
+     UPSTREAM_CHECK_GITTAGREGEX_pn-<replaceable>recipe</replaceable> = "git_tag_regex"
+                    </literallayout>
+                </para>
+            </glossdef>
+        </glossentry>
+
+        <glossentry id='var-UPSTREAM_CHECK_REGEX_pn'><glossterm>UPSTREAM_CHECK_REGEX_pn</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."
+            </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>.
+                    <literallayout class='monospaced'>
+     UPSTREAM_CHECK_REGEX_pn-<replaceable>recipe</replaceable> = "package_regex"
+                    </literallayout>
+                </para>
+            </glossdef>
+        </glossentry>
+
+        <glossentry id='var-UPSTREAM_CHECK_URI_pn'><glossterm>UPSTREAM_CHECK_URI_pn</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."
+            </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
+                    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"
+                    </literallayout>
+                </para>
+            </glossdef>
+        </glossentry>
+
         <glossentry id='var-USE_DEVFS'><glossterm>USE_DEVFS</glossterm>
             <info>
                USE_DEVFS[doc] = "Determines if devtmpfs is used for /dev population."