summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2011-09-27 10:19:06 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2011-10-04 13:46:39 +0100
commit5e06b9a4ed4300b260b6e1d37bf3d02b990515d1 (patch)
tree18a0a151a391c4335405c13599fe5368698f9a2a
parent435e0ac61153724651ca9bf9585a104ebdb42585 (diff)
downloadpoky-5e06b9a4ed4300b260b6e1d37bf3d02b990515d1.tar.gz
documentation/poky-ref-manual/ref-variables.xml: update RDEPENDS and RRECOMMENDS
Provided better descriptions of these variables and some examples on how to use them. (From yocto-docs rev: 3a5cce8c9ba02f90b3554a6f800f69c2e8e77911) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
-rw-r--r--documentation/poky-ref-manual/ref-variables.xml68
1 files changed, 56 insertions, 12 deletions
diff --git a/documentation/poky-ref-manual/ref-variables.xml b/documentation/poky-ref-manual/ref-variables.xml
index 5d4e5b1ab3..9089ccb65c 100644
--- a/documentation/poky-ref-manual/ref-variables.xml
+++ b/documentation/poky-ref-manual/ref-variables.xml
@@ -902,16 +902,28 @@
902 <glossentry id='var-RDEPENDS'><glossterm>RDEPENDS</glossterm> 902 <glossentry id='var-RDEPENDS'><glossterm>RDEPENDS</glossterm>
903 <glossdef> 903 <glossdef>
904 <para> 904 <para>
905 A list of run-time dependencies for a package. 905 A list of packages that must be installed alongside a package being
906 These packages need to be installed alongside the package to which 906 built because the package being build has runtime dependencies on
907 they apply. 907 them.
908 This enables the package to run correctly. 908 In other words, in order for the package being built to run correctly,
909 For example, consider a Perl script, which depends on the Perl package. 909 it depends on these listed packages.
910 Since this variable applies to 910 If a package in this list cannot be found during the build, the build
911 output packages, there should always be an override attached 911 will not complete.
912 to this variable specifying the runtime package to which to add the 912 </para>
913 dependency (e.g. <filename>RDEPENDS_${PN}-dev</filename>). 913 <para>
914 Names in this field must appear as they appear in the 914 Because the <filename>RDEPENDS</filename> variable applies to packages
915 being built, you should
916 always attach an override to the variable to specify the particular runtime package
917 that has the dependency.
918 For example, suppose you are building a development package that depends
919 on the <filename>perl</filename> package.
920 In this case, you would use the following <filename>RDEPENDS</filename>
921 statement:
922 <literallayout class='monospaced'>
923 RDEPENDS_${PN}-dev += "perl"
924 </literallayout>
925 In the example, the package name (<filename>${PN}-dev</filename>) must
926 appear as it would in the
915 <filename><link linkend='var-PACKAGES'>PACKAGES</link></filename> namespace before any 927 <filename><link linkend='var-PACKAGES'>PACKAGES</link></filename> namespace before any
916 renaming of the output package by classes like <filename>debian.bbclass</filename>. 928 renaming of the output package by classes like <filename>debian.bbclass</filename>.
917 </para> 929 </para>
@@ -943,8 +955,40 @@
943 955
944 <glossentry id='var-RRECOMMENDS'><glossterm>RRECOMMENDS</glossterm> 956 <glossentry id='var-RRECOMMENDS'><glossterm>RRECOMMENDS</glossterm>
945 <glossdef> 957 <glossdef>
946 <para>The list of packages that extend usability of the package. 958 <para>
947 The packages are automatically installed but can be removed by user.</para> 959 A list of packages that extend the usability of a package being
960 built.
961 The package being built does not depend on this list of packages in
962 order to successfully built, but needs them for the extended usability.
963 To specify runtime dependencies for packages, see the
964 <link linkend='var-RDEPENDS'>RDEPENDS</link> variable.
965 </para>
966 <para>
967 The Yocto Project build process automatically installs the list of packages
968 as part of the build package.
969 However, you can remove them later if you want.
970 If, during the build, a package from the list cannot be found, the build
971 process continues without an error.
972 </para>
973 <para>
974 Because the <filename>RRECOMMENDS</filename> variable applies to packages
975 being built, you should
976 always attach an override to the variable to specify the particular package
977 whose usability is being extended.
978 For example, suppose you are building a development package that is extended
979 to support wireless functionality.
980 In this case, you would use the following <filename>RRECOMMENDS</filename>
981 statement:
982 <literallayout class='monospaced'>
983 RRECOMMENDS_${PN}-dev += "&lt;wireless_package_name&gt;"
984 </literallayout>
985 In the example, the package name (<filename>${PN}-dev</filename>) must
986 appear as it would in the
987 <filename><link linkend='var-PACKAGES'>PACKAGES</link></filename> namespace before any
988 renaming of the output package by classes like <filename>debian.bbclass</filename>.
989 Also, you would provide the actual name of the package that supports the wireless
990 capabilities.
991 </para>
948 </glossdef> 992 </glossdef>
949 </glossentry> 993 </glossentry>
950 994