summaryrefslogtreecommitdiff
path: root/dh_clean
blob: a08b0b3633792d78081a5edd945eaa7121386b9e (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
#!/usr/bin/perl -w

=head1 NAME

dh_clean - clean up package build directories

=cut

use strict;
use Debian::Debhelper::Dh_Lib;

=head1 SYNOPSIS

B<dh_clean> [S<I<debhelper options>>] [B<-k>] [B<-d>] [B<-X>I<item>] [S<I<file ...>>]

=head1 DESCRIPTION

dh_clean is a debhelper program that is responsible for cleaning up after a
package is built. It removes the package build directories, and removes some
other files including debian/files, and any detritus left behind by other
debhelper commands. It also removes common files that should not appear in a
debian diff:
  #*# *~ DEADJOE *.orig *.rej *.SUMS TAGS .deps/* *.P

It does not run "make clean" to clean up after the build process. Use
L<dh_auto_clean(1)> to do that.

The debian/clean file can list other files to be removed.

=head1 OPTIONS

=over 4

=item B<-k>, B<--keep>

Do not delete debian/files, or files listed in debian/clean. When do you
want to use this? Anytime you have a debian/rules that has 2 binary targets
that build different .deb packages; for example, one target is binary-arch,
and the other is binary-indep, or one target builds the shared library, and
the other the -dev package. If you didn't use -k in these cases, then
debian/files would be deleted in the middle, and your changes file will
only contain the last binary package that was built.

=item B<-d>, B<--dirs-only>

Only clean the package build directories, do not clean up any other files
at all.

=item B<-X>I<item> B<--exclude=>I<item>

Exclude files that contain "item" anywhere in their filename from being
deleted, even if they would normally be deleted. You may use this option
multiple times to build up a list of things to exclude.

=item I<file ...>

Delete these files too.

=back

=cut

init();

foreach my $package (@{$dh{DOPACKAGES}}) {
	my $tmp=tmpdir($package);
	my $ext=pkgext($package);

	if (! $dh{D_FLAG}) {
		doit("rm","-f","debian/${ext}substvars")
			unless excludefile("debian/${ext}substvars");
		
		# These are all debhelper temp files, and so it is safe to 
		# wildcard them.
		complex_doit("rm -f debian/$ext*.debhelper");
		
		if (! $dh{K_FLAG}) {
			doit("rm","-f","debian/${ext}debhelper.log");
		}
	}
	
	doit ("rm","-rf",$tmp."/")
		unless excludefile($tmp);
}

if (! $dh{D_FLAG}) {
	if (@ARGV) {
		doit("rm","-f","--",@ARGV);
	}

	if (! $dh{K_FLAG}) {
		if (!compat(6) && -e "debian/clean") {
			my @clean=grep { ! excludefile($_) }
				filearray("debian/clean", ".");
			doit("rm","-f","--",@clean) if @clean;
		}

		doit("rm","-f","debian/files")
			unless excludefile("debian/files");
	}

	# See if some files that would normally be deleted are excluded.
	my $find_options='';
	if (defined($dh{EXCLUDE_FIND}) && $dh{EXCLUDE_FIND} ne '') {
		$find_options="! \\( $dh{EXCLUDE_FIND} \\) -a";
	}

	# Remove other temp files.
	complex_doit("find . $find_options \\( \\( -type f -a \\
	        \\( -name '#*#' -o -name '.*~' -o -name '*~' -o -name DEADJOE \\
		 -o -name '*.orig' -o -name '*.rej' -o -name '*.bak' \\
		 -o -name '.*.orig' -o -name .*.rej -o -name '.SUMS' \\
		 -o -name TAGS -o \\( -path '*/.deps/*' -a -name '*.P' \\) \\
		\\) -exec rm -f {} \\; \\) -o \\
		\\( -type d -a -name autom4te.cache -prune -exec rm -rf {} \\; \\) \\)");
}

doit('rm', '-rf', 'debian/tmp') if -x 'debian/tmp' && ! compat(1) &&
                                   ! excludefile("debian/tmp");

=head1 SEE ALSO

L<debhelper(7)>

This program is a part of debhelper.

=head1 AUTHOR

Joey Hess <joeyh@debian.org>

=cut