Merge branch 'master' into buildsystems

[debhelper.git] / dh_auto_install

diff --git a/dh_auto_install b/dh_auto_install
index db2c6e900f050ca275f6ce69e0c8641e41ce5c26..5c7722454a96c9e67225ac50973bc181366187e9 100755 (executable)
--- a/dh_auto_install
+++ b/dh_auto_install
@@ -2,7 +2,7 @@
 
 =head1 NAME
 
-dh_auto_install - automatically runs make install or similar
+dh_auto_install - install built files into the temporary directory under debian/
 
 =cut
 
@@ -13,14 +13,15 @@ use Cwd;
 
 =head1 SYNOPSIS
 
-B<dh_auto_install> [S<I<debhelper options>>] [S<B<--> I<params>>]
+B<dh_auto_install> [S<I<debhelper options>>] [S<I<dh_auto options>>] [S<B<--> I<params>>]
 
 =head1 DESCRIPTION
 
-dh_auto_install is a debhelper program that tries to automatically install
-built files. If there's a Makefile and it contains a "install" 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 used.
+dh_auto_install is a debhelper program that is responsible for the I<install>
+step of the L<dh_auto(7)> building process. dh_auto_install tries to run
+original package installation routine to install built files into the proper
+places of the file system hierarchy recreated under the (temporary) directory
+in debian/.
 
 The files are installed into debian/<package>/ if there is only one binary
 package. In the multiple binary package case, the files are instead
@@ -28,13 +29,10 @@ installed into debian/tmp/, and should be moved from there to the
 appropriate package build directory using L<dh_install(1)> or
 L<dh_movefiles(1)>.
 
-DESTDIR is used to tell make where to install the files. 
-If the Makefile was generated by MakeMaker from a Makefile.PL, it will
-automatically set PREFIX=/usr too, since such Makefiles need that.
+If dh_auto_install does not meet your needs or does not work, it is safe to
+skip/override it entirely and just run C<make install> or the like manually.
 
-This is intended to work for about 90% of packages. If it doesn't work, or
-tries to use the wrong install target, you're encouraged to skip using
-dh_auto_install at all, and just run make install manually.
+#DH_AUTO SHARED OPTIONS#
 
 =head1 OPTIONS
 
@@ -47,6 +45,11 @@ or override the any standard parameters that dh_auto_install passes.
 
 =back
 
+=head1 SUPPORTED BUILD SYSTEMS
+
+#SUPPORTED BUILD SYSTEMS INTRO#
+#SUPPORTED BUILD SYSTEMS LIST#
+
 =cut
 
 buildsystems_init();
@@ -65,12 +68,16 @@ buildsystems_do("install", $destdir);
 
 =head1 SEE ALSO
 
+L<dh_auto(7)>
+
 L<debhelper(7)>
 
-This program is a part of debhelper.
+This program is a part of debhelper and its dh_auto package source building
+suite.
 
-=head1 AUTHOR
+=head1 AUTHORS
 
-Joey Hess <joeyh@debian.org>
+ Joey Hess <joeyh@debian.org>
+ Modestas Vainius <modestas@vainius.eu>
 
 =cut