Typo. Closes: #653339

[debhelper.git] / dh_clean

diff --git a/dh_clean b/dh_clean
index e20d988f299c32b21b58f6b94e9d754a1758d603..15cdc661266b433827135a252e9409f2be6d86cc 100755 (executable)
--- a/dh_clean
+++ b/dh_clean
@@ -1,5 +1,5 @@
 #!/usr/bin/perl -w
-exit 1;
+
 =head1 NAME
 
 dh_clean - clean up package build directories
@@ -11,21 +11,32 @@ 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 ...>>]
+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
+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 debian/files, and any detritus left behind by other
+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
+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 that.
+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
 
-The debian/clean file can list other files to be removed.
+=item F<debian/clean>
+
+Can list other files to be removed.
+
+=back
 
 =head1 OPTIONS
 
@@ -33,13 +44,7 @@ The debian/clean file can list other files to be removed.
 
 =item B<-k>, B<--keep>
 
-Do not delete debian/files, or files listed in debian/clean. 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.
+This is deprecated, use L<dh_prep(1)> instead.
 
 =item B<-d>, B<--dirs-only>
 
@@ -48,19 +53,27 @@ at all.
 
 =item B<-X>I<item> B<--exclude=>I<item>
 
-Exclude files that contain "item" anywhere in their filename from being
+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 ...>
+=item I<file> ...
 
-Delete these files too.
+Delete these I<file>s too.
 
 =back
 
 =cut
 
-init();
+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);
@@ -73,16 +86,20 @@ foreach my $package (@{$dh{DOPACKAGES}}) {
                # These are all debhelper temp files, and so it is safe to 
                # wildcard them.
                complex_doit("rm -f debian/$ext*.debhelper");
-               
-               if (! $dh{K_FLAG}) {
-                       doit("rm","-f","debian/${ext}debhelper.log");
-               }
        }
        
        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}) {
        if (@ARGV) {
                doit("rm","-f","--",@ARGV);
@@ -118,6 +135,10 @@ if (! $dh{D_FLAG}) {
 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');
+}
+
 =head1 SEE ALSO
 
 L<debhelper(7)>