Typo. Closes: #653339

[debhelper.git] / dh_auto_configure

diff --git a/dh_auto_configure b/dh_auto_configure
index 3f326cef913e41b9a01d093382a7360717c1d665..e1ca7af25b41a1cfcfea733672663e81457ef43a 100755 (executable)
--- a/dh_auto_configure
+++ b/dh_auto_configure
@@ -2,7 +2,7 @@
 
 =head1 NAME
 
-dh_auto_configure - configure and prepare package sources for building
+dh_auto_configure - automatically configure a package prior to building
 
 =cut
 
@@ -11,45 +11,39 @@ use Debian::Debhelper::Dh_Buildsystems;
 
 =head1 SYNOPSIS
 
-B<dh_auto_configure> [S<I<debhelper options>>] [S<I<dh_auto 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 is responsible for the
-I<configure> step of the L<dh_auto(7)> building process. Since I<configure> is
-the first step, typically it is the point when build configuration options
-are set, system settings are detected and various build system specific
-temporary files are pre-generated in the build directory. Some simpler build
-systems do not need this step. In such a case, dh_auto_configure silently
-succeeds without doing anything.
+B<dh_auto_configure> is a debhelper program that tries to automatically
+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 F<./configure> script, F<Makefile.PL>,
+F<Build.PL>, or F<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 B<dh_auto_configure> will exit without
+doing anything.
 
-dh_auto_configure usually pre-configures the source build system with a set of
-standard options which most Debian packages need to set anyway. Custom options
-can be passed as I<params>. If dh_auto_configure does not meet your needs or
-does not work, it is safe to skip/override it entirely and just run a configure
-script or its equivalent manually.
-
-#DH_AUTO SHARED OPTIONS#
+This is intended to work for about 90% of packages. If it doesn't work,
+you're encouraged to skip using B<dh_auto_configure> at all, and just run
+F<./configure> or its equivalent 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 I<params> to the command that is run, after the standard
-parameters that dh_auto_configure passes. This can be used to supplement
-or override those parameters. For example:
+Pass I<params> to the program that is run, after the parameters that
+B<dh_auto_configure> usually passes. For example:
 
   dh_auto_configure -- --with-foo --enable-bar
 
 =back
 
-=head1 SUPPORTED BUILD SYSTEMS
-
-#SUPPORTED BUILD SYSTEMS INTRO#
-#SUPPORTED BUILD SYSTEMS LIST#
-
 =cut
 
 buildsystems_init();
@@ -57,16 +51,12 @@ 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