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: 1b094b0567fa75d1c77da7ec04641d034f29272d)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
Scott Rifenbark 2016-06-07 15:28:26 -07:00 committed by Richard Purdie
parent c735ade998
commit cd7f787174
1 changed files with 26 additions and 17 deletions

View File

@ -14312,55 +14312,64 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
</glossdef> </glossdef>
</glossentry> </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> <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> </info>
<glossdef> <glossdef>
<para role="glossdeffirst"> <para role="glossdeffirst">
<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
When the OpenEmbedded build system fetches source code For recipes inheriting the
from an upstream Git repository, the build system uses <link linkend='ref-classes-distrodata'><filename>distrodata</filename></link>
Git tags to determine which upstream release version to class, the <filename>UPSTREAM_CHECK_GITTAGREGEX</filename>
fetch. 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 You can use this regular expression to filter only
relevant tags: relevant tags:
<literallayout class='monospaced'> <literallayout class='monospaced'>
UPSTREAM_CHECK_GITTAGREGEX_pn-<replaceable>recipe</replaceable> = "git_tag_regex" UPSTREAM_CHECK_GITTAGREGEX-<replaceable>recipe</replaceable> = "git_tag_regex"
</literallayout> </literallayout>
</para> </para>
</glossdef> </glossdef>
</glossentry> </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> <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> </info>
<glossdef> <glossdef>
<para role="glossdeffirst"> <para role="glossdeffirst">
<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
The regular expression used by the package checking system For recipes inheriting the
to parse the page found using <link linkend='ref-classes-distrodata'><filename>distrodata</filename></link>
<link linkend='var-UPSTREAM_CHECK_URI_pn'><filename>UPSTREAM_CHECK_URI_pn</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'> <literallayout class='monospaced'>
UPSTREAM_CHECK_REGEX_pn-<replaceable>recipe</replaceable> = "package_regex" UPSTREAM_CHECK_REGEX-<replaceable>recipe</replaceable> = "package_regex"
</literallayout> </literallayout>
</para> </para>
</glossdef> </glossdef>
</glossentry> </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> <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> </info>
<glossdef> <glossdef>
<para role="glossdeffirst"> <para role="glossdeffirst">
<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> <!-- <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 latest version of the package when source files are
fetched from an upstream Git repository. fetched from an upstream Git repository.
<literallayout class='monospaced'> <literallayout class='monospaced'>
UPSTREAM_CHECK_URI_pn-<replaceable>recipe</replaceable> = "recipe_url" UPSTREAM_CHECK_URI-<replaceable>recipe</replaceable> = "recipe_url"
</literallayout> </literallayout>
</para> </para>
</glossdef> </glossdef>