Fix typo in French translation, about debian/package.README.Debian files.

[debhelper.git] / dh_installdirs

diff --git a/dh_installdirs b/dh_installdirs
index 1ecf907e1d057365385bdf1417e7b7b1a4c02dc5..7e9a17837c1a9d9bfd0167b32fb5bef477538931 100755 (executable)
--- a/dh_installdirs
+++ b/dh_installdirs
@@ -1,36 +1,76 @@
 #!/usr/bin/perl -w
-#
-# Reads debian/dirs, creates the directories listed there
 
+=head1 NAME
+
+dh_installdirs - create subdirectories in package build directories
+
+=cut
+
+use strict;
 use Debian::Debhelper::Dh_Lib;
+
+=head1 SYNOPSIS
+
+B<dh_installdirs> [S<I<debhelper options>>] [B<-A>] [S<I<dir ...>>]
+
+=head1 DESCRIPTION
+
+dh_installdirs is a debhelper program that is responsible for creating
+subdirectories in package build directories.
+
+A file named debian/package.dirs can list directories to be created.
+
+Any directory names specified as parameters will be created in the package
+build directory of the first package dh_installdirs is told to act on. By
+default, this is the first binary package in debian/control, but if you use
+-p, -i, or -a flags, it will be the first package specified by those flags.
+
+=head1 OPTIONS
+
+=over 4
+
+=item B<-A>, B<--all>
+
+Create any directories specified by command line parameters in ALL packages
+acted on, not just the first.
+
+=item I<dir ...>
+
+Create these directories in the package build directory of the first
+package acted on. (Or in all packages if -A is specified.)
+
+=back
+
+=cut
+
 init();
 
-foreach $PACKAGE (@{$dh{DOPACKAGES}}) {
-       $TMP=tmpdir($PACKAGE);
-       $file=pkgfile($PACKAGE,"dirs");
+foreach my $package (@{$dh{DOPACKAGES}}) {
+       my $tmp=tmpdir($package);
+       my $file=pkgfile($package,"dirs");
 
-       if (! -e $TMP) {
-               doit("install","-d",$TMP);
+       if (! -e $tmp) {
+               doit("install","-d",$tmp);
        }
 
-       undef @dirs;
+       my @dirs;
 
        if ($file) {
                @dirs=filearray($file)
        }
 
-       if (($PACKAGE eq $dh{FIRSTPACKAGE} || $dh{PARAMS_ALL}) && @ARGV) {
+       if (($package eq $dh{FIRSTPACKAGE} || $dh{PARAMS_ALL}) && @ARGV) {
                push @dirs, @ARGV;
        }       
 
        if (@dirs) {
-               # Stick the $TMP onto the front of all the dirs.
+               # Stick the $tmp onto the front of all the dirs.
                # This is necessary, for 2 reasons, one to make them 
                # be in the right directory, but more importantly, it 
                # protects against the danger of absolute dirs being
                # specified.
                @dirs=map {
-                               $_="$TMP/$_";
+                               $_="$tmp/$_";
                                tr:/:/:s; # just beautification.
                                $_
                          } @dirs;
@@ -39,3 +79,15 @@ foreach $PACKAGE (@{$dh{DOPACKAGES}}) {
                doit("install","-d",@dirs);
        }
 }
+
+=head1 SEE ALSO
+
+L<debhelper(7)>
+
+This program is a part of debhelper.
+
+=head1 AUTHOR
+
+Joey Hess <joeyh@debian.org>
+
+=cut