X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=dh_clean;h=96b8113a8f1e9ca13ae465d0fe3b24fb386e2c9f;hb=30db799db6c5d66e635f03e74edc4b78215e9edd;hp=4b98a6a0430beb72279d59bc1f21bf4f0808b2ab;hpb=f375c254bef045414797dfb9bd55c6ddc7391659;p=debhelper.git

diff --git a/dh_clean b/dh_clean
index 4b98a6a..96b8113 100755
--- a/dh_clean
+++ b/dh_clean
@@ -1,55 +1,127 @@
 #!/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 including debian/files, and any detritus left behind by other
+debhelper commands. It also removes common files that should not appear in a
+debian diff:
+  #*# *~ DEADJOE *.orig *.rej *.SUMS TAGS .deps/* *.P
+
+It does not run "make clean" to clean up after the build process. Use
+L<dh_auto_clean(1)> to do that.
+
+The debian/clean file can list other files to be removed.
+
+=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");
+		
+		# These are all debhelper temp files, and so it is safe to 
+		# wildcard them.
+		complex_doit("rm -f debian/$ext*.debhelper");
 	}
 	
-	doit ("rm","-rf",$TMP);
+	doit ("rm","-rf",$tmp."/")
+		unless excludefile($tmp);
 }
 
 if (! $dh{D_FLAG}) {
 	if (@ARGV) {
 		doit("rm","-f","--",@ARGV);
 	}
+	
+	if (!compat(6) && -e "debian/clean") {
+		my @clean=grep { ! excludefile($_) }
+			filearray("debian/clean", ".");
+		doit("rm","-f","--",@clean) if @clean;
+	}
 
 	if (! $dh{K_FLAG}) {
-		doit("rm","-f","debian/files");
+		doit("rm","-f","debian/files")
+			unless excludefile("debian/files");
 	}
 
 	# See if some files that would normally be deleted are excluded.
-	if (! defined($dh{EXCLUDE_FIND}) || $dh{EXCLUDE_FIND} eq '') {
-		$find_options="";
-	}
-	else {
-		$find_options="-a ! ( $dh{EXCLUDE_FIND} )";
+	my $find_options='';
+	if (defined($dh{EXCLUDE_FIND}) && $dh{EXCLUDE_FIND} ne '') {
+		$find_options="! \\( $dh{EXCLUDE_FIND} \\) -a";
 	}
 
 	# Remove other temp files.
-	# (The \s+ is important, \s won't work because find would get null
-	# 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
-		 -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 {} ;"));
+	complex_doit("find . $find_options \\( \\( -type f -a \\
+	        \\( -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 \\( -path '*/.deps/*' -a -name '*.P' \\) \\
+		\\) -exec rm -f {} \\; \\) -o \\
+		\\( -type d -a -name autom4te.cache -prune -exec rm -rf {} \\; \\) \\)");
 }
 
-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) &&
+                                   ! excludefile("debian/tmp");
+
+=head1 SEE ALSO
+
+L<debhelper(7)>
+
+This program is a part of debhelper.
+
+=head1 AUTHOR
+
+Joey Hess <joeyh@debian.org>
 
+=cut