Typo. Closes: #653339

[debhelper.git] / dh_auto_install

diff --git a/dh_auto_install b/dh_auto_install
index 5c7722454a96c9e67225ac50973bc181366187e9..d513f2e223095ac99e4f1ccf5caf54e13f34752c 100755 (executable)
--- a/dh_auto_install
+++ b/dh_auto_install
@@ -2,82 +2,94 @@
 
 =head1 NAME
 
-dh_auto_install - install built files into the temporary directory under debian/
+dh_auto_install - automatically runs make install or similar
 
 =cut
 
 use strict;
 use Debian::Debhelper::Dh_Lib;
 use Debian::Debhelper::Dh_Buildsystems;
+use File::Spec;
 use Cwd;
 
 =head1 SYNOPSIS
 
-B<dh_auto_install> [S<I<debhelper options>>] [S<I<dh_auto options>>] [S<B<--> I<params>>]
+B<dh_auto_install> [S<I<build system options>>] [S<I<debhelper options>>] [S<B<--> I<params>>]
 
 =head1 DESCRIPTION
 
-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/.
+B<dh_auto_install> is a debhelper program that tries to automatically install
+built files. It does so by running the appropriate command for the build
+system it detects the package uses. For example, if there's a F<Makefile> and
+it contains a B<install> target, then this is done by running B<make> (or B<MAKE>,
+if the environment variable is set). If there is a F<setup.py> or F<Build.PL>,
+it is used. Note that the Ant build system does not support installation,
+so B<dh_auto_install> will not install files built using Ant.
 
-The files are installed into debian/<package>/ if there is only one binary
-package. In the multiple binary package case, the files are instead
-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)>.
+Unless B<--destdir> option is specified, the files are installed into
+debian/I<package>/ if there is only one binary package. In the multiple binary
+package case, the files are instead installed into F<debian/tmp/>, and should be
+moved from there to the appropriate package build directory using
+L<dh_install(1)>.
 
-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.
+B<DESTDIR> is used to tell make where to install the files. 
+If the Makefile was generated by MakeMaker from a F<Makefile.PL>, it will
+automatically set B<PREFIX=/usr> too, since such Makefiles need that.
 
-#DH_AUTO SHARED OPTIONS#
+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
+B<dh_auto_install> at all, and just run make install 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>
+=item B<--destdir=>I<directory>
 
-Pass "params" to the program that is run. These can be used to supplement
-or override the any standard parameters that dh_auto_install passes.
+Install files into the specified I<directory>. If this option is not specified,
+destination directory is determined automatically as described in the
+L</B<DESCRIPTION>> section.
 
-=back
+=item B<--> I<params>
 
-=head1 SUPPORTED BUILD SYSTEMS
+Pass I<params> to the program that is run, after the parameters that
+B<dh_auto_install> usually passes.
 
-#SUPPORTED BUILD SYSTEMS INTRO#
-#SUPPORTED BUILD SYSTEMS LIST#
+=back
 
 =cut
 
-buildsystems_init();
-
 my $destdir;
-my @allpackages=getpackages();
-if (@allpackages > 1) {
-       $destdir="debian/tmp";
-}
-else {
-       $destdir=tmpdir($dh{MAINPACKAGE});
+
+buildsystems_init(options => {
+       "destdir=s" => \$destdir,
+});
+
+# If destdir is not specified, determine it automatically
+if (!$destdir) {
+       my @allpackages=getpackages();
+       if (@allpackages > 1) {
+               $destdir="debian/tmp";
+       }
+       else {
+               $destdir=tmpdir($dh{MAINPACKAGE});
+       }
 }
-$destdir=cwd()."/".$destdir;
+$destdir = File::Spec->rel2abs($destdir, cwd());
 
 buildsystems_do("install", $destdir);
 
 =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