summaryrefslogtreecommitdiff
path: root/Debian/Debhelper
diff options
context:
space:
mode:
authorModestas Vainius <modestas@vainius.eu>2009-06-09 14:24:04 +0300
committerModestas Vainius <modestas@vainius.eu>2009-06-09 14:24:04 +0300
commitf72b0db0446788a867c5115845b28371ab5f0e9b (patch)
tree2029151f33a00592f9ad27faa61e91799567fb56 /Debian/Debhelper
parent299cb17e2a2a2524c628c0581ba2a85b2d9b2bed (diff)
Implement source directory switching support (Closes: #530597).
* New optional option --sourcedirectory/-d. * New Buildsystem API methods for getting source directory/path (since sourcedir may no longer be topdir), source 2 build directory convertions, doit_in_sourcedir() etc. * clean_builddir() -> rmdir_builddir() rename.
Diffstat (limited to 'Debian/Debhelper')
-rw-r--r--Debian/Debhelper/Buildsystem.pm186
-rw-r--r--Debian/Debhelper/Buildsystem/autoconf.pm6
-rw-r--r--Debian/Debhelper/Buildsystem/cmake.pm5
-rw-r--r--Debian/Debhelper/Buildsystem/makefile.pm9
-rw-r--r--Debian/Debhelper/Buildsystem/perl_build.pm7
-rw-r--r--Debian/Debhelper/Buildsystem/perl_makemaker.pm9
-rw-r--r--Debian/Debhelper/Buildsystem/python_distutils.pm10
-rw-r--r--Debian/Debhelper/Dh_Buildsystems.pm8
8 files changed, 178 insertions, 62 deletions
diff --git a/Debian/Debhelper/Buildsystem.pm b/Debian/Debhelper/Buildsystem.pm
index 718ef73..c16217f 100644
--- a/Debian/Debhelper/Buildsystem.pm
+++ b/Debian/Debhelper/Buildsystem.pm
@@ -8,7 +8,7 @@ package Debian::Debhelper::Buildsystem;
use strict;
use warnings;
-use Cwd;
+use Cwd ();
use File::Spec;
use Debian::Debhelper::Dh_Lib;
@@ -42,9 +42,15 @@ sub DEFAULT_BUILD_DIRECTORY {
}
# Constructs a new build system object. Named parameters:
-# - builddir - specifies build directory to use. If not specified,
-# in source build will be performed. If undef or empty,
-# DEFAULT_BUILD_DIRECTORY will be used.
+# - sourcedir- specifies source directory (relative to the current (top)
+# directory) where the sources to be built live. If not
+# specified or empty, defaults to the current directory.
+# - builddir - specifies build directory to use. Path is relative to the
+# source directory unless it starts with ./, then it is
+# assumed to be relative to the top directory. If undef or
+# empty, DEFAULT_BUILD_DIRECTORY relative to the source
+# directory will be used. If not specified, in source build
+# will be attempted.
# - build_step - set this parameter to the name of the build step
# if you want the object to determine its is_buidable
# status automatically (with check_auto_buildable()).
@@ -57,13 +63,33 @@ sub DEFAULT_BUILD_DIRECTORY {
sub new {
my ($class, %opts)=@_;
- my $this = bless({ builddir => undef, is_buildable => 1 }, $class);
+ my $this = bless({ sourcedir => '.',
+ builddir => undef,
+ is_buildable => 1 }, $class);
+
+ if (exists $opts{sourcedir}) {
+ # Get relative sourcedir abs_path (without symlinks)
+ my $curdir = Cwd::getcwd();
+ my $abspath = Cwd::abs_path($opts{sourcedir});
+ if (! -d $abspath || $abspath !~ /^\Q$curdir\E/) {
+ error("Invalid or non-existing path to the source directory: ".$opts{sourcedir});
+ }
+ $this->{sourcedir} = File::Spec->abs2rel($abspath, $curdir);
+ }
if (exists $opts{builddir}) {
if ($opts{builddir}) {
- $this->{builddir} = $opts{builddir};
+ if ($opts{builddir} =~ m!^\./(.*)!) {
+ # Specified as relative to the current directory
+ $this->{builddir} = $1;
+ }
+ else {
+ # Specified as relative to the source directory
+ $this->{builddir} = $this->_canonpath($this->get_sourcepath($opts{builddir}));
+ }
}
else {
- $this->{builddir} = $this->DEFAULT_BUILD_DIRECTORY();
+ # Relative to the source directory by default
+ $this->{builddir} = $this->get_sourcepath($this->DEFAULT_BUILD_DIRECTORY());
}
}
if (exists $opts{build_step}) {
@@ -122,42 +148,108 @@ sub enforce_out_of_source_building {
}
}
-# Get path to the specified build directory
+# Enhanced version of File::Spec::canonpath. It collapses ..
+# too so it may return invalid path if symlinks are involved.
+# On the other hand, it does not need for the path to exist.
+sub _canonpath {
+ my ($this, $path)=@_;
+ my @canon;
+ my $back=0;
+ for my $comp (split(m%/+%, $path)) {
+ if ($comp eq '.') {
+ next;
+ }
+ elsif ($comp eq '..') {
+ if (@canon > 0) { pop @canon; } else { $back++; }
+ }
+ else {
+ push @canon, $comp;
+ }
+ }
+ return (@canon + $back > 0) ? join('/', ('..')x$back, @canon) : '.';
+}
+
+# Given both $path and $base are relative to the same directory,
+# converts and returns path of $path being relative the $base.
+sub _rel2rel {
+ my ($this, $path, $base, $root)=@_;
+ $root = File::Spec->rootdir() if !defined $root;
+
+ return File::Spec->abs2rel(
+ File::Spec->rel2abs($path, $root),
+ File::Spec->rel2abs($base, $root)
+ );
+}
+
+# Get path to the source directory
+# (relative to the current (top) directory)
+sub get_sourcedir {
+ my $this=shift;
+ return $this->{sourcedir};
+}
+
+# Convert path relative to the source directory to the path relative
+# to the current (top) directory.
+sub get_sourcepath {
+ my ($this, $path)=@_;
+ return File::Spec->catfile($this->get_sourcedir(), $path);
+}
+
+# Get path to the build directory if it was specified
+# (relative to the current (top) directory). undef otherwise.
sub get_builddir {
my $this=shift;
return $this->{builddir};
}
-# Construct absolute path to the file from the given path that is relative
-# to the build directory.
+# Convert path that is relative to the build directory to the path
+# that is relative to the current (top) directory.
+# If $path is not specified, always returns build directory path
+# relative to the current (top) directory regardless if builddir was
+# specified or not.
sub get_buildpath {
- my ($this, $path) = @_;
- if ($this->get_builddir()) {
- return File::Spec->catfile($this->get_builddir(), $path);
- }
- else {
- return File::Spec->catfile('.', $path);
+ my ($this, $path)=@_;
+ my $builddir = $this->get_builddir() || $this->get_sourcedir();
+ if (defined $path) {
+ return File::Spec->catfile($builddir, $path);
}
+ return $builddir;
}
-# When given a relative path in the source tree, converts it
-# to the path that is relative to the build directory.
-# If $path is not given, returns relative path to the root of the
-# source tree from the build directory.
-sub get_rel2builddir_path {
+# When given a relative path to the source directory, converts it
+# to the path that is relative to the build directory. If $path is
+# not given, returns a path to the source directory that is relative
+# to the build directory.
+sub get_source_rel2builddir {
my $this=shift;
my $path=shift;
- if (defined $path) {
- $path = File::Spec->catfile(Cwd::getcwd(), $path);
+ my $dir = '.';
+ if ($this->get_builddir()) {
+ $dir = $this->_rel2rel($this->get_sourcedir(), $this->get_builddir());
}
- else {
- $path = Cwd::getcwd();
+ if (defined $path) {
+ return File::Spec->catfile($dir, $path);
}
+ return $dir;
+}
+
+# When given a relative path to the build directory, converts it
+# to the path that is relative to the source directory. If $path is
+# not given, returns a path to the build directory that is relative
+# to the source directory.
+sub get_build_rel2sourcedir {
+ my $this=shift;
+ my $path=shift;
+
+ my $dir = '.';
if ($this->get_builddir()) {
- return File::Spec->abs2rel($path, Cwd::abs_path($this->get_builddir()));
+ $dir = $this->_rel2rel($this->get_builddir(), $this->get_sourcedir());
}
- return $path;
+ if (defined $path) {
+ return File::Spec->catfile($dir, $path);
+ }
+ return $dir;
}
# Creates a build directory.
@@ -176,16 +268,35 @@ sub _cd {
}
}
-# Changes working directory the build directory (if needed), calls doit(@_)
-# and changes working directory back to the source directory.
+# Changes working directory to the source directory (if needed)
+# calls doit(@_) and changes working directory back to the top
+# directory.
+sub doit_in_sourcedir {
+ my $this=shift;
+ if ($this->get_sourcedir() ne '.') {
+ my $sourcedir = get_sourcedir();
+ my $curdir = Cwd::getcwd();
+ $this->_cd($sourcedir);
+ doit(@_);
+ $this->_cd($this->_rel2rel($curdir, $sourcedir, $curdir));
+ }
+ else {
+ doit(@_);
+ }
+ return 1;
+}
+
+# Changes working directory to the build directory (if needed),
+# calls doit(@_) and changes working directory back to the top
+# directory.
sub doit_in_builddir {
my $this=shift;
- if ($this->get_builddir()) {
- my $builddir = $this->get_builddir();
- my $sourcedir = $this->get_rel2builddir_path();
- $this->_cd($builddir);
+ if ($this->get_buildpath() ne '.') {
+ my $buildpath = $this->get_buildpath();
+ my $curdir = Cwd::getcwd();
+ $this->_cd($buildpath);
doit(@_);
- $this->_cd($sourcedir);
+ $this->_cd($this->_rel2rel($curdir, $buildpath, $curdir));
}
else {
doit(@_);
@@ -196,11 +307,12 @@ sub doit_in_builddir {
# In case of out of source tree building, whole build directory
# gets wiped (if it exists) and 1 is returned. Otherwise, nothing
# is done and 0 is returned.
-sub clean_builddir {
+sub rmdir_builddir {
my $this=shift;
if ($this->get_builddir()) {
- if (-d $this->get_builddir()) {
- doit("rm", "-rf", $this->get_builddir());
+ my $buildpath = $this->get_buildpath();
+ if (-d $buildpath) {
+ doit("rm", "-rf", $buildpath);
}
return 1;
}
diff --git a/Debian/Debhelper/Buildsystem/autoconf.pm b/Debian/Debhelper/Buildsystem/autoconf.pm
index d7018bb..5a55372 100644
--- a/Debian/Debhelper/Buildsystem/autoconf.pm
+++ b/Debian/Debhelper/Buildsystem/autoconf.pm
@@ -7,8 +7,6 @@
package Debian::Debhelper::Buildsystem::autoconf;
use strict;
-use File::Spec;
-use Debian::Debhelper::Dh_Lib;
use base 'Debian::Debhelper::Buildsystem::makefile';
sub DESCRIPTION {
@@ -21,7 +19,7 @@ sub check_auto_buildable {
# Handle configure; the rest - next class
if ($step eq "configure") {
- return -x "configure";
+ return -x $this->get_sourcepath("configure");
}
return 0;
}
@@ -50,7 +48,7 @@ sub configure {
}
$this->mkdir_builddir();
- $this->doit_in_builddir($this->get_rel2builddir_path("configure"), @opts, @_);
+ $this->doit_in_builddir($this->get_source_rel2builddir("configure"), @opts, @_);
}
1;
diff --git a/Debian/Debhelper/Buildsystem/cmake.pm b/Debian/Debhelper/Buildsystem/cmake.pm
index d1fe689..a30fbb0 100644
--- a/Debian/Debhelper/Buildsystem/cmake.pm
+++ b/Debian/Debhelper/Buildsystem/cmake.pm
@@ -7,7 +7,6 @@
package Debian::Debhelper::Buildsystem::cmake;
use strict;
-use Debian::Debhelper::Dh_Lib;
use base 'Debian::Debhelper::Buildsystem::makefile';
sub DESCRIPTION {
@@ -17,7 +16,7 @@ sub DESCRIPTION {
sub check_auto_buildable {
my $this=shift;
my ($step)=@_;
- my $ret = -e "CMakeLists.txt";
+ my $ret = -e $this->get_sourcepath("CMakeLists.txt");
$ret &&= $this->SUPER::check_auto_buildable(@_) if $step ne "configure";
return $ret;
}
@@ -43,7 +42,7 @@ sub configure {
push @flags, "-DCMAKE_VERBOSE_MAKEFILE=ON";
$this->mkdir_builddir();
- $this->doit_in_builddir("cmake", $this->get_rel2builddir_path(), @flags);
+ $this->doit_in_builddir("cmake", $this->get_source_rel2builddir(), @flags);
}
1;
diff --git a/Debian/Debhelper/Buildsystem/makefile.pm b/Debian/Debhelper/Buildsystem/makefile.pm
index 4f15152..4724440 100644
--- a/Debian/Debhelper/Buildsystem/makefile.pm
+++ b/Debian/Debhelper/Buildsystem/makefile.pm
@@ -7,13 +7,14 @@
package Debian::Debhelper::Buildsystem::makefile;
use strict;
-use Debian::Debhelper::Dh_Lib;
+use Debian::Debhelper::Dh_Lib qw(escape_shell);
use base 'Debian::Debhelper::Buildsystem';
sub get_makecmd_C {
my $this=shift;
- if ($this->get_builddir()) {
- return $this->{makecmd} . " -C " . $this->get_builddir();
+ my $buildpath = $this->get_buildpath();
+ if ($buildpath ne '.') {
+ return $this->{makecmd} . " -C " . escape_shell($buildpath);
}
return $this->{makecmd};
}
@@ -86,7 +87,7 @@ sub install {
sub clean {
my $this=shift;
- if (!$this->clean_builddir()) {
+ if (!$this->rmdir_builddir()) {
$this->make_first_existing_target(['distclean', 'realclean', 'clean'], @_);
}
}
diff --git a/Debian/Debhelper/Buildsystem/perl_build.pm b/Debian/Debhelper/Buildsystem/perl_build.pm
index 929d9e9..525b0e1 100644
--- a/Debian/Debhelper/Buildsystem/perl_build.pm
+++ b/Debian/Debhelper/Buildsystem/perl_build.pm
@@ -7,7 +7,6 @@
package Debian::Debhelper::Buildsystem::perl_build;
use strict;
-use Debian::Debhelper::Dh_Lib;
use base 'Debian::Debhelper::Buildsystem';
sub DESCRIPTION {
@@ -18,9 +17,9 @@ sub check_auto_buildable {
my ($this, $step) = @_;
# Handles everything
- my $ret = -e "Build.PL";
+ my $ret = -e $this->get_sourcepath("Build.PL");
if ($step ne "configure") {
- $ret &&= -e "Build";
+ $ret &&= -e $this->get_sourcepath("Build");
}
return $ret;
}
@@ -28,7 +27,7 @@ sub check_auto_buildable {
sub do_perl {
my $this=shift;
$ENV{MODULEBUILDRC} = "/dev/null";
- doit("perl", @_);
+ $this->doit_in_sourcedir("perl", @_);
}
sub new {
diff --git a/Debian/Debhelper/Buildsystem/perl_makemaker.pm b/Debian/Debhelper/Buildsystem/perl_makemaker.pm
index 36586e4..ebce9a5 100644
--- a/Debian/Debhelper/Buildsystem/perl_makemaker.pm
+++ b/Debian/Debhelper/Buildsystem/perl_makemaker.pm
@@ -7,7 +7,6 @@
package Debian::Debhelper::Buildsystem::perl_makemaker;
use strict;
-use Debian::Debhelper::Dh_Lib;
use base 'Debian::Debhelper::Buildsystem::makefile';
sub DESCRIPTION {
@@ -20,7 +19,7 @@ sub check_auto_buildable {
# Handles configure, install; the rest - next class
if ($step eq "install" || $step eq "configure") {
- return -e "Makefile.PL";
+ return -e $this->get_sourcepath("Makefile.PL");
}
else {
return 0;
@@ -42,9 +41,9 @@ sub configure {
# This prevents Module::Install from interactive behavior.
$ENV{PERL_AUTOINSTALL}="--skipdeps";
- doit("perl", "Makefile.PL", "INSTALLDIRS=vendor",
- "create_packlist=0",
- @_);
+ $this->doit_in_sourcedir("perl", "Makefile.PL", "INSTALLDIRS=vendor",
+ "create_packlist=0",
+ @_);
}
sub install {
diff --git a/Debian/Debhelper/Buildsystem/python_distutils.pm b/Debian/Debhelper/Buildsystem/python_distutils.pm
index 01a8c14..bfb76ee 100644
--- a/Debian/Debhelper/Buildsystem/python_distutils.pm
+++ b/Debian/Debhelper/Buildsystem/python_distutils.pm
@@ -8,7 +8,6 @@
package Debian::Debhelper::Buildsystem::python_distutils;
use strict;
-use Debian::Debhelper::Dh_Lib;
use base 'Debian::Debhelper::Buildsystem';
sub DESCRIPTION {
@@ -16,7 +15,8 @@ sub DESCRIPTION {
}
sub check_auto_buildable {
- return -e "setup.py";
+ my $this=shift;
+ return -e $this->get_sourcepath("setup.py");
}
sub setup_py {
@@ -24,9 +24,9 @@ sub setup_py {
my $act=shift;
if ($this->get_builddir()) {
- unshift @_, "--build-base=" . $this->get_builddir();
+ unshift @_, "--build-base=" . $this->get_build_rel2sourcedir();
}
- doit("python", "setup.py", $act, @_);
+ $this->doit_in_sourcedir("python", "setup.py", $act, @_);
}
sub build {
@@ -45,7 +45,7 @@ sub clean {
$this->setup_py("clean", "-a", @_);
# The setup.py might import files, leading to python creating pyc
# files.
- doit('find', '.', '-name', '*.pyc', '-exec', 'rm', '{}', ';');
+ $this->doit_in_sourcedir('find', '.', '-name', '*.pyc', '-exec', 'rm', '{}', ';');
}
1;
diff --git a/Debian/Debhelper/Dh_Buildsystems.pm b/Debian/Debhelper/Dh_Buildsystems.pm
index 3cfaffb..179d633 100644
--- a/Debian/Debhelper/Dh_Buildsystems.pm
+++ b/Debian/Debhelper/Dh_Buildsystems.pm
@@ -26,6 +26,7 @@ our @BUILDSYSTEMS = (
);
my $opt_buildsys;
+my $opt_sourcedir;
my $opt_builddir;
my $opt_list;
@@ -42,6 +43,9 @@ sub create_buildsystem_instance {
if (!exists $bsopts{builddir} && defined $opt_builddir) {
$bsopts{builddir} = ($opt_builddir eq "") ? undef : $opt_builddir;
}
+ if (!exists $bsopts{sourcedir} && defined $opt_sourcedir) {
+ $bsopts{sourcedir} = ($opt_sourcedir eq "") ? undef : $opt_sourcedir;
+ }
return $module->new(%bsopts);
}
@@ -102,6 +106,10 @@ sub buildsystems_init {
# Available command line options
my %options = (
+ "d" => undef, # cancel default D_FLAG option spec
+ "d=s" => \$opt_sourcedir,
+ "sourcedirectory=s" => \$opt_sourcedir,
+
"b:s" => \$opt_builddir,
"builddirectory:s" => \$opt_builddir,