aboutsummaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2014-03-31 17:20:16 -0600
committerRichard Purdie <richard.purdie@linuxfoundation.org>2014-04-01 10:23:02 +0100
commit163a4e5be0328a0ba1df5a4aa738a08c2363215e (patch)
treea847d51953f9899a76e00ac5d70902438bcf58ac /documentation
parent5cf7a54a24487e4d2c2a72a42e1ea1cf2b87a572 (diff)
downloadopenembedded-core-contrib-163a4e5be0328a0ba1df5a4aa738a08c2363215e.tar.gz
ref-manual: Updated to PACKAGE_GROUP and addition of FEATURE_PACKAGES.
The PACKAGE_GROUP variable was renamed to FEATURE_PACKAGES. I added that fact to the description and pointed the reader off to the new FEATURE_PACKAGES variable. Added a new variable description for FEATURE_PACKAGES. (From yocto-docs rev: f7a0a17c211cfc8f885771a5221bf3b59bc6bf95) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
-rw-r--r--documentation/ref-manual/ref-variables.xml63
1 files changed, 41 insertions, 22 deletions
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml
index 13f62f4c9d..c7db5bea58 100644
--- a/documentation/ref-manual/ref-variables.xml
+++ b/documentation/ref-manual/ref-variables.xml
@@ -21,7 +21,7 @@
<link linkend='var-CFLAGS'>C</link>
<link linkend='var-D'>D</link>
<link linkend='var-ENABLE_BINARY_LOCALE_GENERATION'>E</link>
- <link linkend='var-FEED_DEPLOYDIR_BASE_URI'>F</link>
+ <link linkend='var-FEATURE_PACKAGES'>F</link>
<link linkend='var-GROUPADD_PARAM'>G</link>
<link linkend='var-HOMEPAGE'>H</link>
<link linkend='var-ICECC_DISABLED'>I</link>
@@ -2170,6 +2170,34 @@
<glossdiv id='var-glossary-f'><title>F</title>
+ <glossentry id='var-FEATURE_PACKAGES'><glossterm>FEATURE_PACKAGES</glossterm>
+ <glossdef>
+ <para>
+ Defines one or more packages to include in an image when
+ a specific item is included in
+ <link linkend='var-IMAGE_FEATURES'><filename>IMAGE_FEATURES</filename></link>.
+ When setting the value, <filename>FEATURE_PACKAGES</filename>
+ should have the name of the feature item as an override.
+ Here is an example:
+ <literallayout class='monospaced'>
+ FEATURE_PACKAGES_widget = "package1 package2"
+ </literallayout>
+ In this example, if "widget" were added to
+ <filename>IMAGE_FEATURES</filename>, "package1" and
+ "package2" would be included in the image.
+ <note>
+ Packages installed by features defined through
+ <filename>FEATURE_PACKAGES</filename> are often package
+ groups.
+ While similarly named, you should not confuse the
+ <filename>FEATURE_PACKAGES</filename> variable with
+ package groups, which are discussed elsewhere in the
+ documentation.
+ </note>
+ </para>
+ </glossdef>
+ </glossentry>
+
<glossentry id='var-FEED_DEPLOYDIR_BASE_URI'><glossterm>FEED_DEPLOYDIR_BASE_URI</glossterm>
<glossdef>
<para>
@@ -4942,28 +4970,19 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
<glossentry id='var-PACKAGE_GROUP'><glossterm>PACKAGE_GROUP</glossterm>
<glossdef>
+
<para>
- Defines one or more packages to include in an image when
- a specific item is included in
- <link linkend='var-IMAGE_FEATURES'><filename>IMAGE_FEATURES</filename></link>.
- When setting the value, <filename>PACKAGE_GROUP</filename>
- should have the name of the feature item as an override.
- Here is an example:
- <literallayout class='monospaced'>
- PACKAGE_GROUP_widget = "package1 package2"
- </literallayout>
- In this example, if "widget" were added to
- <filename>IMAGE_FEATURES</filename>, "package1" and
- "package2" would be included in the image.
- <note>
- Packages installed by features defined through
- <filename>PACKAGE_GROUP</filename> are often package
- groups.
- While similarly named, you should not confuse the
- <filename>PACKAGE_GROUP</filename> variable with
- package groups, which are discussed elsewhere in the
- documentation.
- </note>
+ The <filename>PACKAGE_GROUP</filename> variable has been
+ renamed to
+ <link linkend='var-FEATURE_PACKAGES'><filename>FEATURE_PACKAGES</filename></link>.
+ See the variable description for
+ <filename>FEATURE_PACKAGES</filename> for information.
+ </para>
+
+ <para>
+ If if you use the <filename>PACKAGE_GROUP</filename>
+ variable, the OpenEmbedded build system issues a warning
+ message.
</para>
</glossdef>
</glossentry>