#!/usr/bin/perl =head1 NAME dh_installchangelogs - install changelogs into package build directories =cut use strict; use warnings; use Debian::Debhelper::Dh_Lib; our $VERSION = DH_BUILTIN_VERSION; =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, B may look for files with names that seem likely to be changelogs as described in the next paragraphs (assuming the package is using compatibility level 7 or above). In non-native packages, B will first look for changelog files installed by the upstream build system into F<< usr/share/doc/I >> (of the package build directory) and rename the most likely candidate (if any) to F<< usr/share/doc/I/changelog >>. Note that B does I look into any source directory (such as F). Otherwise, B (at compatibility level 7 or any later) will look for changelog files in the source directory (e.g. the root or the F subdirectory). If there is an upstream F file, it will be installed as F in the package build directory. If the specified upstream changelog is an F file (determined by file extension), it will be installed as F instead. If the html changelog is converted to plain text, that variant can be specified as a second upstream changelog file. When no plain text variant is specified, a short F is generated, pointing readers at the html changelog file. =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. Note that directory name of the changelog is also part of the match. =item I Install this file as the upstream changelog. =back =cut # For binNMUs the first changelog entry is written into an extra file to # keep the packages coinstallable. sub install_binNMU_changelog { my ($package, $input_fn, $changelog_name)=@_; open (my $input, "<", $input_fn); my $line=<$input>; if (defined $line && $line =~ /\A\S.*;.*\bbinary-only=yes/) { my $mask=umask 0022; my @stat=stat $input_fn or error("could not stat $input_fn: $!"); my $tmp=tmpdir($package); my $output_fn="$tmp/usr/share/doc/$package/$changelog_name"; open my $output, ">", $output_fn or error("could not open $output_fn for writing: $!"); my $arch=package_binary_arch($package); my $output_fn_binary="$output_fn.$arch"; open my $output_binary, ">", $output_fn_binary or error("could not open $output_fn_binary for writing: $!"); do { print {$output_binary} $line or error("Could not write to $output_fn_binary: $!"); } while(defined($line=<$input>) && $line !~ /\A\S/); close $output_binary or error("Couldn't close $output_fn_binary: $!"); utime $stat[8], $stat[9], $output_fn_binary; do { print {$output} $line or error("Could not write to $output_fn: $!"); } while(defined($line=<$input>)); close $input or error("Couldn't close $input_fn: $!"); close $output or error("Couldn't close $output_fn: $!"); utime $stat[8], $stat[9], $output_fn; if (should_use_root()) { chown(0, 0, $output_fn, $output_fn_binary) or error("chown: $!"); } umask $mask; return 1; } else { close $input; return 0; } } init(); my $news_name="NEWS.Debian"; my $changelog_name="changelog.Debian"; my $default_upstream = $ARGV[0]; my $default_upstream_text=$default_upstream; my $default_upstream_html; if (! defined($default_upstream)) { if (! isnative($dh{MAINPACKAGE}) && !compat(6)) { foreach my $dir (qw{. doc docs}) { my $changelog = find_changelog($dir); if ($changelog) { $default_upstream = $changelog; $default_upstream_text = $default_upstream; last; } } } if (isnative($dh{MAINPACKAGE})) { $changelog_name='changelog'; } } elsif ($default_upstream=~m/\.html?$/i) { $default_upstream_html=$default_upstream; $default_upstream_text=$ARGV[1]; } sub find_changelog { my ($dir) = @_; my @files=sort glob("$dir/*"); foreach my $suffix ('', qw(.txt .md .rst)) { foreach my $name (qw{changelog changes history}) { my @matches=grep { lc basename($_) eq "$name$suffix" && -f $_ && -s _ && ! excludefile($_) } @files; if (@matches) { return shift(@matches); } } } return; } on_pkgs_in_parallel { foreach my $package (@_) { next if is_udeb($package); my $tmp=tmpdir($package); my $changelog=pkgfile($package,"changelog"); my $news=pkgfile($package,"NEWS"); my $upstream_changelog = $ARGV[0]; my ($upstream_changelog_text, $upstream_changelog_html); my $changelog_from_tmp_dir = 0; if (! defined($upstream_changelog)) { # Check if the upstream build system provided a # changelog $upstream_changelog = find_changelog("${tmp}/usr/share/doc/${package}"); if ($upstream_changelog) { $upstream_changelog_text = $upstream_changelog; $changelog_from_tmp_dir = 1; } } if (not $upstream_changelog || defined($ARGV[0])) { $upstream_changelog = $default_upstream; $upstream_changelog_text = $default_upstream_text; $upstream_changelog_html = $default_upstream_html; } 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"; } install_dir("$tmp/usr/share/doc/$package"); if (! $dh{NO_ACT}) { if (! install_binNMU_changelog($package, $changelog, $changelog_name)) { install_file($changelog, "$tmp/usr/share/doc/$package/$changelog_name"); } } if (-e $news) { install_file($news, "$tmp/usr/share/doc/$package/$news_name"); } if (defined($upstream_changelog)) { my $link_to; my $base="$tmp/usr/share/doc/$package"; if (defined($upstream_changelog_text)) { if ($changelog_from_tmp_dir and not $dh{K_FLAG}) { # mv (unless if it is the same file) rename_path($upstream_changelog_text, "$base/changelog") if basename($upstream_changelog_text) ne 'changelog'; reset_perm_and_owner(0644, "$base/changelog"); } else { install_file($upstream_changelog_text, "$base/changelog"); } $link_to='changelog'; } if (defined($upstream_changelog_html)) { if ($changelog_from_tmp_dir and not $dh{K_FLAG}) { # mv (unless if it is the same file) rename_path($upstream_changelog_html, "$base/changelog.html") if basename($upstream_changelog_text) ne 'changelog.html'; reset_perm_and_owner(0644, "$base/changelog.html"); } else { install_file($upstream_changelog_html,"$base/changelog.html"); } $link_to='changelog.html'; if (! defined($upstream_changelog_text)) { complex_doit("echo 'See changelog.html.gz' > $base/changelog"); reset_perm_and_owner(0644,"$base/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_changelog)); } } } }; =head1 SEE ALSO L This program is a part of debhelper. =head1 AUTHOR Joey Hess =cut