r427: converting to pod is getting old..

[debhelper.git] / dh_gencontrol

diff --git a/dh_gencontrol b/dh_gencontrol
index 15e082034d6e35fa19d4b9af7ecb8097525c458c..0c8c88a29180379861222eb3ca4eca21eaffbeaa 100755 (executable)
--- a/dh_gencontrol
+++ b/dh_gencontrol
@@ -1,30 +1,72 @@
 #!/usr/bin/perl -w
-#
-# Generate and install the control file. Simple dpkg-gencontrol wrapper.
 
+=head1 NAME
+
+dh_gencontrol - generate and install control file
+
+=cut
+
+use strict;
 use Debian::Debhelper::Dh_Lib;
+
+=head1 SYNOPSIS
+
+  dh_gencontrol [debhelper options] [-uparams] [-- params]
+
+=head1 DESCRIPTION
+
+dh_gencontrol is a debhelper program that is responsible for generating
+control files, and installing them into the DEBIAN directory with the
+proper permissions.
+
+This program is merely a wrapper around L<dpkg-gencontrol(1)>.
+
+=head1 OPTIONS
+
+=over 4
+
+=item B<-u>I<params>, B<--dpkg-gencontrol-params>I<params>
+=item B<--> I<params>
+
+Pass "params" to L<dpkg-gencontrol(1)>.
+
+=back
+
+=cut
+
 init();
 
-foreach $PACKAGE (@{$dh{DOPACKAGES}}) {
-       $TMP=tmpdir($PACKAGE);
-       $EXT=pkgext($PACKAGE);
+foreach my $package (@{$dh{DOPACKAGES}}) {
+       my $tmp=tmpdir($package);
+       my $ext=pkgext($package);
        
-       $changelog=pkgfile($PACKAGE,'changelog');
+       my $changelog=pkgfile($package,'changelog');
        if (! $changelog) {
                $changelog='debian/changelog';
        }
 
-       if ( ! -d '$TMP/DEBIAN' ) {
-               doit("install","-o",0,"-g",0,"-d","$TMP/DEBIAN");
+       if ( ! -d "$tmp/DEBIAN" ) {
+               doit("install","-o",0,"-g",0,"-d","$tmp/DEBIAN");
        }
 
        # Generate and install control file.
-       doit("dpkg-gencontrol","-l$changelog","-isp","-p$PACKAGE",
-               "-Tdebian/${EXT}substvars","-P$TMP",@{$dh{U_PARAMS}});
+       doit("dpkg-gencontrol","-l$changelog","-isp","-p$package",
+               "-Tdebian/${ext}substvars","-P$tmp",@{$dh{U_PARAMS}});
 
        # This chmod is only necessary if the user sets the umask to something odd.
-       doit("chmod","644","$TMP/DEBIAN/control");
+       doit("chmod","644","$tmp/DEBIAN/control");
        
-       doit("chown","0.0","$TMP/DEBIAN/control");
+       doit("chown","0.0","$tmp/DEBIAN/control");
 }
 
+=head1 SEE ALSO
+
+L<debhelper(1)>
+
+This program is a part of debhelper.
+
+=head1 AUTHOR
+
+Joey Hess <joeyh@debian.org>
+
+=cut