ref-manual/ref-variables: correct and extend RREPLACES entry

The existing definition was sparse and not quite correct.

I did some rewriting for active voice and present tense.

(From yocto-docs rev: da1eb14573e2050dc03046311d9f2621f5dcc825)

Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com>
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
Paul Eggleton
2013-04-09 13:54:21 +01:00
committed by Richard Purdie
parent 86243228c7
commit d61df63a60

View File

@@ -3009,8 +3009,25 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
<glossentry id='var-RREPLACES'><glossterm>RREPLACES</glossterm>
<glossdef>
<para>The list of packages replaced by the package in which
<filename>RREPLACES</filename> appears.</para>
<para>
A list of packages replaced by a package.
The package manager uses this variable to determine which
package should be installed to replace other package(s)
during an upgrade.
In order to also have the other package(s) removed at the
same time, you must add the name of the other
package to the
<filename><link linkend='var-RCONFLICTS'>RCONFLICTS</link></filename> variable.
</para>
<para>
As with all package-controlling variables, you must use
this variable in conjunction with a package name
override.
Here is an example:
<literallayout class='monospaced'>
RREPLACES_${PN} = "other-package-being-replaced"
</literallayout>
</para>
</glossdef>
</glossentry>