maint/trim_changelog

   1 #! /usr/bin/perl -w
   2
   3 # Try to format ChangeLog in the current directory.
   4 # Remove unnecessary spaces.  Add spaces when needed.
   5
   6 use strict;
   7
   8 my $progname = "trim_changelog";
   9
  10 # Print message and exit (like "die", but without raising an exception).
  11 # System error is added at the end.
  12 sub error ($)
  13 {
  14         print STDERR "$progname: ERROR: " . shift(@_) . ": $!\n";
  15         exit 1;
  16 }
  17
  18 if ($#ARGV != -1) {
  19         print STDERR "$progname accepts no arguments\n";
  20         exit 1;
  21 }
  22
  23 open (CHANGELOG, "< ChangeLog") || error ("cannot open ChangeLog");
  24 open (CHNEW, "> ChangeLog.new") || error ("cannot open ChangeLog.new");
  25
  26 # Convert initial spaces in ChangeLog to tabs.
  27
  28 while (<CHANGELOG>) {
  29         # Trim trailing whitespace.
  30         s/\s*$//;
  31
  32         # Make sure there are exactly 2 spaces before the e-mail.
  33         s/(^\w.*[^\s])\s+</$1  </;
  34
  35         # Make sure there are exactly 2 spaces after numeric dates.
  36         s/(^[0-9]+-[0-9-]+)\s+/$1  /;
  37
  38         # Up to 7 spaces and tab or up to 8 spaces -> tab.
  39         if (/^( {1,7}\t| {1,8})(.*)/) {
  40                 $_ = "\t$2";
  41         }
  42
  43         print CHNEW "$_\n";
  44 }
  45
  46 close (CHANGELOG);
  47 close (CHNEW);
  48
  49 system ("cmp ChangeLog ChangeLog.new >/dev/null 2>&1");
  50
  51 if (($? >> 8) == 0) {
  52         unlink ("ChangeLog.new") || error ("Cannot remove ChangeLog.new");
  53         print "$progname: ChangeLog has not been changed\n";
  54         exit 0;
  55 }
  56
  57 rename ("ChangeLog", "ChangeLog.bak") ||
  58         error ("Cannot rename ChangeLog to ChangeLog.bak");
  59
  60 rename ("ChangeLog.new", "ChangeLog") ||
  61         error ("Cannot rename ChangeLog.new to ChangeLog");
  62
  63 print "$progname: ChangeLog has been changed\n";