Typo. Closes: #653339

[debhelper.git] / dh_installmodules

diff --git a/dh_installmodules b/dh_installmodules
index dd75c72b6ff48633508e14278327baab34694f0d..9b3fc2038feac733c6de8f73dcd2fdc404fa8daa 100755 (executable)
--- a/dh_installmodules
+++ b/dh_installmodules
@@ -1,39 +1,134 @@
 #!/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
+
+B<dh_installmodules> [S<I<debhelper options>>] [B<-n>] [B<--name=>I<name>]
+
+=head1 DESCRIPTION
+
+B<dh_installmodules> is a debhelper program that is responsible for
+registering kernel modules.
+
+Kernel modules are searched for in the package build directory and if
+found, F<preinst>, F<postinst> and F<postrm> commands are automatically generated to
+run B<depmod> and register the modules when the package is installed. 
+These commands are inserted into the maintainer scripts by
+L<dh_installdeb(1)>.
+
+=head1 FILES
+
+=over 4
+
+=item debian/I<package>.modprobe
+
+Installed to etc/modprobe.d/I<package>.conf in the package build directory.
+
+=item debian/I<package>.modules
+
+These files were installed for use by modutils, but are now not used
+and B<dh_installmodules> will warn if these files are present.
+
+=back
+
+=head1 OPTIONS
+
+=over 4
+
+=item B<-n>, B<--noscripts>
+
+Do not modify F<preinst>/F<postinst>/F<postrm> scripts.
+
+=item B<--name=>I<name>
+
+When this parameter is used, B<dh_installmodules> looks for and
+installs files named debian/I<package>.I<name>.modprobe instead
+of the usual debian/I<package>.modprobe
+
+=back
+
+=head1 NOTES
+
+Note that this command is not idempotent. L<dh_prep(1)> 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.
+# Looks for kernel modules in the passed directory. If any are found,
+# returns the kernel version (or versions) that the modules seem to be for.
 sub find_kernel_modules {
        my $searchdir=shift;
-       my @results=();
+       my %versions;
 
        return unless -d $searchdir;
-       find(sub { push @results, $_ if /\.o$/ }, $searchdir);
-       return @results > 0;
+       find(sub {
+               if (/\.k?o$/) {
+                       my ($kvers)=$File::Find::dir=~m!lib/modules/([^/]+)/!;
+                       if (! defined $kvers || ! length $kvers) {
+                               warning("Cannot determine kernel version for module $File::Find::name");
+                       }
+                       else {
+                               $versions{$kvers}=1;
+                       }
+               }
+       }, $searchdir);
+
+       return keys %versions;
 }
 
-foreach $PACKAGE (@{$dh{DOPACKAGES}}) {
-       $TMP=tmpdir($PACKAGE);
-       $file=pkgfile($PACKAGE,"modules");
+foreach my $package (@{$dh{DOPACKAGES}}) {
+       my $tmp=tmpdir($package);
+       my $modutils_file=pkgfile($package,"modules");
+       my $modprobe_file=pkgfile($package,"modprobe");
 
-       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 ($modutils_file) {
+               warning("ignoring $modutils_file, since modutils is no longer in Debian");
        }
 
-       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/");
+       if ($modprobe_file) {
+               if (! -e "$tmp/etc/modprobe.d") {
+                       doit("install","-d","$tmp/etc/modprobe.d");
+               }
+               my $old="/etc/modprobe.d/".pkgfilename($package);
+               my $new=$old.".conf";
+               doit("install","-m","0644",$modprobe_file,"$tmp/$new");
+               autoscript($package,"preinst","preinst-moveconffile","s!#OLD#!$old!g;s!#PACKAGE#!$package!g");
+               autoscript($package,"postinst","postinst-moveconffile","s!#OLD#!$old!g;s!#NEW#!$new!g");
+       }
+       
+       if (! $dh{NOSCRIPTS}) {
+               foreach my $kvers (find_kernel_modules("$tmp/lib/modules")) {
+                       autoscript($package,"postinst","postinst-modules","s/#KVERS#/$kvers/g");
+                       autoscript($package,"postrm","postrm-modules","s/#KVERS#/$kvers/g");
+               }
        }
 }
+
+=head1 SEE ALSO
+
+L<debhelper(7)>
+
+This program is a part of debhelper.
+
+=head1 AUTHOR
+
+Joey Hess <joeyh@debian.org>
+
+=cut