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 | 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 f99889e570..17784c2628 100644 --- a/documentation/ref-manual/ref-classes.xml +++ b/documentation/ref-manual/ref-classes.xml | |||
@@ -2704,6 +2704,68 @@ | |||
2704 | </para> | 2704 | </para> |
2705 | </section> | 2705 | </section> |
2706 | 2706 | ||
2707 | <section id='ref-classes-update-alternatives'> | ||
2708 | <title>Alternatives - <filename>update-alternatives.bbclass</filename></title> | ||
2709 | |||
2710 | <para> | ||
2711 | This class helps the alternatives system when multiple sources provide | ||
2712 | the same command. | ||
2713 | This situation occurs when several programs that have the same or | ||
2714 | similar function are installed with the same name. | ||
2715 | For example, the <filename>ar</filename> command is available from the | ||
2716 | <filename>busybox</filename>, <filename>binutils</filename> and | ||
2717 | <filename>elfutils</filename> packages. | ||
2718 | The <filename>update-alternatives.bbclass</filename> class handles | ||
2719 | renaming the binaries so that multiple packages can be installed | ||
2720 | without conflicts. | ||
2721 | The <filename>ar</filename> command still works regardless of which | ||
2722 | packages are installed or subsequently removed. | ||
2723 | The class renames the conflicting binary in each package and symlinks | ||
2724 | the highest priority binary during installation or removal of packages. | ||
2725 | </para> | ||
2726 | |||
2727 | <para> | ||
2728 | To use this class, you need to define a number of variables: | ||
2729 | <itemizedlist> | ||
2730 | <listitem><para><link linkend='var-ALTERNATIVE'><filename>ALTERNATIVE</filename></link> | ||
2731 | </para></listitem> | ||
2732 | <listitem><para><link linkend='var-ALTERNATIVE_LINK_NAME'><filename>ALTERNATIVE_LINK_NAME</filename></link> | ||
2733 | </para></listitem> | ||
2734 | <listitem><para><link linkend='var-ALTERNATIVE_TARGET'><filename>ALTERNATIVE_TARGET</filename></link> | ||
2735 | </para></listitem> | ||
2736 | <listitem><para><link linkend='var-ALTERNATIVE_PRIORITY'><filename>ALTERNATIVE_PRIORITY</filename></link> | ||
2737 | </para></listitem> | ||
2738 | </itemizedlist> | ||
2739 | These variables list alternative commands needed by a package, | ||
2740 | provide pathnames for links, default links for targets, and | ||
2741 | so forth. | ||
2742 | For details on how to use this class, see the comments in the | ||
2743 | <ulink url='&YOCTO_GIT_URL;/cgit/cgit.cgi/poky/tree/meta/classes/update-alternatives.bbclass'><filename>update-alternatives.bbclass</filename></ulink>. | ||
2744 | </para> | ||
2745 | |||
2746 | <note> | ||
2747 | You can use the <filename>update-alternatives</filename> command | ||
2748 | directly in your recipes. | ||
2749 | However, this class simplifies things in most cases. | ||
2750 | </note> | ||
2751 | </section> | ||
2752 | |||
2753 | <section id='ref-classes-update-rc.d'> | ||
2754 | <title>Initscripts - <filename>update-rc.d.bbclass</filename></title> | ||
2755 | |||
2756 | <para> | ||
2757 | This class uses <filename>update-rc.d</filename> to safely install an | ||
2758 | initialization script on behalf of the package. | ||
2759 | The OpenEmbedded build system takes care of details such as making sure the script is stopped before | ||
2760 | a package is removed and started when the package is installed. | ||
2761 | Three variables control this class: | ||
2762 | <filename><link linkend='var-INITSCRIPT_PACKAGES'>INITSCRIPT_PACKAGES</link></filename>, | ||
2763 | <filename><link linkend='var-INITSCRIPT_NAME'>INITSCRIPT_NAME</link></filename> and | ||
2764 | <filename><link linkend='var-INITSCRIPT_PARAMS'>INITSCRIPT_PARAMS</link></filename>. | ||
2765 | See the variable links for details. | ||
2766 | </para> | ||
2767 | </section> | ||
2768 | |||
2707 | <section id='ref-classes-useradd'> | 2769 | <section id='ref-classes-useradd'> |
2708 | <title>Adding Users - <filename>useradd.bbclass</filename></title> | 2770 | <title>Adding Users - <filename>useradd.bbclass</filename></title> |
2709 | 2771 | ||
@@ -2830,68 +2892,6 @@ | |||
2830 | </para> | 2892 | </para> |
2831 | </section> | 2893 | </section> |
2832 | 2894 | ||
2833 | <section id='ref-classes-update-alternatives'> | ||
2834 | <title>Alternatives - <filename>update-alternatives.bbclass</filename></title> | ||
2835 | |||
2836 | <para> | ||
2837 | This class helps the alternatives system when multiple sources provide | ||
2838 | the same command. | ||
2839 | This situation occurs when several programs that have the same or | ||
2840 | similar function are installed with the same name. | ||
2841 | For example, the <filename>ar</filename> command is available from the | ||
2842 | <filename>busybox</filename>, <filename>binutils</filename> and | ||
2843 | <filename>elfutils</filename> packages. | ||
2844 | The <filename>update-alternatives.bbclass</filename> class handles | ||
2845 | renaming the binaries so that multiple packages can be installed | ||
2846 | without conflicts. | ||
2847 | The <filename>ar</filename> command still works regardless of which | ||
2848 | packages are installed or subsequently removed. | ||
2849 | The class renames the conflicting binary in each package and symlinks | ||
2850 | the highest priority binary during installation or removal of packages. | ||
2851 | </para> | ||
2852 | |||
2853 | <para> | ||
2854 | To use this class, you need to define a number of variables: | ||
2855 | <itemizedlist> | ||
2856 | <listitem><para><link linkend='var-ALTERNATIVE'><filename>ALTERNATIVE</filename></link> | ||
2857 | </para></listitem> | ||
2858 | <listitem><para><link linkend='var-ALTERNATIVE_LINK_NAME'><filename>ALTERNATIVE_LINK_NAME</filename></link> | ||
2859 | </para></listitem> | ||
2860 | <listitem><para><link linkend='var-ALTERNATIVE_TARGET'><filename>ALTERNATIVE_TARGET</filename></link> | ||
2861 | </para></listitem> | ||
2862 | <listitem><para><link linkend='var-ALTERNATIVE_PRIORITY'><filename>ALTERNATIVE_PRIORITY</filename></link> | ||
2863 | </para></listitem> | ||
2864 | </itemizedlist> | ||
2865 | These variables list alternative commands needed by a package, | ||
2866 | provide pathnames for links, default links for targets, and | ||
2867 | so forth. | ||
2868 | For details on how to use this class, see the comments in the | ||
2869 | <ulink url='&YOCTO_GIT_URL;/cgit/cgit.cgi/poky/tree/meta/classes/update-alternatives.bbclass'><filename>update-alternatives.bbclass</filename></ulink>. | ||
2870 | </para> | ||
2871 | |||
2872 | <note> | ||
2873 | You can use the <filename>update-alternatives</filename> command | ||
2874 | directly in your recipes. | ||
2875 | However, this class simplifies things in most cases. | ||
2876 | </note> | ||
2877 | </section> | ||
2878 | |||
2879 | <section id='ref-classes-update-rc.d'> | ||
2880 | <title>Initscripts - <filename>update-rc.d.bbclass</filename></title> | ||
2881 | |||
2882 | <para> | ||
2883 | This class uses <filename>update-rc.d</filename> to safely install an | ||
2884 | initialization script on behalf of the package. | ||
2885 | The OpenEmbedded build system takes care of details such as making sure the script is stopped before | ||
2886 | a package is removed and started when the package is installed. | ||
2887 | Three variables control this class: | ||
2888 | <filename><link linkend='var-INITSCRIPT_PACKAGES'>INITSCRIPT_PACKAGES</link></filename>, | ||
2889 | <filename><link linkend='var-INITSCRIPT_NAME'>INITSCRIPT_NAME</link></filename> and | ||
2890 | <filename><link linkend='var-INITSCRIPT_PARAMS'>INITSCRIPT_PARAMS</link></filename>. | ||
2891 | See the variable links for details. | ||
2892 | </para> | ||
2893 | </section> | ||
2894 | |||
2895 | <section id='ref-classes-others'> | 2895 | <section id='ref-classes-others'> |
2896 | <title>Other Classes</title> | 2896 | <title>Other Classes</title> |
2897 | 2897 | ||