summaryrefslogtreecommitdiff
path: root/Debian/Debhelper/Buildsystem/perl_build.pm
blob: 26210152a201790efcc50e450525ce14efc6c34a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
# A build system class for handling Perl Build based projects.
#
# Copyright: © 2008-2009 Joey Hess
#            © 2008-2009 Modestas Vainius
# License: GPL-2+

package Debian::Debhelper::Buildsystem::perl_build;

=head1 NAME

B<perl_build> - Perl Module::Build (Build.PL)

=head1 SYNOPSIS

B<dh_auto_*> [B<--buildsystem>=I<perl_build>] ...

=head1 DESCRIPTION

Module::Build is a system for building, testing, and installing Perl modules.
It does not require a C<make> on your system - most of the Module::Build code is
pure-perl and written in a very cross-platform way. Its only prerequisites are
modules that are included with perl 5.6.0. Typically, Module::Build build system
can be identified by presence of the F<Build.PL> script in the source
directory.

=head1 DH_AUTO NOTES

Out of source tree building is not supported. C<MODULEBUILDRC=/dev/null>
environment variable is exported in each building step.

=head1 BUILD PROCESS

=cut

use strict;
use base 'Debian::Debhelper::Buildsystem';

sub DESCRIPTION {
	"Perl Module::Build (Build.PL)"
}

sub check_auto_buildable {
	my ($this, $step) = @_;

	# Handles everything
	my $ret = -e $this->get_sourcepath("Build.PL");
	if ($step ne "configure") {
		$ret &&= -e $this->get_sourcepath("Build");
	}
	return $ret;
}

sub do_perl {
	my $this=shift;
	$ENV{MODULEBUILDRC} = "/dev/null";
	$this->doit_in_sourcedir("perl", @_);
}

sub new {
	my $class=shift;
	my $this= $class->SUPER::new(@_);
	$this->enforce_in_source_building();
	return $this;
}

=head2 Configure step

=over 4

=item I<Behaviour>

Execute C<perl Build.PL> passing C<installdirs=vendor> parameter by default.
Environment variable C<PERL_MM_USE_DEFAULT> is set before running the script.

=item I<Auto-selection>

If F<configure>, F<Makefile.PL>, F<setup.py> do not exist, but F<Build.PL>
exists in the source directory.

=back

=cut
sub configure {
	my $this=shift;
	$ENV{PERL_MM_USE_DEFAULT}=1;
	$this->do_perl("Build.PL", "installdirs=vendor", @_);
}

=head2 Build step

=over 4

=item I<Behaviour>

Execute C<perl Build>.

=item I<Auto-selection>

If F<Makefile>, F<makefile>, F<GNUmakefile> (build directory) and F<setup.py>
(source directory) do not exist, but F<Build.PL> and F<Build> files exist in
the source directory.

=back

=cut
sub build {
	my $this=shift;
	$this->do_perl("Build", @_);
}

=head2 Test step

=over 4

=item I<Behaviour>

Execute C<perl Build test>.

=item I<Auto-selection>

If F<Makefile>, F<makefile>, F<GNUmakefile> (build directory) and F<setup.py>
(source directory) do not exist, but F<Build.PL> and F<Build> files exist in
the source directory.

=back

=cut
sub test {
	my $this=shift;
	$this->do_perl("Build", "test", @_);
}

=head2 Install step

=over 4

=item I<Behaviour>

Execute C<perl Build install destdir=$destdir create_packlist=0>. $destdir is
the path to the temporary installation directory (see L<dh_auto_install(1)>).

=item I<Auto-selection>

If F<Makefile>, F<makefile>, F<GNUmakefile> (build directory) and F<setup.py>
(source directory) do not exist, but F<Build.PL> and F<Build> files exist in
the source directory.

=back

=cut
sub install {
	my $this=shift;
	my $destdir=shift;
	$this->do_perl("Build", "install", "destdir=$destdir", "create_packlist=0", @_);
}

=head2 Clean step

=over 4

=item I<Behaviour>

Execute C<perl Build --allow_mb_mismatch 1 distclean>.

=item I<Auto-selection>

If F<Makefile>, F<makefile>, F<GNUmakefile> (build directory) and F<setup.py>
(source directory) do not exist, but F<Build.PL> and F<Build> files exist in
the source directory.

=back

=cut
sub clean {
	my $this=shift;
	$this->do_perl("Build", "--allow_mb_mismatch", 1, "distclean", @_);
}

=head1 SEE ALSO

L<dh_auto(7)>

=head1 AUTHORS

 Joey Hess <joeyh@debian.org>
 Modestas Vainius <modestas@vainius.eu>

=cut

1;