X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=dh_installchangelogs;h=9ce6dc10bf30fb696c1ed5f1eeb201d3776bd339;hb=a155491c23c692bb7cd38d7df19c1e41c701236b;hp=187e134c4cec578e9f76460106c57568dd1bdc4a;hpb=37c69d4e7124fb03edf46bea4eb38f6721f2aa2a;p=debhelper.git

diff --git a/dh_installchangelogs b/dh_installchangelogs
index 187e134..9ce6dc1 100755
--- a/dh_installchangelogs
+++ b/dh_installchangelogs
@@ -1,63 +1,135 @@
 #!/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.
-
-BEGIN { push @INC, "debian", "/usr/share/debhelper" }
-use Dh_Lib;
-init();
 
-$upstream=shift;
+=head1 NAME
 
-if (isnative($dh{MAINPACKAGE}) && defined $upstream) {
-	error("Cannot specify an upstream changelog for a native debian package.");
-}
+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
+NEWS.Debian files. If there is a debian/NEWS file, it is installed as
+usr/share/doc/package/NEWS.Debian. debian/package.NEWS files can also be
+used.
+
+If an upstream changelog file is specified as an option, 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>
 
-if (isnative($dh{MAINPACKAGE})) {
+Install this file as the upstream changelog.
+
+=back
+
+=cut
+
+init();
+
+my $upstream=shift;
+
+my $changelog_name="changelog.Debian";
+if (isnative($dh{MAINPACKAGE}) && ! defined $upstream) {
 	$changelog_name='changelog';
 }
-else {
-	$changelog_name='changelog.Debian';
-}
+my $news_name="NEWS.Debian";
 
-foreach $PACKAGE (@{$dh{DOPACKAGES}}) {
-	$TMP=tmpdir($PACKAGE);
-	$changelog=pkgfile($PACKAGE,"changelog");
+foreach my $package (@{$dh{DOPACKAGES}}) {
+	next if is_udeb($package);
+	
+	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");
 	}
 
-	if (! -d "$TMP/usr/share/doc/$PACKAGE") {
-		doit("install","-d","$TMP/usr/share/doc/$PACKAGE");
+	if (! -d "$tmp/usr/share/doc/$package") {
+		# If it is a dangling symlink, then don't do anything.
+		# Think multi-binary packages that depend on each other and
+		# want to link doc dirs.
+		next if -l "$tmp/usr/share/doc/$package";
+
+		doit("install","-d","$tmp/usr/share/doc/$package");
+	}
+	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");
 	}
-	doit("install","-o","root","-g","root","-p","-m644",$changelog,
-		"$TMP/usr/share/doc/$PACKAGE/$changelog_name");
 
 	if ($upstream) {
+		my $link_to;
 		if ($upstream=~m/\.html?$/i) {
 			# HTML changelog
-			doit("install","-o","root","-g","root","-p","-m644",
-				$upstream,"$TMP/usr/share/doc/$PACKAGE/changelog.html");
-			doit("ln", "-sf", 'changelog.html',
-				"$TMP/usr/share/doc/$PACKAGE/changelog");
+			doit("install","-o",0,"-g",0,"-p","-m644",
+				$upstream,"$tmp/usr/share/doc/$package/changelog.html");
+			doit("html2text","-nobs","-o","$tmp/usr/share/doc/$package/changelog",$upstream);
+			$link_to='changelog.html';
 		}
 		else {
-			doit("install","-o","root","-g","root","-p","-m644",
-				$upstream,"$TMP/usr/share/doc/$PACKAGE/changelog");
+			doit("install","-o",0,"-g",0,"-p","-m644",
+				$upstream,"$tmp/usr/share/doc/$package/changelog");
+			$link_to='changelog';
 		}
 		if ($dh{K_FLAG}) {
 			# Install symlink to original name of the upstream changelog file.
 			# Use basename in case original file was in a subdirectory or something.
-			doit("ln","-sf","changelog","$TMP/usr/share/doc/$PACKAGE/".Dh_Lib::basename($upstream));
+			doit("ln","-sf",$link_to,"$tmp/usr/share/doc/$package/".basename($upstream));
 		}
 	}
 }
+
+=head1 SEE ALSO
+
+L<debhelper(7)>
+
+This program is a part of debhelper.
+
+=head1 AUTHOR
+
+Joey Hess <joeyh@debian.org>
+
+=cut