summaryrefslogtreecommitdiff
path: root/dh_auto_configure
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_configure
parente0ed03ff224ee3a8053094f02bcd02d4dd3fa358 (diff)
minimal build system option documentation
Diffstat (limited to 'dh_auto_configure')
-rwxr-xr-xdh_auto_configure16
1 files changed, 11 insertions, 5 deletions
diff --git a/dh_auto_configure b/dh_auto_configure
index 34d6298..4a8c28c 100755
--- a/dh_auto_configure
+++ b/dh_auto_configure
@@ -11,15 +11,18 @@ use Debian::Debhelper::Dh_Buildsystems;
=head1 SYNOPSIS
-B<dh_auto_configure> [S<I<debhelper options>>] [S<B<--> I<params>>]
+B<dh_auto_configure> [S<I<build system options>>] [S<I<debhelper options>>] [S<B<--> I<params>>]
=head1 DESCRIPTION
dh_auto_configure is a debhelper program that tries to automatically
-configure a package prior to building. It looks for and runs a ./configure
-script, Makefile.PL, Build.PL, or cmake. A standard set of parameters is
-determined and passed to the program that is run. If no program to run is
-found, dh_auto_configure will exit without doing anything.
+configure a package prior to building. It does so by running the
+appropriate command for the build system it detects the package uses.
+For example, it looks for and runs a ./configure script, Makefile.PL,
+Build.PL, or cmake. A standard set of parameters is determined and passed
+to the program that is run. Some build systems, such as make, do not
+need a configure step; for these dh_auto_configure will exit without
+doing anything.
This is intended to work for about 90% of packages. If it doesn't work,
you're encouraged to skip using dh_auto_configure at all, and just run
@@ -29,6 +32,9 @@ you're encouraged to skip using dh_auto_configure at all, and just run
=over 4
+See L<debhelper(7)/BUILD SYSTEM OPTIONS> for a list of common build
+system selection and control options.
+
=item B<--> I<params>
Pass "params" to the program that is run, after the standard