diff options
author | Scott Rifenbark <scott.m.rifenbark@intel.com> | 2013-12-05 15:27:39 -0600 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2013-12-11 14:19:25 +0000 |
commit | 58e3323caf3d0243e0a0af864705ccd74c996ce6 (patch) | |
tree | d188ba0f5d555efba34270a03017883466fabed0 /documentation | |
parent | 759c88f778825b167713bfeb396b90faf7cd101c (diff) | |
download | ast2050-yocto-poky-58e3323caf3d0243e0a0af864705ccd74c996ce6.zip ast2050-yocto-poky-58e3323caf3d0243e0a0af864705ccd74c996ce6.tar.gz |
ref-manual: Re-ordered the classes that start with "U"
(From yocto-docs rev: 9a44ff391521f039a6c42ddb9fb9c97aefcd2c35)
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-classes.xml | 124 |
1 files changed, 62 insertions, 62 deletions
diff --git a/documentation/ref-manual/ref-classes.xml b/documentation/ref-manual/ref-classes.xml index f99889e..17784c2 100644 --- a/documentation/ref-manual/ref-classes.xml +++ b/documentation/ref-manual/ref-classes.xml @@ -2704,6 +2704,68 @@ </para> </section> +<section id='ref-classes-update-alternatives'> + <title>Alternatives - <filename>update-alternatives.bbclass</filename></title> + + <para> + This class helps the alternatives system when multiple sources provide + the same command. + This situation occurs when several programs that have the same or + similar function are installed with the same name. + For example, the <filename>ar</filename> command is available from the + <filename>busybox</filename>, <filename>binutils</filename> and + <filename>elfutils</filename> packages. + The <filename>update-alternatives.bbclass</filename> class handles + renaming the binaries so that multiple packages can be installed + without conflicts. + The <filename>ar</filename> command still works regardless of which + packages are installed or subsequently removed. + The class renames the conflicting binary in each package and symlinks + the highest priority binary during installation or removal of packages. + </para> + + <para> + To use this class, you need to define a number of variables: + <itemizedlist> + <listitem><para><link linkend='var-ALTERNATIVE'><filename>ALTERNATIVE</filename></link> + </para></listitem> + <listitem><para><link linkend='var-ALTERNATIVE_LINK_NAME'><filename>ALTERNATIVE_LINK_NAME</filename></link> + </para></listitem> + <listitem><para><link linkend='var-ALTERNATIVE_TARGET'><filename>ALTERNATIVE_TARGET</filename></link> + </para></listitem> + <listitem><para><link linkend='var-ALTERNATIVE_PRIORITY'><filename>ALTERNATIVE_PRIORITY</filename></link> + </para></listitem> + </itemizedlist> + These variables list alternative commands needed by a package, + provide pathnames for links, default links for targets, and + so forth. + For details on how to use this class, see the comments in the + <ulink url='&YOCTO_GIT_URL;/cgit/cgit.cgi/poky/tree/meta/classes/update-alternatives.bbclass'><filename>update-alternatives.bbclass</filename></ulink>. + </para> + + <note> + You can use the <filename>update-alternatives</filename> command + directly in your recipes. + However, this class simplifies things in most cases. + </note> +</section> + +<section id='ref-classes-update-rc.d'> + <title>Initscripts - <filename>update-rc.d.bbclass</filename></title> + + <para> + This class uses <filename>update-rc.d</filename> to safely install an + initialization script on behalf of the package. + The OpenEmbedded build system takes care of details such as making sure the script is stopped before + a package is removed and started when the package is installed. + Three variables control this class: + <filename><link linkend='var-INITSCRIPT_PACKAGES'>INITSCRIPT_PACKAGES</link></filename>, + <filename><link linkend='var-INITSCRIPT_NAME'>INITSCRIPT_NAME</link></filename> and + <filename><link linkend='var-INITSCRIPT_PARAMS'>INITSCRIPT_PARAMS</link></filename>. + See the variable links for details. + </para> +</section> + <section id='ref-classes-useradd'> <title>Adding Users - <filename>useradd.bbclass</filename></title> @@ -2830,68 +2892,6 @@ </para> </section> -<section id='ref-classes-update-alternatives'> - <title>Alternatives - <filename>update-alternatives.bbclass</filename></title> - - <para> - This class helps the alternatives system when multiple sources provide - the same command. - This situation occurs when several programs that have the same or - similar function are installed with the same name. - For example, the <filename>ar</filename> command is available from the - <filename>busybox</filename>, <filename>binutils</filename> and - <filename>elfutils</filename> packages. - The <filename>update-alternatives.bbclass</filename> class handles - renaming the binaries so that multiple packages can be installed - without conflicts. - The <filename>ar</filename> command still works regardless of which - packages are installed or subsequently removed. - The class renames the conflicting binary in each package and symlinks - the highest priority binary during installation or removal of packages. - </para> - - <para> - To use this class, you need to define a number of variables: - <itemizedlist> - <listitem><para><link linkend='var-ALTERNATIVE'><filename>ALTERNATIVE</filename></link> - </para></listitem> - <listitem><para><link linkend='var-ALTERNATIVE_LINK_NAME'><filename>ALTERNATIVE_LINK_NAME</filename></link> - </para></listitem> - <listitem><para><link linkend='var-ALTERNATIVE_TARGET'><filename>ALTERNATIVE_TARGET</filename></link> - </para></listitem> - <listitem><para><link linkend='var-ALTERNATIVE_PRIORITY'><filename>ALTERNATIVE_PRIORITY</filename></link> - </para></listitem> - </itemizedlist> - These variables list alternative commands needed by a package, - provide pathnames for links, default links for targets, and - so forth. - For details on how to use this class, see the comments in the - <ulink url='&YOCTO_GIT_URL;/cgit/cgit.cgi/poky/tree/meta/classes/update-alternatives.bbclass'><filename>update-alternatives.bbclass</filename></ulink>. - </para> - - <note> - You can use the <filename>update-alternatives</filename> command - directly in your recipes. - However, this class simplifies things in most cases. - </note> -</section> - -<section id='ref-classes-update-rc.d'> - <title>Initscripts - <filename>update-rc.d.bbclass</filename></title> - - <para> - This class uses <filename>update-rc.d</filename> to safely install an - initialization script on behalf of the package. - The OpenEmbedded build system takes care of details such as making sure the script is stopped before - a package is removed and started when the package is installed. - Three variables control this class: - <filename><link linkend='var-INITSCRIPT_PACKAGES'>INITSCRIPT_PACKAGES</link></filename>, - <filename><link linkend='var-INITSCRIPT_NAME'>INITSCRIPT_NAME</link></filename> and - <filename><link linkend='var-INITSCRIPT_PARAMS'>INITSCRIPT_PARAMS</link></filename>. - See the variable links for details. - </para> -</section> - <section id='ref-classes-others'> <title>Other Classes</title> |