]> git.donarmstrong.com Git - debhelper.git/blobdiff - dh_installdocs
r1779: releasing version 4.9.6
[debhelper.git] / dh_installdocs
index 3fe3d0c43c581300e60f7921df4b6a214554eb52..9c12d49d0199b78146b9ba4b31f1582ee81a16b8 100755 (executable)
@@ -20,7 +20,7 @@ documentation into usr/share/doc/package in package build directories.
 
 dh_installdocs automatically installs debian/copyright if it exists. If
 dh_installdocs is acting on multiple packages, debian/copyright files will be
-installed into all packages. However, if you need to have seperate copyright
+installed into all packages. However, if you need to have separate copyright
 files for different binary packages, you can use files named
 debian/package.copyright.
 
@@ -73,6 +73,17 @@ in all packages if B<-A> is specified).
 
 =back
 
+=head1 EXAMPLES
+
+This is an example of a debian/package.docs file:
+
+  README
+  TODO
+  debian/notes-for-maintainers.txt
+  docs/manual.txt
+  docs/manual.pdf
+  docs/manual-html/
+
 =head1 NOTES
 
 Note that dh_installdocs will happily copy entire directory hierarchies if
@@ -88,6 +99,8 @@ instances of the same text to be added to maintainer scripts.
 init();
 
 foreach my $package (@{$dh{DOPACKAGES}}) {
+       next if is_udeb($package);
+       
        my $tmp=tmpdir($package);
        my $file=pkgfile($package,"docs");
 
@@ -114,12 +127,13 @@ foreach my $package (@{$dh{DOPACKAGES}}) {
                }
                foreach my $doc (@docs) {
                        next if excludefile($doc);
+                       next if ! -s $doc && ! compat(4); # ignore empty BUGS, etc
                        if (-d $doc && $exclude) {
                            my ($dir_basename) = basename($doc);
                            # Pity there's no cp --exclude ..
                            my $pwd=`pwd`;
                            chomp $pwd;
-                           complex_doit("cd $doc/.. && find $dir_basename -type f$exclude -exec cp --parents -dp {} $pwd/$tmp/usr/share/doc/$package \\;");
+                           complex_doit("cd $doc/.. && find $dir_basename \\( -type f or -type l \\)$exclude -exec cp --parents -dp {} $pwd/$tmp/usr/share/doc/$package \\;");
                        }
                        else {
                                doit("cp","-a",$doc,"$tmp/usr/share/doc/$package");
@@ -182,6 +196,8 @@ foreach my $package (@{$dh{DOPACKAGES}}) {
                $regexp="(|$regexp)";
        }
        foreach my $fn (grep {/^${regexp}doc-base(\..*)?$/} readdir(DEB)) {
+               # .EX are example files, generated by eg, dh-make
+               next if $fn=~/\.EX$/;
                # Parse the file to get the doc id.
                open (IN, "debian/$fn") || die "Cannot read debian/$fn.";
                while (<IN>) {