X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=dh_installchangelogs;h=4620473b0ca83795fdeaa95af79ee4a39c725c6b;hb=49281a1503549efdae30e5262f166eced711ffd7;hp=935a87a687e43fdf95a35bda7548c38baf846eee;hpb=938b66ee19e113785e6655b1c3e73e9003e6464c;p=debhelper.git diff --git a/dh_installchangelogs b/dh_installchangelogs index 935a87a..4620473 100755 --- a/dh_installchangelogs +++ b/dh_installchangelogs @@ -1,32 +1,181 @@ -#!/bin/sh -e -# -# 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. - -PATH=debian:$PATH:/usr/lib/debhelper -source dh_lib - -UPSTREAM=$1 - -if [ "$NATIVE" -a "$UPSTREAM" ]; then - error "Cannot specify an upstream changelog for a native package." -fi - -if [ "$NATIVE" ]; then - CHANGELOG_NAME=changelog -else - CHANGELOG_NAME=changelog.Debian -fi - -if [ ! -d debian/tmp/usr/doc/$PACKAGE ]; then - doit "install -d debian/tmp/usr/doc/$PACKAGE" -fi -doit "install -p -m644 debian/changelog debian/tmp/usr/doc/$PACKAGE/$CHANGELOG_NAME" - -if [ "$UPSTREAM" ]; then - doit "install -p -m644 $UPSTREAM debian/tmp/usr/doc/$PACKAGE/changelog" -fi +#!/usr/bin/perl -w + +=head1 NAME + +dh_installchangelogs - install changelogs into package build directories + +=cut + +use strict; +use Debian::Debhelper::Dh_Lib; + +=head1 SYNOPSIS + +B [S>] [B<-k>] [B<-X>I] [I] + +=head1 DESCRIPTION + +B is a debhelper program that is responsible for +installing changelogs into package build directories. + +An upstream F file may be specified as an option. If none is +specified, it looks for files with names that seem likely to be changelogs. +(In compatibility level 7 and above.) + +If there is an upstream F file, it will be be installed as +F in the package build directory. If the +changelog is a F file (determined by file extension), it will be +installed as F instead, and will be +converted to plain text with B to generate +F. + +=head1 FILES + +=over 4 + +=item F + +=item F + +=item debian/I.changelog + +=item debian/I.NEWS + +Automatically installed into usr/share/doc/I/ +in the package build directory. + +Use the package specific name if I needs a different +F or F file. + +The F file is installed with a name of changelog +for native packages, and F for non-native packages. +The F file is always installed with a name of F. + +=back + +=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 F, and making a symlink from +that to the original name of the F file. This can be useful if the +upstream changelog has an unusual name, or if other documentation in the +package refers to the F file. + +=item B<-X>I, B<--exclude=>I + +Exclude upstream F files that contain I 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)) { + foreach my $dir (qw{. doc docs}) { + my @files=sort glob("$dir/*"); + foreach my $name (qw{changelog changes changelog.txt changes.txt history history.txt}) { + my @matches=grep { + lc basename($_) 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"); + + if (!$changelog) { + $changelog="debian/changelog"; + } + if (!$news) { + $news="debian/NEWS"; + } + + if (! -e $changelog) { + error("could not find changelog $changelog"); + } + + # 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/$changelog_name"); + if (-e $news) { + doit("install","-o",0,"-g",0,"-p","-m644",$news, + "$tmp/usr/share/doc/$package/$news_name"); + } + + if (defined $upstream) { + my $link_to; + if ($upstream=~m/\.html?$/i) { + # HTML 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",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/".basename($upstream)); + } + } +} + +=head1 SEE ALSO + +L + +This program is a part of debhelper. + +=head1 AUTHOR + +Joey Hess + +=cut