X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=dh_installchangelogs;h=3749d523104d59555f4a167558c77ae95e2d293d;hb=3e479237e5cbe95d78cd71aa410a4b410830cfe3;hp=e653019132f04529af017c77eae306953e431275;hpb=67b74298f08a3e2b30e43cbcd7cdaccc2e1b1614;p=debhelper.git diff --git a/dh_installchangelogs b/dh_installchangelogs index e653019..3749d52 100755 --- a/dh_installchangelogs +++ b/dh_installchangelogs @@ -1,64 +1,157 @@ #!/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; -init(); -$upstream=shift; +=head1 SYNOPSIS -if (isnative($dh{MAINPACKAGE}) && defined $upstream) { - error("Cannot specify an upstream changelog for a native debian package."); -} +B [S>] [B<-k>] [B<-X>I] [I] -if (isnative($dh{MAINPACKAGE})) { - $changelog_name='changelog'; -} -else { - $changelog_name='changelog.Debian'; +=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. + +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 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 B<-Xitem>, B<--exclude=item> + +Exclude upstream changelog files that contain "item" anywhere in their +filename from being installed. + +=item I + +Install this file as the upstream changelog. + +=back + +=cut + +init(); + +my $upstream=shift; +my $changelog_name="changelog.Debian"; +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 $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) { + if (defined $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"); - complex_doit("lynx -dump $upstream > $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"); - $link_to='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",$link_to,"$TMP/usr/share/doc/$PACKAGE/".Debian::Debhelper::Dh_Lib::basename($upstream)); + doit("ln","-sf",$link_to,"$tmp/usr/share/doc/$package/".basename($upstream)); } } } + +=head1 SEE ALSO + +L + +This program is a part of debhelper. + +=head1 AUTHOR + +Joey Hess + +=cut