ref-manual: Added three PACKAGE_FEED_* variable descriptions

Fixes [YOCOT #8301] Added descriptions for PACKAGE_FEED_ARCHS, PACKAGE_FEED_BASE_PATHS, and PACKAGE_FEED_URIS variables. The build system uses these three variables to construct a set of final package feed URIs. (From yocto-docs rev: 53447af460932caa5b2b7637894657eb9fd2e84d) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
author: Scott Rifenbark <srifenbark@gmail.com> 2015-10-06 10:18:05 -0700
committer: Richard Purdie <richard.purdie@linuxfoundation.org> 2015-10-21 23:06:34 +0100
commit: 359b7fb639d5fa11baba0b3257b7e410d34d4d4b (patch)
tree: 5aa68796772f49920331228a8b8130e889217d09 /documentation/ref-manual
parent: 2f4e90c6a3dca7b5f239223e28474276ce451c4c (diff)
download: poky-359b7fb639d5fa11baba0b3257b7e410d34d4d4b.tar.gz
1 files changed, 138 insertions, 0 deletions
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml
index 0bc7a82b48..538936b43e 100644
--- a/documentation/ref-manual/ref-variables.xml
+++ b/documentation/ref-manual/ref-variables.xml
@@ -8537,6 +8537,144 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
            </glossdef>
        </glossentry>
+        <glossentry id='var-PACKAGE_FEED_ARCHS'><glossterm>PACKAGE_FEED_ARCHS</glossterm>
+            <info>
+                PACKAGE_FEED_ARCHS[doc] = "Specifies user-defined package architectures when constructing package feed URIs."
+            </info>
+            <glossdef>
+                <para role="glossdeffirst">
+<!--                <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
+                    Specifies the package architectures used as part of the
+                    package feed URIs during the build.
+                    The <filename>PACKAGE_FEED_ARCHS</filename> variable is
+                    appended to the final package feed URI, which is constructed
+                    using the
+                    <link linkend='var-PACKAGE_FEED_URIS'><filename>PACKAGE_FEED_URIS</filename></link>
+                    and
+                    <link linkend='var-PACKAGE_FEED_BASE_PATHS'><filename>PACKAGE_FEED_BASE_PATHS</filename></link>
+                    variables.
+                </para>
+                <para>
+                    Consider the following example where the
+                    <filename>PACKAGE_FEED_URIS</filename>,
+                    <filename>PACKAGE_FEED_BASE_PATHS</filename>, and
+                    <filename>PACKAGE_FEED_ARCHS</filename> variables are
+                    defined in your <filename>local.conf</filename> file:
+                    <literallayout class='monospaced'>
+     PACKAGE_FEED_URIS = "https://example.com/packagerepos/release \
+                          https://example.com/packagerepos/updates"
+     PACKAGE_FEED_BASE_PATHS = "rpm rpm-dev"
+     PACKAGE_FEED_ARCHS = "all core2-64"
+                    </literallayout>
+                    Given these settings, the resulting package feeds are
+                    as follows:
+                    <literallayout class='monospaced'>
+     https://example.com/packagerepos/release/rpm/all
+     https://example.com/packagerepos/release/rpm/core2-64
+     https://example.com/packagerepos/release/rpm-dev/all
+     https://example.com/packagerepos/release/rpm-dev/core2-64
+     https://example.com/packagerepos/updates/rpm/all
+     https://example.com/packagerepos/updates/rpm/core2-64
+     https://example.com/packagerepos/updates/rpm-dev/all
+     https://example.com/packagerepos/updates/rpm-dev/core2-64
+                    </literallayout>
+                </para>
+            </glossdef>
+        </glossentry>
+        <glossentry id='var-PACKAGE_FEED_BASE_PATHS'><glossterm>PACKAGE_FEED_BASE_PATHS</glossterm>
+            <info>
+                PACKAGE_FEED_BASE_PATHS[doc] = "Specifies base path used when constructing package feed URIs."
+            </info>
+            <glossdef>
+                <para role="glossdeffirst">
+<!--                <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
+                    Specifies the base path used when constructing package feed
+                    URIs.
+                    The <filename>PACKAGE_FEED_BASE_PATHS</filename> variable
+                    makes up the middle portion of a package feed URI used
+                    by the OpenEmbedded build system.
+                    The base path lies between the
+                    <link linkend='var-PACKAGE_FEED_URIS'><filename>PACKAGE_FEED_URIS</filename></link>
+                    and
+                    <link linkend='var-PACKAGE_FEED_ARCHS'><filename>PACKAGE_FEED_ARCHS</filename></link>
+                    variables.
+                </para>
+                <para>
+                    Consider the following example where the
+                    <filename>PACKAGE_FEED_URIS</filename>,
+                    <filename>PACKAGE_FEED_BASE_PATHS</filename>, and
+                    <filename>PACKAGE_FEED_ARCHS</filename> variables are
+                    defined in your <filename>local.conf</filename> file:
+                    <literallayout class='monospaced'>
+     PACKAGE_FEED_URIS = "https://example.com/packagerepos/release \
+                          https://example.com/packagerepos/updates"
+     PACKAGE_FEED_BASE_PATHS = "rpm rpm-dev"
+     PACKAGE_FEED_ARCHS = "all core2-64"
+                    </literallayout>
+                    Given these settings, the resulting package feeds are
+                    as follows:
+                    <literallayout class='monospaced'>
+     https://example.com/packagerepos/release/rpm/all
+     https://example.com/packagerepos/release/rpm/core2-64
+     https://example.com/packagerepos/release/rpm-dev/all
+     https://example.com/packagerepos/release/rpm-dev/core2-64
+     https://example.com/packagerepos/updates/rpm/all
+     https://example.com/packagerepos/updates/rpm/core2-64
+     https://example.com/packagerepos/updates/rpm-dev/all
+     https://example.com/packagerepos/updates/rpm-dev/core2-64
+                    </literallayout>
+                </para>
+            </glossdef>
+        </glossentry>
+        <glossentry id='var-PACKAGE_FEED_URIS'><glossterm>PACKAGE_FEED_URIS</glossterm>
+            <info>
+                PACKAGE_FEED_URIS[doc] = "Specifies the front portion of the package feed URI used by the OpenEmbedded build system."
+            </info>
+            <glossdef>
+                <para role="glossdeffirst">
+<!--                <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
+                    Specifies the front portion of the package feed URI
+                    used by the OpenEmbedded build system.
+                    Each final package feed URI is comprised of
+                    <filename>PACKAGE_FEED_URIS</filename>,
+                    <link linkend='var-PACKAGE_FEED_BASE_PATHS'><filename>PACKAGE_FEED_BASE_PATHS</filename></link>,
+                    and
+                    <link linkend='var-PACKAGE_FEED_ARCHS'><filename>PACKAGE_FEED_ARCHS</filename></link>
+                    variables.
+                </para>
+                <para>
+                    Consider the following example where the
+                    <filename>PACKAGE_FEED_URIS</filename>,
+                    <filename>PACKAGE_FEED_BASE_PATHS</filename>, and
+                    <filename>PACKAGE_FEED_ARCHS</filename> variables are
+                    defined in your <filename>local.conf</filename> file:
+                    <literallayout class='monospaced'>
+     PACKAGE_FEED_URIS = "https://example.com/packagerepos/release \
+                          https://example.com/packagerepos/updates"
+     PACKAGE_FEED_BASE_PATHS = "rpm rpm-dev"
+     PACKAGE_FEED_ARCHS = "all core2-64"
+                    </literallayout>
+                    Given these settings, the resulting package feeds are
+                    as follows:
+                    <literallayout class='monospaced'>
+     https://example.com/packagerepos/release/rpm/all
+     https://example.com/packagerepos/release/rpm/core2-64
+     https://example.com/packagerepos/release/rpm-dev/all
+     https://example.com/packagerepos/release/rpm-dev/core2-64
+     https://example.com/packagerepos/updates/rpm/all
+     https://example.com/packagerepos/updates/rpm/core2-64
+     https://example.com/packagerepos/updates/rpm-dev/all
+     https://example.com/packagerepos/updates/rpm-dev/core2-64
+                    </literallayout>
+                </para>
+            </glossdef>
+        </glossentry>
        <glossentry id='var-PACKAGE_GROUP'><glossterm>PACKAGE_GROUP</glossterm>
            <info>
                PACKAGE_GROUP[doc] = "Defines one or more packages to include in an image when a specific item is included in IMAGE_FEATURES."
author	Scott Rifenbark <srifenbark@gmail.com>	2015-10-06 10:18:05 -0700
committer	Richard Purdie <richard.purdie@linuxfoundation.org>	2015-10-21 23:06:34 +0100
commit	359b7fb639d5fa11baba0b3257b7e410d34d4d4b (patch)
tree	5aa68796772f49920331228a8b8130e889217d09 /documentation/ref-manual
parent	2f4e90c6a3dca7b5f239223e28474276ce451c4c (diff)
download	poky-359b7fb639d5fa11baba0b3257b7e410d34d4d4b.tar.gz

diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml index 0bc7a82b48..538936b43e 100644 --- a/documentation/ref-manual/ref-variables.xml +++ b/documentation/ref-manual/ref-variables.xml
@@ -8537,6 +8537,144 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
8537	</glossdef>	8537	</glossdef>
8538	</glossentry>	8538	</glossentry>
8539		8539
		8540	<glossentry id='var-PACKAGE_FEED_ARCHS'><glossterm>PACKAGE_FEED_ARCHS</glossterm>
		8541	<info>
		8542	PACKAGE_FEED_ARCHS[doc] = "Specifies user-defined package architectures when constructing package feed URIs."
		8543	</info>
		8544	<glossdef>
		8545	<para role="glossdeffirst">
		8546	<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
		8547	Specifies the package architectures used as part of the
		8548	package feed URIs during the build.
		8549	The <filename>PACKAGE_FEED_ARCHS</filename> variable is
		8550	appended to the final package feed URI, which is constructed
		8551	using the
		8552	<link linkend='var-PACKAGE_FEED_URIS'><filename>PACKAGE_FEED_URIS</filename></link>
		8553	and
		8554	<link linkend='var-PACKAGE_FEED_BASE_PATHS'><filename>PACKAGE_FEED_BASE_PATHS</filename></link>
		8555	variables.
		8556	</para>
		8557
		8558	<para>
		8559	Consider the following example where the
		8560	<filename>PACKAGE_FEED_URIS</filename>,
		8561	<filename>PACKAGE_FEED_BASE_PATHS</filename>, and
		8562	<filename>PACKAGE_FEED_ARCHS</filename> variables are
		8563	defined in your <filename>local.conf</filename> file:
		8564	<literallayout class='monospaced'>
		8565	PACKAGE_FEED_URIS = "https://example.com/packagerepos/release \
		8566	https://example.com/packagerepos/updates"
		8567	PACKAGE_FEED_BASE_PATHS = "rpm rpm-dev"
		8568	PACKAGE_FEED_ARCHS = "all core2-64"
		8569	</literallayout>
		8570	Given these settings, the resulting package feeds are
		8571	as follows:
		8572	<literallayout class='monospaced'>
		8573	https://example.com/packagerepos/release/rpm/all
		8574	https://example.com/packagerepos/release/rpm/core2-64
		8575	https://example.com/packagerepos/release/rpm-dev/all
		8576	https://example.com/packagerepos/release/rpm-dev/core2-64
		8577	https://example.com/packagerepos/updates/rpm/all
		8578	https://example.com/packagerepos/updates/rpm/core2-64
		8579	https://example.com/packagerepos/updates/rpm-dev/all
		8580	https://example.com/packagerepos/updates/rpm-dev/core2-64
		8581	</literallayout>
		8582	</para>
		8583	</glossdef>
		8584	</glossentry>
		8585
		8586	<glossentry id='var-PACKAGE_FEED_BASE_PATHS'><glossterm>PACKAGE_FEED_BASE_PATHS</glossterm>
		8587	<info>
		8588	PACKAGE_FEED_BASE_PATHS[doc] = "Specifies base path used when constructing package feed URIs."
		8589	</info>
		8590	<glossdef>
		8591	<para role="glossdeffirst">
		8592	<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
		8593	Specifies the base path used when constructing package feed
		8594	URIs.
		8595	The <filename>PACKAGE_FEED_BASE_PATHS</filename> variable
		8596	makes up the middle portion of a package feed URI used
		8597	by the OpenEmbedded build system.
		8598	The base path lies between the
		8599	<link linkend='var-PACKAGE_FEED_URIS'><filename>PACKAGE_FEED_URIS</filename></link>
		8600	and
		8601	<link linkend='var-PACKAGE_FEED_ARCHS'><filename>PACKAGE_FEED_ARCHS</filename></link>
		8602	variables.
		8603	</para>
		8604
		8605	<para>
		8606	Consider the following example where the
		8607	<filename>PACKAGE_FEED_URIS</filename>,
		8608	<filename>PACKAGE_FEED_BASE_PATHS</filename>, and
		8609	<filename>PACKAGE_FEED_ARCHS</filename> variables are
		8610	defined in your <filename>local.conf</filename> file:
		8611	<literallayout class='monospaced'>
		8612	PACKAGE_FEED_URIS = "https://example.com/packagerepos/release \
		8613	https://example.com/packagerepos/updates"
		8614	PACKAGE_FEED_BASE_PATHS = "rpm rpm-dev"
		8615	PACKAGE_FEED_ARCHS = "all core2-64"
		8616	</literallayout>
		8617	Given these settings, the resulting package feeds are
		8618	as follows:
		8619	<literallayout class='monospaced'>
		8620	https://example.com/packagerepos/release/rpm/all
		8621	https://example.com/packagerepos/release/rpm/core2-64
		8622	https://example.com/packagerepos/release/rpm-dev/all
		8623	https://example.com/packagerepos/release/rpm-dev/core2-64
		8624	https://example.com/packagerepos/updates/rpm/all
		8625	https://example.com/packagerepos/updates/rpm/core2-64
		8626	https://example.com/packagerepos/updates/rpm-dev/all
		8627	https://example.com/packagerepos/updates/rpm-dev/core2-64
		8628	</literallayout>
		8629	</para>
		8630	</glossdef>
		8631	</glossentry>
		8632
		8633	<glossentry id='var-PACKAGE_FEED_URIS'><glossterm>PACKAGE_FEED_URIS</glossterm>
		8634	<info>
		8635	PACKAGE_FEED_URIS[doc] = "Specifies the front portion of the package feed URI used by the OpenEmbedded build system."
		8636	</info>
		8637	<glossdef>
		8638	<para role="glossdeffirst">
		8639	<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
		8640	Specifies the front portion of the package feed URI
		8641	used by the OpenEmbedded build system.
		8642	Each final package feed URI is comprised of
		8643	<filename>PACKAGE_FEED_URIS</filename>,
		8644	<link linkend='var-PACKAGE_FEED_BASE_PATHS'><filename>PACKAGE_FEED_BASE_PATHS</filename></link>,
		8645	and
		8646	<link linkend='var-PACKAGE_FEED_ARCHS'><filename>PACKAGE_FEED_ARCHS</filename></link>
		8647	variables.
		8648	</para>
		8649
		8650	<para>
		8651	Consider the following example where the
		8652	<filename>PACKAGE_FEED_URIS</filename>,
		8653	<filename>PACKAGE_FEED_BASE_PATHS</filename>, and
		8654	<filename>PACKAGE_FEED_ARCHS</filename> variables are
		8655	defined in your <filename>local.conf</filename> file:
		8656	<literallayout class='monospaced'>
		8657	PACKAGE_FEED_URIS = "https://example.com/packagerepos/release \
		8658	https://example.com/packagerepos/updates"
		8659	PACKAGE_FEED_BASE_PATHS = "rpm rpm-dev"
		8660	PACKAGE_FEED_ARCHS = "all core2-64"
		8661	</literallayout>
		8662	Given these settings, the resulting package feeds are
		8663	as follows:
		8664	<literallayout class='monospaced'>
		8665	https://example.com/packagerepos/release/rpm/all
		8666	https://example.com/packagerepos/release/rpm/core2-64
		8667	https://example.com/packagerepos/release/rpm-dev/all
		8668	https://example.com/packagerepos/release/rpm-dev/core2-64
		8669	https://example.com/packagerepos/updates/rpm/all
		8670	https://example.com/packagerepos/updates/rpm/core2-64
		8671	https://example.com/packagerepos/updates/rpm-dev/all
		8672	https://example.com/packagerepos/updates/rpm-dev/core2-64
		8673	</literallayout>
		8674	</para>
		8675	</glossdef>
		8676	</glossentry>
		8677
8540	<glossentry id='var-PACKAGE_GROUP'><glossterm>PACKAGE_GROUP</glossterm>	8678	<glossentry id='var-PACKAGE_GROUP'><glossterm>PACKAGE_GROUP</glossterm>
8541	<info>	8679	<info>
8542	PACKAGE_GROUP[doc] = "Defines one or more packages to include in an image when a specific item is included in IMAGE_FEATURES."	8680	PACKAGE_GROUP[doc] = "Defines one or more packages to include in an image when a specific item is included in IMAGE_FEATURES."