r495: * dh_undocumented: check for existing uncompressed man pages. Closes: #87972

[debhelper.git] / dh_installmodules

diff --git a/dh_installmodules b/dh_installmodules
index dd75c72b6ff48633508e14278327baab34694f0d..f17780a3b8d33eb7583501f4794ea5fdd34c562d 100755 (executable)
--- a/dh_installmodules
+++ b/dh_installmodules
@@ -1,9 +1,52 @@
 #!/usr/bin/perl -w
-#
-# Register modules with modutils.
 
+=head1 NAME
+
+dh_installmodules - register modules with modutils
+
+
+=cut
+
+use strict;
 use Debian::Debhelper::Dh_Lib;
 use File::Find;
+
+=head1 SYNOPSIS
+
+  dh_installmodules [debhelper options] [-n]
+
+=head1 DESCRIPTION
+
+dh_installmodules is a debhelper program that is responsible for
+registering kernel modules with modutils.
+
+Files named debian/package.modules will be installed as
+etc/modutils/package in the package build directory.
+
+Then postinst and postrm commands are automatically generated to register
+the modules when the package is installed. See L<dh_installdeb(1)> for an
+explanation of how this works. Note that this will be done for any
+package this program acts on which has either the above-mentioned file, or
+has .o files in /lib/modules.
+
+=head1 OPTIONS
+
+=over 4
+
+=item B<-n>, B<--noscripts>
+
+Do not modify postinst/postrm scripts.
+
+=back
+
+=head1 NOTES
+
+Note that this command is not idempotent. "dh_clean -k" should be called
+between invocations of this command. Otherwise, it may cause multiple
+instances of the same text to be added to maintainer scripts.
+
+=cut
+
 init();
 
 # Returns true if there are any .o files in the passed directory.
@@ -16,24 +59,36 @@ sub find_kernel_modules {
        return @results > 0;
 }
 
-foreach $PACKAGE (@{$dh{DOPACKAGES}}) {
-       $TMP=tmpdir($PACKAGE);
-       $file=pkgfile($PACKAGE,"modules");
+foreach my $package (@{$dh{DOPACKAGES}}) {
+       my $tmp=tmpdir($package);
+       my $file=pkgfile($package,"modules");
 
-       if (! -e $TMP) {
-               doit("install","-d",$TMP);
+       if (! -e $tmp) {
+               doit("install","-d",$tmp);
        }
 
        if ($file) {
-               if (! -e "$TMP/etc/modutils") {
-                       doit("install","-d","$TMP/etc/modutils");
-                       doit("install","-m","0644",$file,"$TMP/etc/modutils/$PACKAGE");
+               if (! -e "$tmp/etc/modutils") {
+                       doit("install","-d","$tmp/etc/modutils");
                }
+               doit("install","-m","0644",$file,"$tmp/etc/modutils/$package");
        }
 
        if (! $dh{NOSCRIPTS} &&
-           ($file || find_kernel_modules("$TMP/lib/modules"))) {
-                       autoscript($PACKAGE,"postinst","postinst-modules","s/#PACKAGE#/$PACKAGE/");
-                       autoscript($PACKAGE,"postrm","postrm-modules","s/#PACKAGE#/$PACKAGE/");
+           ($file || find_kernel_modules("$tmp/lib/modules"))) {
+                       autoscript($package,"postinst","postinst-modules","s/#PACKAGE#/$package/");
+                       autoscript($package,"postrm","postrm-modules","s/#PACKAGE#/$package/");
        }
 }
+
+=head1 SEE ALSO
+
+L<debhelper(1)>
+
+This program is a part of debhelper.
+
+=head1 AUTHOR
+
+Joey Hess <joeyh@debian.org>
+
+=cut