Docs typo

[users/jgh/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 f9dbe21a317981c1144ffde5aacf5a8927ad9fbb..995720e2c188110fad9afd69100bd4e04660844b 100755 (executable)
--- a/release-process/scripts/mk_exim_release.pl
+++ b/release-process/scripts/mk_exim_release.pl
@@ -1,7 +1,5 @@
 #!/usr/bin/env perl
 #!/usr/bin/env perl

-#
-# $Cambridge: exim/release-process/scripts/mk_exim_release.pl,v 1.1 2010/06/03 12:00:38 nm4 Exp $
-#
+

 use strict;
 use warnings;
 use Carp;
 use strict;
 use warnings;
 use Carp;


@@ -74,7 +72,7 @@ sub deal_with_working_directory {
     mkpath( $context->{directory}, { verbose => ( $verbose || $debug ) } );
 
     # set and create subdirectories
     mkpath( $context->{directory}, { verbose => ( $verbose || $debug ) } );
 
     # set and create subdirectories

-    foreach (qw(release_tree pkgs pkgdirs docbook)) {
+    foreach (qw(release_tree pkgs pkgdirs docbook tmp)) {

         $context->{$_} = File::Spec->catdir( $context->{directory}, $_ );
         mkpath( $context->{$_}, { verbose => ( $verbose || $debug ) } );
     }
         $context->{$_} = File::Spec->catdir( $context->{directory}, $_ );
         mkpath( $context->{$_}, { verbose => ( $verbose || $debug ) } );
     }


@@ -86,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} );
 


@@ -110,50 +108,29 @@ sub unpack_tree {
 
 # ------------------------------------------------------------------
 
 
 # ------------------------------------------------------------------
 

-sub adjust_version_extension {
+sub make_version_script {

     my $context = shift;
 
     my $context = shift;
 

-    return if ($context->{release} eq $context->{trelease});
-

     my $variant = substr( $context->{release}, length($context->{trelease}) );
     if ( $context->{release} ne $context->{trelease} . $variant ) {
         die "Broken version numbering, I'm buggy";
     }
     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' );
     my $srcdir    = File::Spec->catdir( $context->{release_tree}, 'src', 'src' );

-    my $version_h = File::Spec->catfile( $srcdir, 'version.h' );
-
-    my $fh        = new IO::File $version_h, 'r';
-    die "Cannot read version.h: $!\n" unless ( defined $fh );
-    my @lines = <$fh>;
-    $fh->close() or die "Failed to close-read($version_h): $!\n";
-
-    my $found = 0;
-    my $i;
-    for ( $i = 0 ; $i < @lines ; ++$i ) {
-        if ( $lines[$i] =~ /EXIM_VARIANT_VERSION/ ) {
-            $found = 1;
-           last;
-        }
-    }
-    die "Cannot find version.h EXIM_VARIANT_VERSION\n" unless $found;
-    unless ( $lines[$i] =~ m/^\s* \# \s* define \s+ EXIM_VARIANT_VERSION \s+ "(.*)" \s* $/x ) {
-        die "Broken version.h EXIM_VARIANT_VERSION line\n";
-    }
-    if ( length $1 ) {
-        print( "WARNING: version.h has a variant tag already defined: $1\n" );
-        print( "         not changing that tag\n" );
+    chdir $srcdir or die "chdir $srcdir: $!\n";
+
+    if ( -f "version.sh" ) {
+        print( "WARNING: version.sh already exists - leaving it in place\n" );

         return;
     }
 
         return;
     }
 

-    $lines[$i] = qq{#define EXIM_VARIANT_VERSION\t\t"$variant"\n};
-    # deliberately not verbose constrained:
-    print( "Adjusting version.h for $variant release.\n" );
+    my @cmd = ("../scripts/reversion", "release");
+    print( "Running: ", join( ' ', @cmd ), "\n" ) if ($verbose);
+    system(@cmd) == 0 || croak "reversion failed";
+
+    unlink "version.h";

 
 

-    $fh = new IO::File $version_h, "w";
-    die "Cannot write version.h: $!\n" unless ( defined $fh );
-    $fh->print( @lines );
-    $fh->close() or die "Failed to close-write($version_h): $!\n";
+    -f "version.sh" or die "failed to create version.h";

 }
 
 # ------------------------------------------------------------------
 }
 
 # ------------------------------------------------------------------


@@ -169,8 +146,12 @@ sub build_html_documentation {
 
     mkdir($dir);
 
 
     mkdir($dir);
 

-    my @cmd =
-      ( $genpath, '--spec', $spec, '--filter', $filter, '--latest', $context->{trelease}, '--tmpl', $templates, '--docroot', $dir );
+    my @cmd = (
+        $genpath,   '--spec',    $spec,                '--filter',
+        $filter,    '--latest',  $context->{trelease}, '--tmpl',
+        $templates, '--docroot', $dir,                 '--localstatic'
+    );
+    push @cmd, '--verbose' if $verbose or $debug;

 
     print "Executing ", join( ' ', @cmd ), "\n";
     system(@cmd);
 
     print "Executing ", join( ' ', @cmd ), "\n";
     system(@cmd);


@@ -211,7 +192,8 @@ sub build_documentation {
     my $context = shift;
 
     my $docdir = File::Spec->catdir( $context->{release_tree}, 'doc', 'doc-docbook' );
     my $context = shift;
 
     my $docdir = File::Spec->catdir( $context->{release_tree}, 'doc', 'doc-docbook' );

-    system("cd '$docdir' && ./OS-Fixups && make everything") == 0
+    # documentation building gets the truncated release, without RC
+    system("cd '$docdir' && ./OS-Fixups && $context->{make_cmd} EXIM_VER=$context->{trelease} everything") == 0

       || croak "Doc build failed";
 
     copy_docbook_files($context);
       || croak "Doc build failed";
 
     copy_docbook_files($context);


@@ -223,7 +205,8 @@ sub build_documentation {
 sub move_text_docs_into_pkg {
     my $context = shift;
 
 sub move_text_docs_into_pkg {
     my $context = shift;
 

-    my $old_docdir = File::Spec->catdir( $context->{eximpkgdir}, 'doc', 'doc-docbook' );
+    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 ) } );
 
     my $new_docdir = File::Spec->catdir( $context->{eximpkgdir}, 'doc' );
     mkpath( $new_docdir, { verbose => ( $verbose || $debug ) } );
 


@@ -233,14 +216,18 @@ 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];
         next
           if ( ( $fn eq 'ABOUT' )
             || ( $fn eq 'ChangeLog.0' )
 
         # skip a few we dont want
         my $fn = ( File::Spec->splitpath($file) )[2];
         next
           if ( ( $fn eq 'ABOUT' )
             || ( $fn eq 'ChangeLog.0' )

-            || ( $fn eq 'test-harness.txt' ) );
+            || ( $fn eq 'test-harness.txt' )
+            # Debian issue re licensing of RFCs
+            || ( $fn =~ /^draft-ietf-.*/ )
+            || ( $fn =~ /^rfc.*/ )
+             );

         move( $file, File::Spec->catfile( $new_docdir, $fn ) );
     }
 }
         move( $file, File::Spec->catfile( $new_docdir, $fn ) );
     }
 }


@@ -310,6 +297,7 @@ sub do_cleanup {
     my $context = shift;
 
     print "Cleaning up\n" if ($verbose);
     my $context = shift;
 
     print "Cleaning up\n" if ($verbose);

+    chdir( $context->{directory} ) || die;

     rmtree( $context->{release_tree}, { verbose => $debug } );
     rmtree( $context->{docbook},      { verbose => $debug } );
     rmtree( $context->{pkgdirs},      { verbose => $debug } );
     rmtree( $context->{release_tree}, { verbose => $debug } );
     rmtree( $context->{docbook},      { verbose => $debug } );
     rmtree( $context->{pkgdirs},      { verbose => $debug } );


@@ -317,15 +305,52 @@ sub do_cleanup {
 
 # ------------------------------------------------------------------
 
 
 # ------------------------------------------------------------------
 

+# 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;
+        }
+    }
+}
+
+# ------------------------------------------------------------------
+

 sub create_tar_files {
     my $context = shift;
 
     my $pkgs    = $context->{pkgs};
     my $pkgdirs = $context->{pkgdirs};
 sub create_tar_files {
     my $context = shift;
 
     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];
     foreach my $dir ( glob( File::Spec->catdir( $pkgdirs, ( 'exim*-' . $context->{release} ) ) ) ) {
         my $dirname = ( File::Spec->splitdir($dir) )[-1];

-        system("tar cfz ${pkgs}/${dirname}.tar.gz  -C ${pkgdirs} ${dirname}");
-        system("tar cfj ${pkgs}/${dirname}.tar.bz2 -C ${pkgdirs} ${dirname}");
+        if ($context->{compressors}{gzip}) {
+            print "Creating: ${pkgs}/${dirname}.tar.gz\n" if ($verbose || $debug);
+            system("$tar cf  ${pkgs}/${dirname}.tar.gz  --gzip  -C ${pkgdirs} ${dirname}")
+        }
+        if ($context->{compressors}{bzip2}) {
+            print "Creating: ${pkgs}/${dirname}.tar.bz2\n" if ($verbose || $debug);
+            system("$tar cf  ${pkgs}/${dirname}.tar.bz2 --bzip2 -C ${pkgdirs} ${dirname}")
+        }
+        if ($context->{compressors}{lzip}) {
+            print "Creating: ${pkgs}/${dirname}.tar.lz\n" if ($verbose || $debug);
+            system("$tar cf  ${pkgs}/${dirname}.tar.lz  --lzip  -C ${pkgdirs} ${dirname}")
+        }

     }
 }
 
     }
 }
 


@@ -338,6 +363,13 @@ sub create_tar_files {
         orig_dir    => File::Spec->curdir(),
         tmp_dir     => File::Temp->newdir(),
         webgen_base => "$FindBin::Bin/../../../exim-website",
         orig_dir    => File::Spec->curdir(),
         tmp_dir     => File::Temp->newdir(),
         webgen_base => "$FindBin::Bin/../../../exim-website",

+        tar_cmd     => 'tar',
+        make_cmd    => 'make',
+        compressors => {
+                gzip    => 1,
+                bzip2   => 1,
+                lzip    => 0,
+        },

     };
     my $delete;
     my $cleanup = 1;
     };
     my $delete;
     my $cleanup = 1;


@@ -347,6 +379,9 @@ sub create_tar_files {
         GetOptions(
             'directory=s'   => \$context->{directory},
             'webgen_base=s' => \$context->{webgen_base},
         GetOptions(
             'directory=s'   => \$context->{directory},
             'webgen_base=s' => \$context->{webgen_base},

+            'tar=s'         => \$context->{tar_cmd},
+            'make=s'        => \$context->{make_cmd},
+            'lzip!'         => \$context->{compressors}{lzip},

             'verbose!'      => \$verbose,
             'debug!'        => \$debug,
             'help|?'        => \$help,
             'verbose!'      => \$verbose,
             'debug!'        => \$debug,
             'help|?'        => \$help,


@@ -362,12 +397,13 @@ sub create_tar_files {
     pod2usage( -verbose => 2 ) if $man;
 
     get_and_check_version( shift, $context );
     pod2usage( -verbose => 2 ) if $man;
 
     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);
     $context->{tag} = build_tag($context);
     deal_with_working_directory( $context, $delete );
     export_git_tree($context);
     chdir( $context->{directory} ) || die;
     unpack_tree($context);

-    adjust_version_extension($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);


@@ -391,7 +427,10 @@ 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
+   --make=cmd          command to use for make

    --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


@@ -403,9 +442,24 @@ 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<--make>
+
+Use to override the path/name of the make command.
+Useful sometimes to force gmake.
+
+=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>
 


@@ -435,3 +489,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 :