X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=dh_auto_clean;h=3abb5f3e31a507b7e126d7e144089b7000042298;hb=fb8f18f4a98669c3b85e1bd7920fbabfc00b886e;hp=625675b8a5b846fb9a2ab9940dcdb78a61d0f1b5;hpb=962a2e10c930e3504ea1c0327be2fdf70d53023e;p=debhelper.git

diff --git a/dh_auto_clean b/dh_auto_clean
index 625675b..3abb5f3 100755
--- a/dh_auto_clean
+++ b/dh_auto_clean
@@ -2,63 +2,59 @@
 
 =head1 NAME
 
-dh_auto_clean - clean temporary files after building package sources
+dh_auto_clean - automatically cleans up after a build
 
 =cut
 
 use strict;
+use Debian::Debhelper::Dh_Lib;
 use Debian::Debhelper::Dh_Buildsystems;
 
 =head1 SYNOPSIS
 
-B<dh_auto_clean> [S<I<debhelper options>>] [S<I<dh_auto options>>] [S<B<--> I<params>>]
+B<dh_auto_clean> [S<I<build system options>>] [S<I<debhelper options>>] [S<B<--> I<params>>]
 
 =head1 DESCRIPTION
 
-dh_auto_clean is a debhelper program that is responsible for the I<clean> step
-of the L<dh_auto(7)> building process. It tries to automatically clean up after
-a package build by removing all temporary files from the build directory or
-even the build directory itself as appropriate. dh_auto_clean will fail only if
-the source build system clean routine fails. However, if the latter does not
-exist or there is nothing to clean it will exit with zero status doing nothing.
+B<dh_auto_clean> is a debhelper program that tries to automatically clean up
+after a package build. It does so by running the appropriate command for
+the build system it detects the package uses. For example, if there's a
+F<Makefile> and it contains a B<distclean>, B<realclean>, or B<clean> target,
+then this is done by running B<make> (or B<MAKE>, if the environment variable is
+set). If there is a F<setup.py> or F<Build.PL>, it is run to clean the package.
 
-If dh_auto_clean does not meet your needs or does not work, it is safe to
-skip/override it entirely and just run clean up manually.
-
-#DH_AUTO SHARED OPTIONS#
+This is intended to work for about 90% of packages. If it doesn't work, or
+tries to use the wrong clean target, you're encouraged to skip using
+B<dh_auto_clean> at all, and just run B<make clean> manually.
 
 =head1 OPTIONS
 
+See L<debhelper(7)/B<BUILD SYSTEM OPTIONS>> for a list of common build
+system selection and control options.
+
 =over 4
 
 =item B<--> I<params>
 
-Pass "params" to the program that is run. These can be used to supplement
-or override the any standard parameters that dh_auto_clean passes.
+Pass I<params> to the program that is run, after the parameters that
+B<dh_auto_clean> usually passes.
 
 =back
 
-=head1 SUPPORTED BUILD SYSTEMS
-
-#SUPPORTED BUILD SYSTEMS INTRO#
-#SUPPORTED BUILD SYSTEMS LIST#
-
 =cut
 
+inhibit_log();
 buildsystems_init();
 buildsystems_do();
 
 =head1 SEE ALSO
 
-L<dh_auto(7)>
-
 L<debhelper(7)>
 
-This program is a part of debhelper and its dh_auto package source building suite.
+This program is a part of debhelper.
 
-=head1 AUTHORS
+=head1 AUTHOR
 
- Joey Hess <joeyh@debian.org>
- Modestas Vainius <modestas@vainius.eu>
+Joey Hess <joeyh@debian.org>
 
 =cut