summaryrefslogtreecommitdiffstats
path: root/documentation/dev-manual
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2013-09-10 15:15:28 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2013-09-12 16:50:10 +0100
commitde623774153faa421203c8d1116b351596bea917 (patch)
tree18d9cb9d57f1e5ef32fe2730ee89cb29e5dfafb6 /documentation/dev-manual
parent0ca3c5f54067df042be2f73890d0d0ca34531bda (diff)
downloadpoky-de623774153faa421203c8d1116b351596bea917.tar.gz
dev-manual: Added new section on how to exclude a package
Fixes [YOCTO #4079] The changes here address the documentation component of this bug. There is now a new section in the dev-manual in the "Working With Packages" section that describes and introduces the three variables the user can use to control this feature: BAD_RECOMMENDATIONS, NO_RECOMMENDATIONS, and PACKAGE_EXCLUDE. (From yocto-docs rev: a7e2097c43955db99ec068068d4291fc4e1deaf8) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/dev-manual')
-rw-r--r--documentation/dev-manual/dev-manual-common-tasks.xml45
1 files changed, 45 insertions, 0 deletions
diff --git a/documentation/dev-manual/dev-manual-common-tasks.xml b/documentation/dev-manual/dev-manual-common-tasks.xml
index ccaf983cfc..0f630bd15e 100644
--- a/documentation/dev-manual/dev-manual-common-tasks.xml
+++ b/documentation/dev-manual/dev-manual-common-tasks.xml
@@ -2926,6 +2926,8 @@
2926 <para> 2926 <para>
2927 This section describes a few tasks that involve packages: 2927 This section describes a few tasks that involve packages:
2928 <itemizedlist> 2928 <itemizedlist>
2929 <listitem><para>Excluding packages from an image
2930 </para></listitem>
2929 <listitem><para>Incrementing a package revision number 2931 <listitem><para>Incrementing a package revision number
2930 </para></listitem> 2932 </para></listitem>
2931 <listitem><para>Handling a package name alias 2933 <listitem><para>Handling a package name alias
@@ -2940,6 +2942,49 @@
2940 </itemizedlist> 2942 </itemizedlist>
2941 </para> 2943 </para>
2942 2944
2945 <section id='excluding-packages-from-an-image'>
2946 <title>Excluding Packages from an Image</title>
2947
2948 <para>
2949 You might find it necessary to prevent specific packages
2950 from being installed into an image.
2951 If so, you can use several variables to direct the build
2952 system to essentially ignore installing recommended packages
2953 or to not install a package at all.
2954 </para>
2955
2956 <para>
2957 The following list introduces variables you can use to
2958 prevent packages from being installed into your image.
2959 Each of these variables only works with IPK and RPM
2960 package types.
2961 Support for Debian packages does not exist.
2962 Also, you can use these variables from your
2963 <filename>local.conf</filename> file or attach them to a
2964 specific image recipe by using a recipe name override.
2965 For more detail on the variables, see the descriptions in the
2966 Yocto Project Reference Manual's glossary chapter.
2967 <itemizedlist>
2968 <listitem><para><ulink url='&YOCTO_DOCS_REF_URL;#var-BAD_RECOMMENDATIONS'><filename>BAD_RECOMMENDATIONS</filename></ulink>:
2969 Use this variable to specify "recommended-only"
2970 packages that you do not want installed.
2971 </para></listitem>
2972 <listitem><para><ulink url='&YOCTO_DOCS_REF_URL;#var-NO_RECOMMENDATIONS'><filename>NO_RECOMMENDATIONS</filename></ulink>:
2973 Use this variable to prevent all "recommended-only"
2974 packages from being installed.
2975 </para></listitem>
2976 <listitem><para><ulink url='&YOCTO_DOCS_REF_URL;#var-PACKAGE_EXCLUDE'><filename>PACKAGE_EXCLUDE</filename></ulink>:
2977 Use this variable to prevent specific packages from
2978 being installed regardless of whether they are
2979 "recommended-only" or not.
2980 You need to realize that things could break when you
2981 prevent the installation of a package whose presence
2982 is required by an installed package.
2983 </para></listitem>
2984 </itemizedlist>
2985 </para>
2986 </section>
2987
2943 <section id='incrementing-a-package-revision-number'> 2988 <section id='incrementing-a-package-revision-number'>
2944 <title>Incrementing a Package Revision Number</title> 2989 <title>Incrementing a Package Revision Number</title>
2945 2990