ref-manual: Added the ownmirrors class and the SOURCE_MIRROR_URL variable.

(From yocto-docs rev: 8979676949e1c32ff71835b8d506e176a7b5c941)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
Scott Rifenbark 2013-12-03 10:03:46 -06:00 committed by Richard Purdie
parent 9a38035b4e
commit 267c0a39cc
2 changed files with 53 additions and 0 deletions

View File

@ -1243,6 +1243,32 @@
</para>
</section>
<section id='ref-classes-ownmirrors'>
<title><filename>ownmirrors.bbclass</filename></title>
<para>
The own mirrors (<filename>ownmirrors</filename>) class makes it
easier to set up your own
<link linkend='var-PREMIRRORS'><filename>PREMIRRORS</filename></link>
from which to first fetch source before attempting to fetch it from the
upstream specified in
<link linkend='var-SRC_URI'><filename>SRC_URI</filename></link>
within each recipe.
</para>
<para>
To use this class, inherit it globally and specify
<link linkend='var-SOURCE_MIRROR_URL'><filename>SOURCE_MIRROR_URL</filename></link>.
Here is an example:
<literallayout class='monospaced'>
INHERIT += "own-mirrors"
SOURCE_MIRROR_URL = "http://example.com/my-source-mirror"
</literallayout>
You can specify only a single URL in
<filename>SOURCE_MIRROR_URL</filename>.
</para>
</section>
<section id='ref-classes-pkgconfig'>
<title>Pkg-config - <filename>pkgconfig.bbclass</filename></title>

View File

@ -5664,6 +5664,33 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
</glossdef>
</glossentry>
<glossentry id='var-SOURCE_MIRROR_URL'><glossterm>SOURCE_MIRROR_URL</glossterm>
<glossdef>
<para>
Defines your own
<link linkend='var-PREMIRRORS'><filename>PREMIRRORS</filename></link>
from which to first fetch source before attempting to fetch
from the upstream specified in
<link linkend='var-SRC_URI'><filename>SRC_URI</filename></link>.
</para>
<para>
To use this variable, you must globally inherit the
<link linkend='ref-classes-ownmirrors'><filename>ownmirrors</filename></link>
class and then provide the URL to your mirrors.
Here is an example:
<literallayout class='monospaced'>
INHERIT += "own-mirrors"
SOURCE_MIRROR_URL = "http://example.com/my-source-mirror"
</literallayout>
<note>
You can specify only a single URL in
<filename>SOURCE_MIRROR_URL</filename>.
</note>
</para>
</glossdef>
</glossentry>
<glossentry id='var-SPECIAL_PKGSUFFIX'><glossterm>SPECIAL_PKGSUFFIX</glossterm>
<glossdef>
<para>