[oe-commits] org.oe.documentation recipes: Add details in the packaging section on how to avoid having

[lenehan commit]

recipes: Add details in the packaging section on how to avoid having
to package up some files.

Author: lenehan at openembedded.org
Branch: org.openembedded.documentation
Revision: c6010a4d5576d46735b214dfe95d7280c789a385
ViewMTN: http://monotone.openembedded.org/revision.psp?id=c6010a4d5576d46735b214dfe95d7280c789a385
Files:
1
usermanual/chapters/recipes.xml
Diffs:

#
# mt diff -ra1a8446181d3d1d8c4caaadcac0b2bf0072c739b -rc6010a4d5576d46735b214dfe95d7280c789a385
#
# 
# 
# patch "usermanual/chapters/recipes.xml"
#  from [24e30cf8c6e2d947422355381bb0492704198d93]
#    to [e435826cd36e6df35243309c368026d652095644]
# 
============================================================
--- usermanual/chapters/recipes.xml	24e30cf8c6e2d947422355381bb0492704198d93
+++ usermanual/chapters/recipes.xml	e435826cd36e6df35243309c368026d652095644
@@ -1999,9 +1999,9 @@ NOTE: package helloworld-0.1-r0: task do
 
       <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"
@@ -2114,6 +2114,34 @@ NOTE: package helloworld-0.1-r0: task do
     </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>
 
       <para>This section is to be completed</para>
@@ -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