r524: * Make dh_clean remove autom4te.cache.

[debhelper.git] / dh_clean

diff --git a/dh_clean b/dh_clean
index 1f73bea732aedb8f7c381d0e042ee9f1d40bfccc..fd9f86f126daafbcf4ca243e90efe2f37dc549d5 100755 (executable)
--- a/dh_clean
+++ b/dh_clean
@@ -1,24 +1,73 @@
 #!/usr/bin/perl -w
-#
-# Clean up $TMP and other tepmorary files generated by the
-# build process.
 
+=head1 NAME
+
+dh_clean - clean up package build directories
+
+=cut
+
+use strict;
 use Debian::Debhelper::Dh_Lib;
+
+=head1 SYNOPSIS
+
+B<dh_clean> [S<I<debhelper options>>] [B<-k>] [B<-d>] [B<-X>I<item>] [S<I<file ...>>]
+
+=head1 DESCRIPTION
+
+dh_clean is a debhelper program that is responsible for cleaning up after a
+package is built. It removes the package build directories, and removes some
+other files, such as debian/substvars, debian/files, and any detritus left
+behind by other debhelper commands (debian/*.debhelper). It also removes
+common files that should not appear in a debian diff:
+  #*# *~ DEADJOE *.orig *.rej *.SUMS TAGS core .deps/* *.P
+
+=head1 OPTIONS
+
+=over 4
+
+=item B<-k>, B<--keep>
+
+Do not delete debian/files. When do you want to use this? Anytime you have a
+debian/rules that has 2 binary targets that build different .deb packages;
+for example, one target is binary-arch, and the other is binary-indep, or
+one target builds the shared library, and the other the -dev package. If you
+didn't use -k in these cases, then debian/files would be deleted in the
+middle, and your changes file will only contain the last binary package that
+was built.
+
+=item B<-d>, B<--dirs-only>
+
+Only clean the package build directories, do not clean up any other files
+at all.
+
+=item B<-X>I<item> B<--exclude=>I<item>
+
+Exclude files that contain "item" anywhere in their filename from being
+deleted, even if they would normally be deleted. You may use this option
+multiple times to build up a list of things to exclude.
+
+=item I<file ...>
+
+Delete these files too.
+
+=back
+
+=cut
+
 init();
 
-foreach $PACKAGE (@{$dh{DOPACKAGES}}) {
-       $TMP=tmpdir($PACKAGE);
-       $EXT=pkgext($PACKAGE);
+foreach my $package (@{$dh{DOPACKAGES}}) {
+       my $tmp=tmpdir($package);
+       my $ext=pkgext($package);
 
        if (! $dh{D_FLAG}) {
-               doit("rm","-f","debian/$EXT\substvars",
-                       "debian/$EXT\postinst.debhelper",
-                       "debian/$EXT\postrm.debhelper",
-                       "debian/$EXT\preinst.debhelper",
-                       "debian/$EXT\prerm.debhelper");
+               doit("rm","-f","debian/${ext}substvars")
+                       unless excludefile("debian/${ext}substvars");
        }
        
-       doit ("rm","-rf",$TMP);
+       doit ("rm","-rf",$tmp)
+               unless excludefile($tmp);
 }
 
 if (! $dh{D_FLAG}) {
@@ -27,7 +76,22 @@ if (! $dh{D_FLAG}) {
        }
 
        if (! $dh{K_FLAG}) {
-               doit("rm","-f","debian/files");
+               doit("rm","-f","debian/files")
+                       unless excludefile("debian/files");
+       }
+
+       # These are all debhelper temp files, and so it is safe to 
+       # wildcard them.
+       complex_doit("rm -f debian/*.debhelper");
+
+       # Remove some files that were left around by older versions of
+       # debhelper.
+       doit("rm","-f","debian/substvars");
+       
+       # See if some files that would normally be deleted are excluded.
+       my $find_options='';
+       if (defined($dh{EXCLUDE_FIND}) && $dh{EXCLUDE_FIND} ne '') {
+               $find_options="-a ! ( $dh{EXCLUDE_FIND} )";
        }
 
        # Remove other temp files.
@@ -35,13 +99,27 @@ if (! $dh{D_FLAG}) {
        # parameters). Note that you _don't_ quote wildcards used by find
        # in here.
        doit(split(/\s+/,"find . -type f -a
-               ( -name #*# -o -name *~ -o -name DEADJOE
+               ( -name #*# -o -name .*~ -o -name *~ -o -name DEADJOE
                 -o -name *.orig -o -name *.rej -o -name *.bak
                 -o -name .*.orig -o -name .*.rej -o -name .SUMS
                 -o -name TAGS -o -name core -o ( -path */.deps/* -a -name *.P )
-               ) -exec rm -f {} ;"));
+               ) $find_options -exec rm -f {} ;"));
+
+       # Stupid autoconf cache directory.
+       doit("rm", "-rf", "autom4te.cache")
+               unless excludefile("autom4te.cache");
 }
 
-doit('rm', '-rf', 'debian/tmp')
-       if -x 'debian/tmp' && ! Debian::Debhelper::Dh_Lib::compat(1);
+doit('rm', '-rf', 'debian/tmp') if -x 'debian/tmp' && ! compat(1);
+
+=head1 SEE ALSO
+
+L<debhelper(1)>
+
+This program is a part of debhelper.
+
+=head1 AUTHOR
+
+Joey Hess <joeyh@debian.org>
 
+=cut