git://git.exim.org / exim.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
Quiet signedness compiler warnings.
[exim.git] / release-process / scripts / mk_exim_release.pl
diff --git a/release-process/scripts/mk_exim_release.pl b/release-process/scripts/mk_exim_release.pl
index f062baba54946969ae4e73ae5b843d235f66f022..d29770d2745d7d7c0e70c58e2ff60da0a6b39bc7 100755 (executable)
--- a/release-process/scripts/mk_exim_release.pl
+++ b/release-process/scripts/mk_exim_release.pl
@@ -1,7 +1,5 @@
-#!/usr/bin/perl
-#
-# $Cambridge: exim/release-process/scripts/mk_exim_release.pl,v 1.1 2010/06/03 12:00:38 nm4 Exp $
-#
+#!/usr/bin/env perl
+
 use strict;
 use warnings;
 use Carp;
 use strict;
 use warnings;
 use Carp;
@@ -9,7 +7,9 @@ use File::Copy;
 use File::Spec;
 use File::Path;
 use File::Temp;
 use File::Spec;
 use File::Path;
 use File::Temp;
+use FindBin;
 use Getopt::Long;
 use Getopt::Long;
+use IO::File;
 use Pod::Usage;
 
 my $debug   = 0;
 use Pod::Usage;
 
 my $debug   = 0;
@@ -19,13 +19,19 @@ my $verbose = 0;
 
 sub get_and_check_version {
     my $release = shift;
 
 sub get_and_check_version {
     my $release = shift;
+    my $context = shift;
 
     # make sure this looks like a real release version
     # which should (currently) be 4.xx or 4.xx_RCx
     unless ( $release =~ /^(4\.\d\d(?:_RC\d+)?)$/ ) {
         croak "The given version number does not look right - $release";
     }
 
     # make sure this looks like a real release version
     # which should (currently) be 4.xx or 4.xx_RCx
     unless ( $release =~ /^(4\.\d\d(?:_RC\d+)?)$/ ) {
         croak "The given version number does not look right - $release";
     }
-    return $1;    # untainted here...
+    my $full_release  = $1;              # untainted here...
+    my $trunc_release = $full_release;
+    $trunc_release =~ s/^(4\.\d\d)(?:_RC\d+)?$/$1/;
+
+    $context->{release}  = $full_release;
+    $context->{trelease} = $trunc_release;
 }
 
 # ------------------------------------------------------------------
 }
 
 # ------------------------------------------------------------------
@@ -62,7 +68,14 @@ sub deal_with_working_directory {
         }
     }
 
         }
     }
 
+    # create base directory
     mkpath( $context->{directory}, { verbose => ( $verbose || $debug ) } );
     mkpath( $context->{directory}, { verbose => ( $verbose || $debug ) } );
+
+    # set and create subdirectories
+    foreach (qw(release_tree pkgs pkgdirs docbook tmp)) {
+        $context->{$_} = File::Spec->catdir( $context->{directory}, $_ );
+        mkpath( $context->{$_}, { verbose => ( $verbose || $debug ) } );
+    }
 }
 
 # ------------------------------------------------------------------
 }
 
 # ------------------------------------------------------------------
@@ -71,7 +84,7 @@ sub export_git_tree {
     my $context = shift;
 
     # build git command
     my $context = shift;
 
     # build git command
-    my $archive_file = sprintf( '%s/%s-%s.tar', $context->{tmp_dir}, $context->{pkgname}, $context->{release} );
+    my $archive_file = sprintf( '%s/%s-%s.tar', $context->{tmp}, $context->{pkgname}, $context->{release} );
     $context->{tmp_archive_file} = $archive_file;
     my @cmd = ( 'git', 'archive', '--format=tar', "--output=$archive_file", $context->{tag} );
 
     $context->{tmp_archive_file} = $archive_file;
     my @cmd = ( 'git', 'archive', '--format=tar', "--output=$archive_file", $context->{tag} );
 
@@ -86,7 +99,7 @@ sub unpack_tree {
     my $context = shift;
 
     die "Cannot see archive file\n" unless ( -f $context->{tmp_archive_file} );
     my $context = shift;
 
     die "Cannot see archive file\n" unless ( -f $context->{tmp_archive_file} );
-    my @cmd = ( 'tar', 'xf', $context->{tmp_archive_file} );
+    my @cmd = ( 'tar', 'xf', $context->{tmp_archive_file}, '-C', $context->{release_tree} );
 
     # run  command
     print( "Running: ", join( ' ', @cmd ), "\n" ) if ($verbose);
 
     # run  command
     print( "Running: ", join( ' ', @cmd ), "\n" ) if ($verbose);
@@ -95,9 +108,94 @@ sub unpack_tree {
 
 # ------------------------------------------------------------------
 
 
 # ------------------------------------------------------------------
 
+sub make_version_script {
+    my $context = shift;
+
+    my $variant = substr( $context->{release}, length($context->{trelease}) );
+    if ( $context->{release} ne $context->{trelease} . $variant ) {
+        die "Broken version numbering, I'm buggy";
+    }
+
+    my $srcdir    = File::Spec->catdir( $context->{release_tree}, 'src', 'src' );
+    chdir $srcdir or die "chdir $srcdir: $\n";
+
+    if ( -f "version.sh" ) {
+        print( "WARNING: version.sh already exists - leaving it in place\n" );
+        return;
+    }
+
+    my @cmd = ("../scripts/reversion", "release");
+    print( "Running: ", join( ' ', @cmd ), "\n" ) if ($verbose);
+    system(@cmd) == 0 || croak "reversion failed";
+
+    unlink "version.h";
+
+    -f "version.sh" or die "failed to create version.h";
+}
+
+# ------------------------------------------------------------------
+
+sub build_html_documentation {
+    my $context = shift;
+
+    my $genpath   = $context->{webgen_base} . '/script/gen.pl';
+    my $templates = $context->{webgen_base} . '/templates';
+    my $dir       = File::Spec->catdir( $context->{release_tree}, 'html' );
+    my $spec      = File::Spec->catfile( $context->{docbook}, 'spec.xml' );
+    my $filter    = File::Spec->catfile( $context->{docbook}, 'filter.xml' );
+
+    mkdir($dir);
+
+    my @cmd = (
+        $genpath,   '--spec',    $spec,                '--filter',
+        $filter,    '--latest',  $context->{trelease}, '--tmpl',
+        $templates, '--docroot', $dir,                 '--localstatic'
+    );
+
+    print "Executing ", join( ' ', @cmd ), "\n";
+    system(@cmd);
+
+    # move directory into right place
+    my $sourcedir = File::Spec->catdir( $context->{docbook}, 'filter.xml' );
+
+    rename(
+        File::Spec->catdir( $dir,                sprintf( 'exim-html-%s', $context->{trelease} ) ),
+        File::Spec->catdir( $context->{pkgdirs}, sprintf( 'exim-html-%s', $context->{release} ) )
+    );
+}
+
+# ------------------------------------------------------------------
+
+sub copy_docbook_files {
+    my $context = shift;
+
+    # where the generated docbook files can be found
+    my $docdir = File::Spec->catdir( $context->{release_tree}, 'doc', 'doc-docbook' );
+
+    # where the website docbook source dir is - push files to here
+    my $webdir = File::Spec->catdir( $context->{webgen_base}, 'docbook', $context->{trelease} );
+    mkpath( $webdir, { verbose => ( $verbose || $debug ) } );
+
+    foreach my $file ( 'spec.xml', 'filter.xml' ) {
+        my $from  = File::Spec->catfile( $docdir,             $file );
+        my $to    = File::Spec->catfile( $context->{docbook}, $file );
+        my $webto = File::Spec->catfile( $webdir,             $file );
+        copy( $from, $to );
+        copy( $from, $webto );
+    }
+}
+
+# ------------------------------------------------------------------
+
 sub build_documentation {
 sub build_documentation {
-    system("cd doc/doc-docbook && ./OS-Fixups && make everything") == 0
+    my $context = shift;
+
+    my $docdir = File::Spec->catdir( $context->{release_tree}, 'doc', 'doc-docbook' );
+    system("cd '$docdir' && ./OS-Fixups && make EXIM_VER=$context->{release} everything") == 0
       || croak "Doc build failed";
       || croak "Doc build failed";
+
+    copy_docbook_files($context);
+    build_html_documentation($context);
 }
 
 # ------------------------------------------------------------------
 }
 
 # ------------------------------------------------------------------
@@ -105,8 +203,9 @@ sub build_documentation {
 sub move_text_docs_into_pkg {
     my $context = shift;
 
 sub move_text_docs_into_pkg {
     my $context = shift;
 
-    my $old_docdir = 'doc/doc-docbook';
-    my $new_docdir = File::Spec->catdir( $context->{pkgdir}, 'doc' );
+    my $old_docdir = File::Spec->catdir( $context->{release_tree}, 'doc', 'doc-docbook' );
+    my $old_txtdir = File::Spec->catdir( $context->{release_tree}, 'doc', 'doc-txt' );
+    my $new_docdir = File::Spec->catdir( $context->{eximpkgdir}, 'doc' );
     mkpath( $new_docdir, { verbose => ( $verbose || $debug ) } );
 
     # move generated documents from docbook stuff
     mkpath( $new_docdir, { verbose => ( $verbose || $debug ) } );
 
     # move generated documents from docbook stuff
@@ -115,7 +214,7 @@ sub move_text_docs_into_pkg {
     }
 
     # move text documents across
     }
 
     # move text documents across
-    foreach my $file ( glob( File::Spec->catfile( 'doc/doc-txt', '*' ) ) ) {
+    foreach my $file ( glob( File::Spec->catfile( $old_txtdir, '*' ) ) ) {
 
         # skip a few we dont want
         my $fn = ( File::Spec->splitpath($file) )[2];
 
         # skip a few we dont want
         my $fn = ( File::Spec->splitpath($file) )[2];
@@ -134,15 +233,16 @@ sub build_pspdfinfo_directory {
 
     ##foreach my $format (qw/pdf postscript texinfo info/) {
     foreach my $format (qw/pdf postscript/) {
 
     ##foreach my $format (qw/pdf postscript texinfo info/) {
     foreach my $format (qw/pdf postscript/) {
-        my $dir = sprintf( 'exim-%s-%s', $format, $context->{release} );
-        my $target = File::Spec->catdir( $dir, 'doc' );
+        my $target = File::Spec->catdir( $context->{pkgdirs}, sprintf( 'exim-%s-%s', $format, $context->{release} ), 'doc' );
         mkpath( $target, { verbose => ( $verbose || $debug ) } );
 
         # move documents across
         foreach my $file (
             glob(
                 File::Spec->catfile(
         mkpath( $target, { verbose => ( $verbose || $debug ) } );
 
         # move documents across
         foreach my $file (
             glob(
                 File::Spec->catfile(
-                    'doc/doc-docbook',
+                    $context->{release_tree},
+                    'doc',
+                    'doc-docbook',
                     (
                         ( $format eq 'postscript' )
                         ? '*.ps'
                     (
                         ( $format eq 'postscript' )
                         ? '*.ps'
@@ -152,42 +252,25 @@ sub build_pspdfinfo_directory {
             )
           )
         {
             )
           )
         {
-            my $fn = ( File::Spec->splitpath($file) )[2];
-            move( $file, File::Spec->catfile( $target, $fn ) );
+            move( $file, File::Spec->catfile( $target, ( File::Spec->splitpath($file) )[2] ) );
         }
     }
 }
 
 # ------------------------------------------------------------------
 
         }
     }
 }
 
 # ------------------------------------------------------------------
 
-sub build_html_directory {
-    my $context = shift;
-
-    my $dir = sprintf( 'exim-%s-%s', 'html', $context->{release} );
-    my $target = File::Spec->catdir( $dir, 'doc', 'html' );
-    mkpath( $target, { verbose => ( $verbose || $debug ) } );
-
-    # move documents across
-    move( File::Spec->catdir( 'doc/doc-docbook', 'spec_html' ), File::Spec->catdir( $target, 'spec_html' ) );
-    foreach my $file ( glob( File::Spec->catfile( 'doc/doc-docbook', '*.html' ) ) ) {
-        my $fn = ( File::Spec->splitpath($file) )[2];
-        move( $file, File::Spec->catfile( $target, $fn ) );
-    }
-}
-
-# ------------------------------------------------------------------
-
 sub build_main_package_directory {
     my $context = shift;
 
 sub build_main_package_directory {
     my $context = shift;
 
+    # build the exim package directory path
+    $context->{eximpkgdir} = File::Spec->catdir( $context->{pkgdirs}, sprintf( 'exim-%s', $context->{release} ) );
+
     # initially we move the exim-src directory to the new directory name
     # initially we move the exim-src directory to the new directory name
-    my $pkgdir = sprintf( 'exim-%s', $context->{release} );
-    $context->{pkgdir} = $pkgdir;
-    rename( 'src', $pkgdir ) || croak "Rename of src dir failed - $!";
+    rename( File::Spec->catdir( $context->{release_tree}, 'src' ), $context->{eximpkgdir} )
+      || croak "Rename of src dir failed - $!";
 
     # add Local subdirectory
 
     # add Local subdirectory
-    my $target = File::Spec->catdir( $pkgdir, 'Local' );
-    mkpath( $target, { verbose => ( $verbose || $debug ) } );
+    mkpath( File::Spec->catdir( $context->{eximpkgdir}, 'Local' ), { verbose => ( $verbose || $debug ) } );
 
     # now add the text docs
     move_text_docs_into_pkg($context);
 
     # now add the text docs
     move_text_docs_into_pkg($context);
@@ -200,7 +283,37 @@ sub build_package_directories {
 
     build_main_package_directory($context);
     build_pspdfinfo_directory($context);
 
     build_main_package_directory($context);
     build_pspdfinfo_directory($context);
-    build_html_directory($context);
+}
+
+# ------------------------------------------------------------------
+
+sub do_cleanup {
+    my $context = shift;
+
+    print "Cleaning up\n" if ($verbose);
+    rmtree( $context->{release_tree}, { verbose => $debug } );
+    rmtree( $context->{docbook},      { verbose => $debug } );
+    rmtree( $context->{pkgdirs},      { verbose => $debug } );
+}
+
+# ------------------------------------------------------------------
+
+# We prefer gtar to tar if gtar exists in $PATH
+
+sub fix_paths_tar {
+    my $context = shift;
+    my $tar = $context->{tar_cmd};
+
+    return unless $tar eq 'tar';
+
+    foreach my $d (File::Spec->path()) {
+        my $p = File::Spec->catfile($d, 'gtar');
+        if (-x $p) {
+            $context->{tar_cmd} = $p;
+            print "Switched tar command to: $p\n" if ($verbose);
+            return;
+        }
+    }
 }
 
 # ------------------------------------------------------------------
 }
 
 # ------------------------------------------------------------------
@@ -208,9 +321,29 @@ sub build_package_directories {
 sub create_tar_files {
     my $context = shift;
 
 sub create_tar_files {
     my $context = shift;
 
-    foreach my $dir ( glob( 'exim*-' . $context->{release} ) ) {
-        system("tar cfz ${dir}.tar.gz ${dir}");
-        system("tar cfj ${dir}.tar.bz2 ${dir}");
+    my $pkgs    = $context->{pkgs};
+    my $pkgdirs = $context->{pkgdirs};
+    my $tar     = $context->{tar_cmd};
+    if ($verbose) {
+        foreach my $c (keys %{ $context->{compressors} }) {
+            print "Compression: $c\t$context->{compressors}{$c}\n";
+        }
+    }
+
+    foreach my $dir ( glob( File::Spec->catdir( $pkgdirs, ( 'exim*-' . $context->{release} ) ) ) ) {
+        my $dirname = ( File::Spec->splitdir($dir) )[-1];
+        if ($context->{compressors}{gzip}) {
+            print "Creating: ${pkgs}/${dirname}.tar.gz\n" if ($verbose);
+            system("$tar cf  ${pkgs}/${dirname}.tar.gz  --gzip  -C ${pkgdirs} ${dirname}")
+        }
+        if ($context->{compressors}{bzip2}) {
+            print "Creating: ${pkgs}/${dirname}.tar.bz2\n" if ($verbose);
+            system("$tar cf  ${pkgs}/${dirname}.tar.bz2 --bzip2 -C ${pkgdirs} ${dirname}")
+        }
+        if ($context->{compressors}{lzip}) {
+            print "Creating: ${pkgs}/${dirname}.tar.lz\n" if ($verbose);
+            system("$tar cf  ${pkgs}/${dirname}.tar.lz  --lzip  -C ${pkgdirs} ${dirname}")
+        }
     }
 }
 
     }
 }
 
@@ -219,21 +352,33 @@ sub create_tar_files {
     my $man;
     my $help;
     my $context = {
     my $man;
     my $help;
     my $context = {
-        pkgname  => 'exim',
-        orig_dir => File::Spec->curdir(),
-        tmp_dir  => File::Temp->newdir(),
+        pkgname     => 'exim',
+        orig_dir    => File::Spec->curdir(),
+        tmp_dir     => File::Temp->newdir(),
+        webgen_base => "$FindBin::Bin/../../../exim-website",
+        tar_cmd     => 'tar',
+        compressors => {
+                gzip    => 1,
+                bzip2   => 1,
+                lzip    => 0,
+        },
     };
     my $delete;
     };
     my $delete;
+    my $cleanup = 1;
     ##$ENV{'PATH'} = '/opt/local/bin:' . $ENV{'PATH'};
 
     unless (
         GetOptions(
     ##$ENV{'PATH'} = '/opt/local/bin:' . $ENV{'PATH'};
 
     unless (
         GetOptions(
-            'directory=s' => \$context->{directory},
-            'verbose!'    => \$verbose,
-            'debug!'      => \$debug,
-            'help|?'      => \$help,
-            'man!'        => \$man,
-            'delete!'     => \$delete,
+            'directory=s'   => \$context->{directory},
+            'webgen_base=s' => \$context->{webgen_base},
+            'tar'           => \$context->{tar_cmd},
+            'lzip!'         => \$context->{compressors}{lzip},
+            'verbose!'      => \$verbose,
+            'debug!'        => \$debug,
+            'help|?'        => \$help,
+            'man!'          => \$man,
+            'delete!'       => \$delete,
+            'cleanup!'      => \$cleanup,
         )
       )
     {
         )
       )
     {
@@ -242,15 +387,18 @@ sub create_tar_files {
     pod2usage(0) if $help;
     pod2usage( -verbose => 2 ) if $man;
 
     pod2usage(0) if $help;
     pod2usage( -verbose => 2 ) if $man;
 
-    $context->{release} = get_and_check_version(shift);
-    $context->{tag}     = build_tag($context);
+    get_and_check_version( shift, $context );
+    fix_paths_tar($context);
+    $context->{tag} = build_tag($context);
     deal_with_working_directory( $context, $delete );
     export_git_tree($context);
     chdir( $context->{directory} ) || die;
     unpack_tree($context);
     deal_with_working_directory( $context, $delete );
     export_git_tree($context);
     chdir( $context->{directory} ) || die;
     unpack_tree($context);
+    make_version_script($context);
     build_documentation($context);
     build_package_directories($context);
     create_tar_files($context);
     build_documentation($context);
     build_package_directories($context);
     create_tar_files($context);
+    do_cleanup($context) if ($cleanup);
 }
 
 1;
 }
 
 1;
@@ -270,7 +418,9 @@ mk_exim_release.pl [options] version
    --verbose           force verbose mode
    --help              display this help and exits
    --man               displays man page
    --verbose           force verbose mode
    --help              display this help and exits
    --man               displays man page
+   --tar=cmd           command to use for tar
    --directory=dir     dir to package
    --directory=dir     dir to package
+   --no-lzip           do not create .tar.lz files
    --delete            Delete packaging directory at start
 
 =head1 OPTIONS
    --delete            Delete packaging directory at start
 
 =head1 OPTIONS
@@ -282,9 +432,19 @@ mk_exim_release.pl [options] version
 Forces debug mode cause all SQL statements generated by L<DBIx::Class>
 to be output.
 
 Forces debug mode cause all SQL statements generated by L<DBIx::Class>
 to be output.
 
+=item B<--tar>
+
+Use to override the path to the tar command; without this, will search for
+gtar, and if not found use tar.  Need GNU tar for lzip, unless --no-lzip is
+used.
+
+=item B<--lzip>
+
+Build the lzip tarballs.
+
 =item B<--verbose>
 
 =item B<--verbose>
 
-Force verbose mode - currently this has no effect
+Force verbose mode
 
 =item B<--help>
 
 
 =item B<--help>
 
@@ -314,3 +474,4 @@ Nigel Metheringham <Nigel.Metheringham@dev.intechnology.co.uk>
 Copyright 2010 Exim Maintainers. All rights reserved.
 
 =cut
 Copyright 2010 Exim Maintainers. All rights reserved.
 
 =cut
+# vim: set sw=4 et :
Master Exim source repository