X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=dh_link;h=5c2a56939dba35387c2ce3bec1aacecafa9b7de0;hb=5bc7bc9264d1c77e387bf7b8def576ad4f923b96;hp=0cbe6b73ba2e6a0ee2c13afa7bb3f491bc0589da;hpb=67b74298f08a3e2b30e43cbcd7cdaccc2e1b1614;p=debhelper.git

diff --git a/dh_link b/dh_link
index 0cbe6b7..5c2a569 100755
--- a/dh_link
+++ b/dh_link
@@ -1,16 +1,88 @@
 #!/usr/bin/perl -w
-#
-# Generate symlinks in debian packages, reading debian/links. The
-# file contains pairs of files and symlinks.
 
+=head1 NAME
+
+dh_link - create symlinks in package build directories
+
+=cut
+
+use strict;
+use File::Find;
 use Debian::Debhelper::Dh_Lib;
+
+=head1 SYNOPSIS
+
+B<dh_link> [S<I<debhelper options>>] [B<-A>] [S<I<source destination ...>>]
+
+=head1 DESCRIPTION
+
+dh_link is a debhelper program that creates symlinks in package build
+directories.
+
+dh_link accepts a list of pairs of source and destination files. The source
+files are the already existing files that will be symlinked from. The
+destination files are the symlinks that will be created. There B<must> be
+an equal number of source and destination files specified.
+
+The list can be specified in two ways. A file named debian/package.links
+can list pairs of files. If you use this file, you should put each pair
+of files on its own line, and separate the files within the pair with
+whitespace. Also, pairs of files can be specified as parameters - these
+pairs will only be created in the package build directory of the first
+package dh_link is told to act on. By default, this is the first binary
+package in debian/control, but if you use -p, -i, or -a flags, it will be
+the first package specified by those flags.
+
+Be sure you B<do> specify the full filename to both the source and
+destination files (unlike you would do if you were using something like
+L<ln(1)>).
+
+dh_link will generate symlinks that comply with debian policy - absolute
+when policy says they should be absolute, and relative links with as short
+a path as possible. It will also create any subdirectories it needs to to put
+the symlinks in.
+
+dh_link also scans the package build tree for existing symlinks which do not
+conform to debian policy, and corrects them (v4 only).
+
+=head1 OPTIONS
+
+=over 4
+
+=item B<-A>, B<--all>
+
+Create any links specified by command line parameters in ALL packages
+acted on, not just the first.
+
+=item I<source destination ...>
+
+Create a file named "destination" as a link to a file named "source". Do
+this in the package build directory of the first package acted on.
+(Or in all packages if -A is specified.)
+
+=back
+
+=head1 EXAMPLES
+
+ dh_link usr/share/man/man1/foo.1 usr/share/man/man1/bar.1
+
+Make bar.1 be a symlink to foo.1
+
+ dh_link var/lib/foo usr/lib/foo \
+   usr/X11R6/man/man1/foo.1x usr/share/man/man1/bar.1
+
+Make /usr/lib/foo/ be a link to /var/lib/foo/, and bar.1 be a symlink to
+the X man page foo.1x
+
+=cut
+
 init();
 
-foreach $PACKAGE (@{$dh{DOPACKAGES}}) {
-	$TMP=tmpdir($PACKAGE);
-	$file=pkgfile($PACKAGE,"links");
+foreach my $package (@{$dh{DOPACKAGES}}) {
+	my $tmp=tmpdir($package);
+	my $file=pkgfile($package,"links");
 
-	undef @links;
+	my @links;
 	if ($file) {
 		@links=filearray($file);
 	}
@@ -21,7 +93,7 @@ foreach $PACKAGE (@{$dh{DOPACKAGES}}) {
 		error("$file lists a link without a destination.");
 	}
 
-	if (($PACKAGE eq $dh{FIRSTPACKAGE} || $dh{PARAMS_ALL}) && @ARGV) {
+	if (($package eq $dh{FIRSTPACKAGE} || $dh{PARAMS_ALL}) && @ARGV) {
 		push @links, @ARGV;
 	}
 
@@ -30,16 +102,39 @@ foreach $PACKAGE (@{$dh{DOPACKAGES}}) {
 		error("parameters list a link without a destination.");
 	}
 
+	# v4 only
+	if (! compat(3)) {
+		# Scan for existing links and add them to @links, so they
+		# are recreated policy conformant.
+		find(
+			sub {
+				return unless -l;
+				my $dir=$File::Find::dir;
+				$dir=~s/^\Q$tmp\E//;
+				my $target = readlink($_);
+				if ($target=~/^\//) {
+					push @links, $target;
+				}
+				else {
+					push @links, "$dir/$target";
+				}
+				push @links, "$dir/$_";
+				doit("rm","-f",$_);
+				
+			},
+			$tmp);
+	}
+	
 	while (@links) {
-		$dest=pop @links;
-		$src=pop @links;
+		my $dest=pop @links;
+		my $src=pop @links;
 
-		# Relivatize src and dest.
+		# Relavatize src and dest.
 		$src=~s:^/::;
 		$dest=~s:^/::;
 
 		# Make sure the directory the link will be in exists.
-		$basedir=Debian::Debhelper::Dh_Lib::dirname("$TMP/$dest");
+		my $basedir=dirname("$tmp/$dest");
 		if (! -e $basedir) {
 			doit("install","-d",$basedir);
 		}
@@ -47,11 +142,12 @@ foreach $PACKAGE (@{$dh{DOPACKAGES}}) {
 		# Policy says that if the link is all within one toplevel
 		# directory, it should be relative. If it's between
 		# top level directories, leave it absolute.
-		@src_dirs=split(m:/+:,$src);
-		@dest_dirs=split(m:/+:,$dest);
+		my @src_dirs=split(m:/+:,$src);
+		my @dest_dirs=split(m:/+:,$dest);
 		if ($src_dirs[0] eq $dest_dirs[0]) {
 		    	# Figure out how much of a path $src and $dest
 			# share in common.
+			my $x;
 			for ($x=0; $x<$#src_dirs && $src_dirs[$x] eq $dest_dirs[$x]; $x++) {}
 			# Build up the new src.
 			$src="";
@@ -68,6 +164,18 @@ foreach $PACKAGE (@{$dh{DOPACKAGES}}) {
 			$src="/$src";
 		}
 		
-		doit("ln","-sf",$src,"$TMP/$dest");
+		doit("ln","-sf",$src,"$tmp/$dest");
 	}
 }
+
+=head1 SEE ALSO
+
+L<debhelper(1)>
+
+This program is a part of debhelper.
+
+=head1 AUTHOR
+
+Joey Hess <joeyh@debian.org>
+
+=cut