summaryrefslogtreecommitdiff
path: root/dh_auto_clean
diff options
context:
space:
mode:
authorJoey Hess <joey@gnu.kitenet.net>2009-06-28 15:40:15 -0400
committerJoey Hess <joey@gnu.kitenet.net>2009-06-28 15:40:15 -0400
commit93c1062bc3ee340fcd7318e91fe9758d86b760f3 (patch)
tree5ca5f93c23c84fb2c3f0ce3a4199e57c01f422d3 /dh_auto_clean
parente0ed03ff224ee3a8053094f02bcd02d4dd3fa358 (diff)
minimal build system option documentation
Diffstat (limited to 'dh_auto_clean')
-rwxr-xr-xdh_auto_clean14
1 files changed, 9 insertions, 5 deletions
diff --git a/dh_auto_clean b/dh_auto_clean
index 1b7d46c..8603b11 100755
--- a/dh_auto_clean
+++ b/dh_auto_clean
@@ -11,15 +11,16 @@ use Debian::Debhelper::Dh_Buildsystems;
=head1 SYNOPSIS
-B<dh_auto_clean> [S<I<debhelper 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 tries to automatically clean up
-after a package build. If there's a Makefile and it contains a "distclean",
-"realclean", or "clean" target, then this is done by running make (or MAKE,
-if the environment variable is set). If there is a setup.py or Build.PL, it
-is run to clean the package.
+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
+Makefile and it contains a "distclean", "realclean", or "clean" target,
+then this is done by running make (or MAKE, if the environment variable is
+set). If there is a setup.py or Build.PL, it is run to clean the package.
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
@@ -27,6 +28,9 @@ dh_auto_clean at all, and just run make clean manually.
=head1 OPTIONS
+See L<debhelper(7)/BUILD SYSTEM OPTIONS> for a list of common build
+system selection and control options.
+
=over 4
=item B<--> I<params>