From c5def93a47cd12c94f448c5531c89d2025bb20d2 Mon Sep 17 00:00:00 2001
From: Jamie Lenehan <lenehan@twibble.org>
Date: Thu, 15 Mar 2007 06:50:22 +0000
Subject: recipes: Add details in the packaging section on how to avoid having
 to package up some files.

---
 usermanual/chapters/recipes.xml | 36 ++++++++++++++++++++++++++++++++----
 1 file changed, 32 insertions(+), 4 deletions(-)

diff --git a/usermanual/chapters/recipes.xml b/usermanual/chapters/recipes.xml
index 786b80540c..f4da35ba4d 100644
--- a/usermanual/chapters/recipes.xml
+++ b/usermanual/chapters/recipes.xml
@@ -1999,9 +1999,9 @@ NOTE: package helloworld-0.1-r0: task do_package_write: completed</screen>We
 
       <para>Note that the order of packages effects the files that will be
       matched via wildcards. Consider the case where we have three binaries in
-      the /usr/bin directory and we want the test program in a separate
-      package:<screen>/usr/bin/programa /usr/bin/programb /usr/bin/test</screen>So
-      we define a new package and instruct bitbake to /usr/bin/test in
+      the <command>/usr/bin</command> directory and we want the test program
+      in a separate package:<screen>/usr/bin/programa /usr/bin/programb /usr/bin/test</screen>So
+      we define a new package and instruct bitbake to include /usr/bin/test in
       it.</para>
 
       <screen>FILES-${PN}-test = "${bindir}/test"
@@ -2113,6 +2113,34 @@ NOTE: package helloworld-0.1-r0: task do_package: completed</screen>Except in
       behind by a recipe.</para>
     </section>
 
+    <section>
+      <title>Excluding files</title>
+
+      <para>There's no actual support for explicitly excluding files from
+      packaging. You could just leave them out of any package, but then you'll
+      get warnings (or errors if requesting full package checking) during
+      packaging which is not desirable. It also doesn't let other people know
+      that you've deliberately avoided packaging the file or files.</para>
+
+      <para>In order to exclude a file totally you should avoid installing it
+      in the first place during the install task.</para>
+
+      <para>In some cases it may be easier to let the package install the file
+      and then explicitly remove the file and the end of the install task. The
+      following example from the samba recipe shows the removal of several
+      files that get installed via the default install task generated by the
+      <xref linkend="autotools_class" />. By using
+      <emphasis>do_install_append</emphasis> these commands and run after the
+      autotools generated install task:</para>
+
+      <screen>do_install_append() {
+    ...
+    rm -f ${D}${bindir}/*.old
+    rm -f ${D}${sbindir}/*.old
+    ...
+}</screen>
+    </section>
+
     <section>
       <title>Debian naming</title>
 
@@ -3108,7 +3136,7 @@ do_configure() {
     <para>When bitbake is asked to build a package and multiple version of
     that package are available it will normally select the version with the
     highest version number (where the version is defined via the
-    <command>PV</command> variable). </para>
+    <command>PV</command> variable).</para>
 
     <para>For example if we were to ask bitbake to build procps and the
     following packages are available:<screen>~/oe%&gt; ls packages/procps 
-- 
cgit 1.2.3-korg