X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=dh_clean;h=b0936ecb31fc25c51fc696430fb1900ec6c632b7;hb=72f66a4938c8544e295dc19ec57a09563300b56e;hp=c25dbde7152b86e2337ddad9a33d056f385f2cbb;hpb=053f6f8b4e7431d32511aef209188a084e8c7e79;p=debhelper.git

diff --git a/dh_clean b/dh_clean
index c25dbde..b0936ec 100755
--- a/dh_clean
+++ b/dh_clean
@@ -1,10 +1,60 @@
 #!/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 my $package (@{$dh{DOPACKAGES}}) {
@@ -12,14 +62,12 @@ foreach my $package (@{$dh{DOPACKAGES}}) {
 	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}) {
@@ -28,9 +76,18 @@ 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 '') {
@@ -42,12 +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 )
 		) $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' && ! compat(1);
 
+=head1 SEE ALSO
+
+L<debhelper(7)>
+
+This program is a part of debhelper.
+
+=head1 AUTHOR
+
+Joey Hess <joeyh@debian.org>
+
+=cut