summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual/ref-variables.xml
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2014-09-08 18:18:56 +0300
committerRichard Purdie <richard.purdie@linuxfoundation.org>2014-09-22 13:04:43 +0100
commit567c1ae31544993f15aa19380fc1d4ead454b0ef (patch)
treec7d323f4f63f6d2538127a17f9fe8fb9285da503 /documentation/ref-manual/ref-variables.xml
parent385f20b19f18dea4b8e81a42509ff9840ced1519 (diff)
downloadpoky-567c1ae31544993f15aa19380fc1d4ead454b0ef.tar.gz
ref-manual: Updated RRECOMMENDS variable description.
There was confusion about how this actually worked when you do not create a package for a package listed with the variable. Cases for when the build would throw an error or not had to be clarified. (From yocto-docs rev: 02f95339322afe53db816b3b73234490d835b1ca) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/ref-manual/ref-variables.xml')
-rw-r--r--documentation/ref-manual/ref-variables.xml39
1 files changed, 24 insertions, 15 deletions
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml
index 3d4ee92e95..0eb5d98c58 100644
--- a/documentation/ref-manual/ref-variables.xml
+++ b/documentation/ref-manual/ref-variables.xml
@@ -7110,31 +7110,40 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
7110 A list of packages that extends the usability of a package 7110 A list of packages that extends the usability of a package
7111 being built. 7111 being built.
7112 The package being built does not depend on this list of 7112 The package being built does not depend on this list of
7113 packages in order to successfully build, but needs them for 7113 packages in order to successfully build, but rather
7114 the extended usability. 7114 uses them for extended usability.
7115 To specify runtime dependencies for packages, see the 7115 To specify runtime dependencies for packages, see the
7116 <filename><link linkend='var-RDEPENDS'>RDEPENDS</link></filename> 7116 <filename><link linkend='var-RDEPENDS'>RDEPENDS</link></filename>
7117 variable. 7117 variable.
7118 </para> 7118 </para>
7119 7119
7120 <para> 7120 <para>
7121 The OpenEmbedded build process automatically installs the 7121 The package manager will automatically install the
7122 list of packages as part of the built package. 7122 <filename>RRECOMMENDS</filename> list of packages when
7123 However, you can remove these packages later if you want. 7123 installing the built package.
7124 If, during the build, a package from the 7124 However, you can prevent listed packages from being
7125 <filename>RRECOMMENDS</filename> list cannot be 7125 installed by using the
7126 found, the build process continues without an error.
7127 </para>
7128
7129 <para>
7130 You can also prevent packages in the list from being
7131 installed by using several variables.
7132 See the
7133 <link linkend='var-BAD_RECOMMENDATIONS'><filename>BAD_RECOMMENDATIONS</filename></link>, 7126 <link linkend='var-BAD_RECOMMENDATIONS'><filename>BAD_RECOMMENDATIONS</filename></link>,
7134 <link linkend='var-NO_RECOMMENDATIONS'><filename>NO_RECOMMENDATIONS</filename></link>, 7127 <link linkend='var-NO_RECOMMENDATIONS'><filename>NO_RECOMMENDATIONS</filename></link>,
7135 and 7128 and
7136 <link linkend='var-PACKAGE_EXCLUDE'><filename>PACKAGE_EXCLUDE</filename></link> 7129 <link linkend='var-PACKAGE_EXCLUDE'><filename>PACKAGE_EXCLUDE</filename></link>
7137 variables for more information. 7130 variables.
7131 </para>
7132
7133 <para>
7134 Packages specified in
7135 <filename>RRECOMMENDS</filename> need not actually be
7136 produced.
7137 However, a recipe must exist that provides each package,
7138 either through the
7139 <link linkend='var-PACKAGES'><filename>PACKAGES</filename></link>
7140 or
7141 <link linkend='var-PACKAGES_DYNAMIC'><filename>PACKAGES_DYNAMIC</filename></link>
7142 variables or the
7143 <link linkend='var-RPROVIDES'><filename>RPROVIDES</filename></link>
7144 variable, or an error will occur during the build.
7145 If such a recipe does exist and the package is not produced,
7146 the build continues without error.
7138 </para> 7147 </para>
7139 7148
7140 <para> 7149 <para>