diff options
author | Scott Rifenbark <scott.m.rifenbark@intel.com> | 2013-12-05 12:37:40 -0600 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2013-12-11 14:17:56 +0000 |
commit | 4d3a713cd215932474ee83a31b66119f5f154e52 (patch) | |
tree | 0b36e7726fe573b9410699d69eae0921474b9b46 | |
parent | bbb9996af447852e263143a91defaebb2aa4e988 (diff) | |
download | poky-4d3a713cd215932474ee83a31b66119f5f154e52.tar.gz |
ref-manual: Edits to the bin_package class.
(From yocto-docs rev: 5261cb2b993150e929edcf8a298b54d543b1826c)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
-rw-r--r-- | documentation/ref-manual/ref-classes.xml | 160 |
1 files changed, 80 insertions, 80 deletions
diff --git a/documentation/ref-manual/ref-classes.xml b/documentation/ref-manual/ref-classes.xml index d0dc0b0900..60e70d0891 100644 --- a/documentation/ref-manual/ref-classes.xml +++ b/documentation/ref-manual/ref-classes.xml | |||
@@ -153,65 +153,26 @@ | |||
153 | </para> | 153 | </para> |
154 | </section> | 154 | </section> |
155 | 155 | ||
156 | <section id='ref-classes-update-alternatives'> | 156 | <section id='ref-classes-bin-package'> |
157 | <title>Alternatives - <filename>update-alternatives.bbclass</filename></title> | 157 | <title><filename>bin_package.bbclass</filename></title> |
158 | |||
159 | <para> | ||
160 | This class helps the alternatives system when multiple sources provide | ||
161 | the same command. | ||
162 | This situation occurs when several programs that have the same or | ||
163 | similar function are installed with the same name. | ||
164 | For example, the <filename>ar</filename> command is available from the | ||
165 | <filename>busybox</filename>, <filename>binutils</filename> and | ||
166 | <filename>elfutils</filename> packages. | ||
167 | The <filename>update-alternatives.bbclass</filename> class handles | ||
168 | renaming the binaries so that multiple packages can be installed | ||
169 | without conflicts. | ||
170 | The <filename>ar</filename> command still works regardless of which | ||
171 | packages are installed or subsequently removed. | ||
172 | The class renames the conflicting binary in each package and symlinks | ||
173 | the highest priority binary during installation or removal of packages. | ||
174 | </para> | ||
175 | |||
176 | <para> | ||
177 | To use this class, you need to define a number of variables: | ||
178 | <itemizedlist> | ||
179 | <listitem><para><link linkend='var-ALTERNATIVE'><filename>ALTERNATIVE</filename></link> | ||
180 | </para></listitem> | ||
181 | <listitem><para><link linkend='var-ALTERNATIVE_LINK_NAME'><filename>ALTERNATIVE_LINK_NAME</filename></link> | ||
182 | </para></listitem> | ||
183 | <listitem><para><link linkend='var-ALTERNATIVE_TARGET'><filename>ALTERNATIVE_TARGET</filename></link> | ||
184 | </para></listitem> | ||
185 | <listitem><para><link linkend='var-ALTERNATIVE_PRIORITY'><filename>ALTERNATIVE_PRIORITY</filename></link> | ||
186 | </para></listitem> | ||
187 | </itemizedlist> | ||
188 | These variables list alternative commands needed by a package, | ||
189 | provide pathnames for links, default links for targets, and | ||
190 | so forth. | ||
191 | For details on how to use this class, see the comments in the | ||
192 | <ulink url='&YOCTO_GIT_URL;/cgit/cgit.cgi/poky/tree/meta/classes/update-alternatives.bbclass'><filename>update-alternatives.bbclass</filename></ulink>. | ||
193 | </para> | ||
194 | |||
195 | <note> | ||
196 | You can use the <filename>update-alternatives</filename> command | ||
197 | directly in your recipes. | ||
198 | However, this class simplifies things in most cases. | ||
199 | </note> | ||
200 | </section> | ||
201 | |||
202 | <section id='ref-classes-update-rc.d'> | ||
203 | <title>Initscripts - <filename>update-rc.d.bbclass</filename></title> | ||
204 | 158 | ||
205 | <para> | 159 | <para> |
206 | This class uses <filename>update-rc.d</filename> to safely install an | 160 | The <filename>bin_package</filename> class is a |
207 | initialization script on behalf of the package. | 161 | helper class for recipes that extract the contents of a binary package |
208 | The OpenEmbedded build system takes care of details such as making sure the script is stopped before | 162 | (e.g. an RPM) and install those contents rather than building the |
209 | a package is removed and started when the package is installed. | 163 | binary from source. |
210 | Three variables control this class: | 164 | The binary package is extracted and new packages in the configured |
211 | <filename><link linkend='var-INITSCRIPT_PACKAGES'>INITSCRIPT_PACKAGES</link></filename>, | 165 | output package format are created. |
212 | <filename><link linkend='var-INITSCRIPT_NAME'>INITSCRIPT_NAME</link></filename> and | 166 | <note> |
213 | <filename><link linkend='var-INITSCRIPT_PARAMS'>INITSCRIPT_PARAMS</link></filename>. | 167 | For RPMs and other packages that do not contain a subdirectory, |
214 | See the variable links for details. | 168 | you should specify a "subdir" parameter. |
169 | Here is an example where <filename>${BP}</filename> matches the | ||
170 | subdirectory expected by the default value of | ||
171 | <link linkend='var-S'><filename>S</filename></link>: | ||
172 | <literallayout class='monospaced'> | ||
173 | SRC_URI = "http://example.com/downloads/somepackage.rpm;subdir=${BP}" | ||
174 | </literallayout> | ||
175 | </note> | ||
215 | </para> | 176 | </para> |
216 | </section> | 177 | </section> |
217 | 178 | ||
@@ -243,29 +204,6 @@ | |||
243 | </para> | 204 | </para> |
244 | </section> | 205 | </section> |
245 | 206 | ||
246 | <section id='ref-classes-bin-package'> | ||
247 | <title><filename>bin_package.bbclass</filename></title> | ||
248 | |||
249 | <para> | ||
250 | The binary package (<filename>bin_package</filename>) class is a | ||
251 | helper class for recipes that extract the contents of a binary package | ||
252 | (e.g. an RPM) and install those contents rather than building the | ||
253 | binary from source. | ||
254 | The binary package is extracted and new packages in the configured | ||
255 | output package format are created. | ||
256 | <note> | ||
257 | For RPMs and other packages that do not contain a subdirectory, | ||
258 | you should specify a "subdir" parameter. | ||
259 | Here is an example where <filename>${BP}</filename> matches the | ||
260 | subdirectory expected by the default value of | ||
261 | <link linkend='var-S'><filename>S</filename></link>: | ||
262 | <literallayout class='monospaced'> | ||
263 | SRC_URI = "http://example.com/downloads/somepackage.rpm;subdir=${BP}" | ||
264 | </literallayout> | ||
265 | </note> | ||
266 | </para> | ||
267 | </section> | ||
268 | |||
269 | <section id='ref-classes-blacklist'> | 207 | <section id='ref-classes-blacklist'> |
270 | <title><filename>blacklist.bbclass</filename></title> | 208 | <title><filename>blacklist.bbclass</filename></title> |
271 | 209 | ||
@@ -2849,6 +2787,68 @@ | |||
2849 | </para> | 2787 | </para> |
2850 | </section> | 2788 | </section> |
2851 | 2789 | ||
2790 | <section id='ref-classes-update-alternatives'> | ||
2791 | <title>Alternatives - <filename>update-alternatives.bbclass</filename></title> | ||
2792 | |||
2793 | <para> | ||
2794 | This class helps the alternatives system when multiple sources provide | ||
2795 | the same command. | ||
2796 | This situation occurs when several programs that have the same or | ||
2797 | similar function are installed with the same name. | ||
2798 | For example, the <filename>ar</filename> command is available from the | ||
2799 | <filename>busybox</filename>, <filename>binutils</filename> and | ||
2800 | <filename>elfutils</filename> packages. | ||
2801 | The <filename>update-alternatives.bbclass</filename> class handles | ||
2802 | renaming the binaries so that multiple packages can be installed | ||
2803 | without conflicts. | ||
2804 | The <filename>ar</filename> command still works regardless of which | ||
2805 | packages are installed or subsequently removed. | ||
2806 | The class renames the conflicting binary in each package and symlinks | ||
2807 | the highest priority binary during installation or removal of packages. | ||
2808 | </para> | ||
2809 | |||
2810 | <para> | ||
2811 | To use this class, you need to define a number of variables: | ||
2812 | <itemizedlist> | ||
2813 | <listitem><para><link linkend='var-ALTERNATIVE'><filename>ALTERNATIVE</filename></link> | ||
2814 | </para></listitem> | ||
2815 | <listitem><para><link linkend='var-ALTERNATIVE_LINK_NAME'><filename>ALTERNATIVE_LINK_NAME</filename></link> | ||
2816 | </para></listitem> | ||
2817 | <listitem><para><link linkend='var-ALTERNATIVE_TARGET'><filename>ALTERNATIVE_TARGET</filename></link> | ||
2818 | </para></listitem> | ||
2819 | <listitem><para><link linkend='var-ALTERNATIVE_PRIORITY'><filename>ALTERNATIVE_PRIORITY</filename></link> | ||
2820 | </para></listitem> | ||
2821 | </itemizedlist> | ||
2822 | These variables list alternative commands needed by a package, | ||
2823 | provide pathnames for links, default links for targets, and | ||
2824 | so forth. | ||
2825 | For details on how to use this class, see the comments in the | ||
2826 | <ulink url='&YOCTO_GIT_URL;/cgit/cgit.cgi/poky/tree/meta/classes/update-alternatives.bbclass'><filename>update-alternatives.bbclass</filename></ulink>. | ||
2827 | </para> | ||
2828 | |||
2829 | <note> | ||
2830 | You can use the <filename>update-alternatives</filename> command | ||
2831 | directly in your recipes. | ||
2832 | However, this class simplifies things in most cases. | ||
2833 | </note> | ||
2834 | </section> | ||
2835 | |||
2836 | <section id='ref-classes-update-rc.d'> | ||
2837 | <title>Initscripts - <filename>update-rc.d.bbclass</filename></title> | ||
2838 | |||
2839 | <para> | ||
2840 | This class uses <filename>update-rc.d</filename> to safely install an | ||
2841 | initialization script on behalf of the package. | ||
2842 | The OpenEmbedded build system takes care of details such as making sure the script is stopped before | ||
2843 | a package is removed and started when the package is installed. | ||
2844 | Three variables control this class: | ||
2845 | <filename><link linkend='var-INITSCRIPT_PACKAGES'>INITSCRIPT_PACKAGES</link></filename>, | ||
2846 | <filename><link linkend='var-INITSCRIPT_NAME'>INITSCRIPT_NAME</link></filename> and | ||
2847 | <filename><link linkend='var-INITSCRIPT_PARAMS'>INITSCRIPT_PARAMS</link></filename>. | ||
2848 | See the variable links for details. | ||
2849 | </para> | ||
2850 | </section> | ||
2851 | |||
2852 | <section id='ref-classes-others'> | 2852 | <section id='ref-classes-others'> |
2853 | <title>Other Classes</title> | 2853 | <title>Other Classes</title> |
2854 | 2854 | ||