scripts/changelist.pl

   1 #!/usr/bin/env perl
   2 # Copyright:    2008-2010, Nick Treleaven
   3 # License:              GNU GPL V2 or later, as published by the Free Software Foundation, USA.
   4 # Warranty:             NONE
   5
   6 # Searches a ChangeLog file for a line matching 'matchstring', then matches
   7 # all lines until two consecutive empty lines are found. The process then
   8 # repeats until all matching blocks of text are found.
   9 # Results are printed in reverse, hence in chronological order (as ChangeLogs
  10 # are usually written in reverse date order).
  11 #
  12 # The resulting lines are then formatted to be easier to read and edit into a
  13 # NEWS file.
  14
  15 # Example ChangeLog format:
  16 #2009-04-03  Joe Author  <joe@example.net>
  17 #
  18 # * src/file.c, src/file.h,
  19 #   src/another.c:
  20 #   Some change description,
  21 #   spanning several lines.
  22 # * foo.c: Combined line.
  23
  24 use strict;
  25 use warnings;
  26
  27 my $argc = $#ARGV + 1;
  28
  29 ($argc == 2) or die <<END;
  30 Usage:
  31 $0 matchstring changelogfile >outfile
  32
  33   matchstring is not case sensitive.
  34 END
  35
  36 my ($matchstr, $infile) = @ARGV;
  37
  38 open(INPUT, $infile)
  39         or die "Couldn't open $infile for reading: $!\n";
  40
  41 my $entry;      # the current matching block of text
  42 my @entries;    # changelog entries, one per date
  43
  44 # first parse each ChangeLog entry into an array
  45
  46 my $found = 0;  # if we're in a matching block of text
  47 my $blank = 0;  # whether the last line was empty
  48
  49 while (<INPUT>) {
  50         my $line = $_;  # read a line, including \n char
  51
  52         if (! $found) {
  53                 ($line =~ m/$matchstr/) and $found = 1;
  54         } else {
  55                 if (length($line) <= 1) {       # current line is empty
  56                         if ($blank > 0) {       # previous line was also empty
  57                                 push(@entries, $entry); # append entry
  58                                 $entry = "";
  59                                 $found = 0;     # now look for next match
  60                                 $blank = 0;
  61                         }
  62                         else {
  63                                 $blank = 1;
  64                         }
  65                 }
  66         }
  67         if ($found) {
  68                 $entry .= $line;
  69         }
  70 }
  71 close(INPUT);
  72
  73 # reformat entries
  74 foreach $entry (reverse @entries) {
  75         my @lines = split(/\n/, $entry);
  76         my $fl = 0;     # in file list lines
  77         my $cm = 0; # in commit message lines
  78
  79         foreach my $line (@lines){
  80                 my $flset = $fl;
  81
  82                 # strip trailing space
  83                 $line =~ s/\s+$//g;
  84
  85                 if (!$cm){
  86                         # check if in filelist
  87                         ($line =~ m/ \* /) and $fl = 1;
  88                         # join filelist together on one line
  89                         $fl and ($line =~ s/^   / /);
  90                         if ($fl and ($line =~ m/:/)){
  91                                 $fl = 0;
  92                                 # separate ' * foo.c: Some edit.' messages:
  93                                 if (!($line =~ m/:$/)) {
  94                                         ($line =~ s/:/:\n*/);
  95                                 }
  96                         }
  97                         $fl and ($line =~ m/,$/) or $fl = 0;
  98                 }
  99                 if (!$flset){
 100                         # Asterisk commit messages
 101                         if (!$cm and ($line =~ m/^   /)){
 102                                 $cm = 1;
 103                                 $line =~ s/^(   )/$1* /;
 104                         } else {
 105                                 $cm and ($line =~ s/^(   )/$1  /);      # indent continuing lines
 106                         }
 107                         $cm and ($line =~ m/\.$/) and $cm = 0;
 108                 }
 109                 #~ print $fl.','.$cm.','.$line."\n"; next;      # debug
 110
 111                 # change file list start char to easily distinguish between file list and commit messages
 112                 $line =~ s/^ \* /@ /g;
 113                 # strip <email> from date line
 114                 $line =~ s/^([0-9-]+.*?)\s+<.+>$/$1/g;
 115                 # remove indent
 116                 $line =~ s/^   //g;
 117
 118                 if ($line ne ""){
 119                         print $line;
 120                         (!$fl) and print "\n";
 121                 }
 122         }
 123         print "\n";
 124 }