=head1 SYNOPSIS
-B<dh_installchangelogs> [<S<I<debhelper options>>] [B<-k>] [I<upstream>]
+B<dh_installchangelogs> [S<I<debhelper options>>] [B<-k>] [B<-X>I<item>] [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
+An upstream changelog file may be specified as an option. If none is
+specified, a few common filenames are tried. (In compatibility level 7 and
+above.)
+
+If there is an upstream changelog file, it will be 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 FILES
+
+=over 4
+
+=item debian/changelog
+
+=item debian/NEWS
+
+=item debian/I<package>.changelog
+
+=item debian/I<package>.NEWS
+
+Automatically installed into usr/share/doc/I<package>/
+in the package build directory.
+
+Use the package specific name if I<package> needs a different
+NEWS or changelog file.
+
+The changelog file is installed with a name of changelog
+for native packages, and changelog.Debian for non-native packages.
+The NEWS file is always installed with a name of NEWS.Debian.
+
+=back
+
=head1 OPTIONS
=over 4
upstream changelog has an unusual name, or if other documentation in the
package refers to the changelog file.
+=item B<-Xitem>, B<--exclude=item>
+
+Exclude upstream changelog files that contain "item" anywhere in their
+filename from being installed.
+
=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;
-
-if (isnative($dh{MAINPACKAGE}) && defined $upstream) {
- error("Cannot specify an upstream changelog for a native debian package.");
-}
-
my $changelog_name="changelog.Debian";
-my $news_name="NEWS.Debian";
-if (isnative($dh{MAINPACKAGE})) {
- $changelog_name='changelog';
- $news_name='NEWS';
+if (! defined $upstream) {
+ if (! isnative($dh{MAINPACKAGE}) && !compat(6)) {
+ my @files=sort glob("*");
+ foreach my $name (qw{changelog changes changelog.txt changes.txt}) {
+ my @matches=grep {
+ lc $_ eq $name && -s $_ && ! excludefile($_)
+ } @files;
+ if (@matches) {
+ $upstream=shift @matches;
+ last;
+ }
+ }
+ }
+ if (isnative($dh{MAINPACKAGE})) {
+ $changelog_name='changelog';
+ }
}
+my $news_name="NEWS.Debian";
foreach my $package (@{$dh{DOPACKAGES}}) {
+ next if is_udeb($package);
+
my $tmp=tmpdir($package);
my $changelog=pkgfile($package,"changelog");
my $news=pkgfile($package,"NEWS");
error("could not find changelog $changelog");
}
- 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";
+ # If it is a symlink to a documentation directory from the same
+ # source package, then don't do anything. Think multi-binary
+ # packages that depend on each other and want to link doc dirs.
+ if (-l "$tmp/usr/share/doc/$package") {
+ my $linkval=readlink("$tmp/usr/share/doc/$package");
+ my %allpackages=map { $_ => 1 } getpackages();
+ if ($allpackages{basename($linkval)}) {
+ next;
+ }
+ # Even if the target doesn't seem to be a doc dir from the
+ # same source package, don't do anything if it's a dangling
+ # symlink.
+ next unless -d "$tmp/usr/share/doc/$package";
+ }
+ if (! -d "$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/$news_name");
}
- if ($upstream) {
+ if (defined $upstream) {
my $link_to;
if ($upstream=~m/\.html?$/i) {
# HTML changelog
=head1 SEE ALSO
-L<debhelper(1)>
+L<debhelper(7)>
This program is a part of debhelper.
projects / debhelper.git / blobdiff