This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
set a Test-Harness file +x in makerel
[perl5.git] / Porting / makerel
1 #!/usr/bin/perl -w
2
3 # A tool to build a perl release tarball
4 # Very basic but functional - if you're on a unix system.
5 #
6 # If you're on Win32 then it should still work, but various Unix command-line
7 # tools will need to be available somewhere. An obvious choice is to install
8 # Cygwin and ensure its 'bin' folder is on the PATH in the shell where you run
9 # this script. The Cygwin 'bin' folder needs to precede the Windows 'system32'
10 # folder so that Cygwin's 'find' command is found in preference to the Windows
11 # 'find' command. Your Cygwin installation will need to contain at least the
12 # 'cpio' command, in addition to the commands installed by default, and it will
13 # also be useful to have 'curl' and 'diffstat' installed too for later stages
14 # of the release process (namely, Porting\corelist.pl and generating the commit
15 # statistics for the perlXYZdelta.pod file respectively). Finally, ensure that
16 # the 'awk' and 'shasum' commands are copies of gawk.exe and sha1sum.exe
17 # respectively, rather the links to them that only work in a Cygwin bash shell
18 # which they are by default.
19 #
20 # No matter how automated this gets, you'll always need to read
21 # and re-read pumpkin.pod and release_managers_guide.pod to
22 # check for things to be done at various stages of the process.
23 #
24 # Tim Bunce, June 1997
25
26 use ExtUtils::Manifest qw(fullcheck);
27 $ExtUtils::Manifest::Quiet = 1;
28 use Getopt::Std;
29
30 $|=1;
31
32 sub usage { die <<EOF; }
33 usage: $0 [ -r rootdir ] [-s suffix ] [ -b ] [ -n ]
34     -r rootdir   directory under which to create the build dir and tarball
35                  defaults to '..'
36     -s suffix    suffix to append to to the perl-x.y.z dir and tarball name
37                  defaults to the concatenaion of the local_patches entry
38                  in patchlevel.h (or blank, if none)
39     -b           make a .bz2 file in addtion to a .gz file
40     -n           do not make any tarballs, just the directory
41 EOF
42
43 my %opts;
44 getopts('bnr:s:', \%opts) or usage;
45 @ARGV && usage;
46
47 $relroot = defined $opts{r} ? $opts{r} : "..";
48
49 die "Must be in root of the perl source tree.\n"
50         unless -f "./MANIFEST" and -f "patchlevel.h";
51
52 open PATCHLEVEL,"<patchlevel.h" or die;
53 my @patchlevel_h = <PATCHLEVEL>;
54 close PATCHLEVEL;
55 my $patchlevel_h = join "", grep { /^#\s*define/ } @patchlevel_h;
56 print $patchlevel_h;
57 $revision = $1 if $patchlevel_h =~ /PERL_REVISION\s+(\d+)/;
58 $patchlevel = $1 if $patchlevel_h =~ /PERL_VERSION\s+(\d+)/;
59 $subversion = $1 if $patchlevel_h =~ /PERL_SUBVERSION\s+(\d+)/;
60 die "Unable to parse patchlevel.h" unless $subversion >= 0;
61 $vers = sprintf("%d.%d.%d", $revision, $patchlevel, $subversion);
62
63 # fetch list of local patches
64 my (@local_patches, @lpatch_tags, $lpatch_tags);
65 @local_patches = grep { /^static.*local_patches/../^};/ } @patchlevel_h;
66 @local_patches = grep { !/^\s*,?NULL/  } @local_patches;
67 @lpatch_tags   = map  {  /^\s*,"(\w+)/ } @local_patches;
68 $lpatch_tags   = join "-", @lpatch_tags;
69
70 $perl = "perl-$vers";
71 $reldir = "$perl";
72
73 $lpatch_tags = $opts{s} if defined $opts{s};
74 $reldir .= "-$lpatch_tags" if $lpatch_tags;
75
76 print "\nMaking a release for $perl in $relroot/$reldir\n\n";
77
78 print "Cross-checking the MANIFEST...\n";
79 ($missfile, $missentry) = fullcheck();
80 @$missentry
81     = grep {$_ !~ m!^\.git/! and $_ !~ m!(?:/|^)\.gitignore!} @$missentry;
82 if (@$missfile ) {
83     warn "Can't make a release with MANIFEST files missing:\n";
84     warn "\t".$_."\n" for (@$missfile);
85 }
86 if (@$missentry ) {
87     warn "Can't make a release with files not listed in MANIFEST\n";
88     warn "\t".$_."\n" for (@$missentry);
89
90 }
91 if ("@$missentry" =~ m/\.orig\b/) {
92     # Handy listing of find command and .orig files from patching work.
93     # I tend to run 'xargs rm' and copy and paste the file list.
94     my $cmd = "find . -name '*.orig' -print";
95     print "$cmd\n";
96     system($cmd);
97 }
98 die "Aborted.\n" if @$missentry or @$missfile;
99 print "\n";
100
101 # VMS no longer has hardcoded version numbers descrip.mms
102
103 print "Creating $relroot/$reldir release directory...\n";
104 die "$relroot/$reldir release directory already exists\n"   if -e "$relroot/$reldir";
105 die "$relroot/$reldir.tar.gz release file already exists\n" if -e "$relroot/$reldir.tar.gz";
106 mkdir("$relroot/$reldir", 0755) or die "mkdir $relroot/$reldir: $!\n";
107 print "\n";
108
109
110 print "Copying files to release directory...\n";
111 # ExtUtils::Manifest maniread does not preserve the order
112 $cmd = "awk '{print \$1}' MANIFEST | cpio -pdm $relroot/$reldir";
113 system($cmd) == 0
114     or die "$cmd failed";
115 print "\n";
116
117 chdir "$relroot/$reldir" or die $!;
118
119
120 my $SEARCH_ROOTS = 't ext lib dist cpan';
121
122 print "Setting file permissions...\n";
123 system("find . -type f -print     | xargs chmod 0444");
124 system("find . -type d -print     | xargs chmod 0755");
125 system("find $SEARCH_ROOTS -name '*.t'     -print | xargs chmod +x");
126 system("find $SEARCH_ROOTS -name 'test.pl' -print | xargs chmod +x");
127 my @exe = qw(
128     Configure
129     configpm
130     configure.gnu
131     cpan/Test-Harness/t/source_tests/source.sh
132     embed.pl
133     installperl
134     installman
135     keywords.pl
136     opcode.pl
137     t/TEST
138     *.SH
139     vms/ext/filespec.t
140     x2p/*.SH
141     Porting/findrfuncs
142     Porting/genlog
143     Porting/makerel
144     Porting/*.pl
145     mpeix/nm
146     mpeix/relink
147     Cross/generate_config_sh
148     Cross/warp
149 );
150 system("chmod +x @exe") == 0
151     or die "system: $!";
152
153 my @writables = qw(
154     NetWare/config_H.wc
155     NetWare/Makefile
156     keywords.h
157     opcode.h
158     opnames.h
159     pp_proto.h
160     pp.sym
161     proto.h
162     embed.h
163     embedvar.h
164     global.sym
165     overload.c
166     overload.h
167     perlapi.h
168     perlapi.c
169     cpan/Devel-PPPort/module2.c
170     cpan/Devel-PPPort/module3.c
171     reentr.c
172     reentr.h
173     regcharclass.h
174     regnodes.h
175     warnings.h
176     lib/warnings.pm
177     win32/Makefile
178     win32/Makefile.ce
179     win32/makefile.mk
180     win32/config_H.bc
181     win32/config_H.gc
182     win32/config_H.vc
183     utils/Makefile
184     uconfig.h
185 );
186 system("chmod +w @writables") == 0
187     or die "system: $!";
188
189 chdir ".." or die $!;
190
191 exit if $opts{n};
192
193 my $src = (-e $perl) ? $perl : 'perl'; # 'perl' in maint branch
194
195 print "Creating and compressing the tar.gz file...\n";
196 $cmd = "tar cf - $reldir | gzip --best > $reldir.tar.gz";
197 system($cmd) == 0 or die "$cmd failed";
198
199 if ($opts{b}) {
200     print "Creating and compressing the tar.bz2 file...\n";
201     $cmd = "tar cf - $reldir | bzip2 > $reldir.tar.bz2";
202     system($cmd) == 0 or die "$cmd failed";
203 }
204
205 print "\n";
206
207 system("ls -ld $perl*");
208 print "\n";
209
210 my $null = $^O eq 'MSWin32' ? 'NUL' : '/dev/null';
211 for my $sha (qw(sha1 shasum sha1sum)) {
212     if (`which $sha 2>$null`) {
213         system("$sha $perl*.tar.*");
214         last;
215     }
216 }