X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=dh_clean;h=15cdc661266b433827135a252e9409f2be6d86cc;hb=e2a6d4cec4a7ee952cf6a7f250d80f1d75a38f95;hp=4b98a6a0430beb72279d59bc1f21bf4f0808b2ab;hpb=f375c254bef045414797dfb9bd55c6ddc7391659;p=debhelper.git

diff --git a/dh_clean b/dh_clean
index 4b98a6a..15cdc66 100755
--- a/dh_clean
+++ b/dh_clean
@@ -1,24 +1,103 @@
 #!/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;
-init();
 
-foreach $PACKAGE (@{$dh{DOPACKAGES}}) {
-	$TMP=tmpdir($PACKAGE);
-	$EXT=pkgext($PACKAGE);
+=head1 SYNOPSIS
+
+B<dh_clean> [S<I<debhelper options>>] [B<-k>] [B<-d>] [B<-X>I<item>] [S<I<file> ...>]
+
+=head1 DESCRIPTION
+
+B<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 F<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 *-stamp
+
+It does not run "make clean" to clean up after the build process. Use
+L<dh_auto_clean(1)> to do things like that.
+
+B<dh_clean> (or "B<dh clean>") should be the last debhelper command run in the
+B<clean> target in F<debian/rules>.
+
+=head1 FILES
+
+=over 4
+
+=item F<debian/clean>
+
+Can list other files to be removed.
+
+=back
+
+=head1 OPTIONS
+
+=over 4
+
+=item B<-k>, B<--keep>
+
+This is deprecated, use L<dh_prep(1)> instead.
+
+=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 I<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 I<file>s too.
+
+=back
+
+=cut
+
+init(options => {
+	"dirs-only" => \$dh{D_FLAG},
+});
+inhibit_log();
+
+if ($dh{K_FLAG}) {
+	# dh_prep will be emulated (mostly) by the code below.
+	warning("dh_clean -k is deprecated; use dh_prep instead");
+}
+
+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);
+}
+
+# Remove all debhelper logs.
+if (! $dh{D_FLAG} && ! $dh{K_FLAG}) {
+	complex_doit("rm","-f","debian/*.debhelper.log");
+	if (compat(1)) {
+		doit("rm","-f","debian/debhelper.log");
+	}
 }
 
 if (! $dh{D_FLAG}) {
@@ -27,29 +106,47 @@ if (! $dh{D_FLAG}) {
 	}
 
 	if (! $dh{K_FLAG}) {
-		doit("rm","-f","debian/files");
+		if (!compat(6) && -e "debian/clean") {
+			my @clean=grep { ! excludefile($_) }
+				filearray("debian/clean", ".");
+			doit("rm","-f","--",@clean) if @clean;
+		}
+
+		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' && ! compat(1) &&
+                                   ! excludefile("debian/tmp");
+
+if (!compat(6) && !$dh{K_FLAG}) {
+	complex_doit('rm -f *-stamp');
 }
 
-doit('rm', '-rf', 'debian/tmp')
-	if -x 'debian/tmp' && ! Debian::Debhelper::Dh_Lib::compat(1);
+=head1 SEE ALSO
+
+L<debhelper(7)>
+
+This program is a part of debhelper.
+
+=head1 AUTHOR
+
+Joey Hess <joeyh@debian.org>
 
+=cut