summaryrefslogtreecommitdiff
path: root/dh_auto_build
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_build
parente0ed03ff224ee3a8053094f02bcd02d4dd3fa358 (diff)
minimal build system option documentation
Diffstat (limited to 'dh_auto_build')
-rwxr-xr-xdh_auto_build14
1 files changed, 9 insertions, 5 deletions
diff --git a/dh_auto_build b/dh_auto_build
index 56b9b5f0..250c7d93 100755
--- a/dh_auto_build
+++ b/dh_auto_build
@@ -11,14 +11,15 @@ use Debian::Debhelper::Dh_Buildsystems;
=head1 SYNOPSIS
-B<dh_auto_build> [S<I<debhelper options>>] [S<B<--> I<params>>]
+B<dh_auto_build> [S<I<build system options>>] [S<I<debhelper options>>] [S<B<--> I<params>>]
=head1 DESCRIPTION
-dh_auto_build is a debhelper program that tries to automatically
-build a package. If a Makefile is found, this is done by running make (or
-MAKE, if the environment variable is set).
-If there's a setup.py, or Build.PL, it is run to build the package.
+dh_auto_build is a debhelper program that tries to automatically build a
+package. It does so by running the appropriate command for the build system
+it detects the package uses. For example, if a Makefile is found, this is
+done by running make (or MAKE, if the environment variable is set). If
+there's a setup.py, or Build.PL, it is run to build the package.
This is intended to work for about 90% of packages. If it doesn't work,
you're encouraged to skip using dh_auto_build at all, and just run the
@@ -26,6 +27,9 @@ build process 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>