r544: minor copyright updates

[debhelper.git] / dh_installchangelogs

diff --git a/dh_installchangelogs b/dh_installchangelogs
index 2a82442b12fe8c2554cc9257222b3d2f7e07faaa..2588d57f476a6a8bde51d3ee5c5d188fa13b740e 100755 (executable)
--- a/dh_installchangelogs
+++ b/dh_installchangelogs
@@ -1,14 +1,69 @@
 #!/usr/bin/perl -w
-#
-# Installs debian/changelog. If another filename is passed to it, installs
-# that file as the upstream changelog.
-#
-# Looks at debian/control to determine if this is a native debian package,
-# if so, the debian changelog is just installed as "changelog", and it is an 
-# error to specify an upstream changelog on the command line.
+
+=head1 NAME
+
+dh_installchangelogs - install changelogs into package build directories
+
+=cut
 
 use strict;
 use Debian::Debhelper::Dh_Lib;
+
+=head1 SYNOPSIS
+
+B<dh_installchangelogs> [<S<I<debhelper options>>] [B<-k>] [I<upstream>]
+
+=head1 DESCRIPTION
+
+dh_installchangelogs is a debhelper program that is responsible for
+installing changelogs into package build directories.
+
+dh_installchangelogs determines if the package is a debian native package,
+and if so, it installs debian/changelog into usr/share/doc/package/changelog
+in the package build directory. Otherwise, it installs debian/changelog
+into usr/share/doc/package/changelog.Debian in the package build directory. (If
+files named debian/package.changelog exist, they will be used in preference
+to debian/changelog.)
+
+Parallelling the debian changelog handling, this program also takes care of
+debian NEWS files. If there is a debian/NEWS file, it is installed as
+usr/share/doc/package/NEWS for native packages, and as
+usr/share/doc/package/NEWS.Debian for non-native packages. debian/package.NEWS
+files can also be used.
+
+If an upstream changelog file is specified as an option, and the package is
+not a native debian package, then this upstream changelog will be installed
+as usr/share/doc/package/changelog in the package build directory. If the
+changelog is a html file (determined by file extension), it will be
+installed as usr/share/doc/package/changelog.html instead, and will be
+converted to plain text with html2text to generate
+usr/share/doc/package/changelog.
+
+=head1 OPTIONS
+
+=over 4
+
+=item B<-k>, B<--keep>
+
+Keep the original name of the upstream changelog. This will be accomplished
+by installing the upstream changelog as "changelog", and making a symlink from
+that to the original name of the changelog file. This can be useful if the
+upstream changelog has an unusual name, or if other documentation in the
+package refers to the changelog file.
+
+=item I<upstream>
+
+Install this file as the upstream changelog.
+
+=back
+
+=head1 NOTES
+
+It is an error to specify an upstream changelog file for a debian native
+package.
+
+=cut
+
 init();
 
 my $upstream=shift;
@@ -18,17 +73,23 @@ if (isnative($dh{MAINPACKAGE}) && defined $upstream) {
 }
 
 my $changelog_name="changelog.Debian";
+my $news_name="NEWS.Debian";
 if (isnative($dh{MAINPACKAGE})) {
        $changelog_name='changelog';
+       $news_name='NEWS';
 }
 
 foreach my $package (@{$dh{DOPACKAGES}}) {
        my $tmp=tmpdir($package);
        my $changelog=pkgfile($package,"changelog");
+       my $news=pkgfile($package,"NEWS");
 
        if (!$changelog) {
                $changelog="debian/changelog";
        }
+       if (!$news) {
+               $news="debian/NEWS";
+       }
 
        if (! -e $changelog) {
                error("could not find changelog $changelog");
@@ -44,6 +105,10 @@ foreach my $package (@{$dh{DOPACKAGES}}) {
        }
        doit("install","-o",0,"-g",0,"-p","-m644",$changelog,
                "$tmp/usr/share/doc/$package/$changelog_name");
+       if (-e $news) {
+               doit("install","-o",0,"-g",0,"-p","-m644",$news,
+                       "$tmp/usr/share/doc/$package/$news_name");
+       }
 
        if ($upstream) {
                my $link_to;
@@ -51,7 +116,7 @@ foreach my $package (@{$dh{DOPACKAGES}}) {
                        # HTML changelog
                        doit("install","-o",0,"-g",0,"-p","-m644",
                                $upstream,"$tmp/usr/share/doc/$package/changelog.html");
-                       complex_doit("lynx -dump $upstream > $tmp/usr/share/doc/$package/changelog");
+                       doit("html2text","-nobs","-o","$tmp/usr/share/doc/$package/changelog",$upstream);
                        $link_to='changelog.html';
                }
                else {
@@ -66,3 +131,15 @@ foreach my $package (@{$dh{DOPACKAGES}}) {
                }
        }
 }
+
+=head1 SEE ALSO
+
+L<debhelper(1)>
+
+This program is a part of debhelper.
+
+=head1 AUTHOR
+
+Joey Hess <joeyh@debian.org>
+
+=cut