lk-changelog.pl 0.33 (new option)

[Matthias Andree]

lk-changelog.pl is a script to rearrange/beautify BitKeeper changelogs,
as in:

bk set -d -rv2.4.19 -r+  | bk changes - \
| lk-changelog.pl --multi --nowarn --by-surname | less

We're now at 336 addresses, and still far from complete.

This release features a --by-surname feature, contributed by Marcus
Alanen, and the usual set of Little Brother's Data Base extracted
addresses, and some manually-added addresses.

You can download the self-documenting program AND A GPG SIGNATURE from
http://mandree.home.pages.de/linux/kernel/, or extract it below my
signature, but make sure your mailer properly decodes quoted-printable.

If you see 3D after an equality sign, download the file from the URL
above.

Checksums:

MD5:  dc77c91d8a80455f62e45838b0fd1c7e  lk-changelog.pl
SHA1: 71789367f992cfd0faecdacb3722bf4c0c0d4db5  lk-changelog.pl
GPG:  at http://mandree.home.pages.de/linux/kernel/lk-changelog-0.33.pl.asc

-- 
Matthias Andree

---snip---
#! /usr/bin/perl -wT

# This Perl script is meant to simplify/beautify BK ChangeLogs for the linux
# kernel.
#
# (C) Copyright 2002 by Matthias Andree <[e-mail]>
#			Marcus Alanen <[e-mail]>
#			Tomas Szepe <[e-mail]>
#
# $Id: lk-changelog.pl,v 0.33 2002/08/20 01:29:34 emma Exp $
# ----------------------------------------------------------------------
# Distribution of this script is permitted under the terms of the
# GNU General Public License (GNU GPL) v2.
# ----------------------------------------------------------------------

# This program expects its input in the following format:
# (E-Mail Addresses MUST NOT bear leading whitespace!)
#
# <[e-mail]>
#	changelog text
#	more changelog text
# <[e-mail]>
#	yet another changelog
# <[e-mail]>
#	changelog #3
#	more lines
#
# and discards all changelog lines but the first after an email address,
# and groups and sorts the entries by email address:
#
# [e-mail]:
#	changelog #3
# [e-mail]
#	changelog text
#	yet another changelog

require 5.005;
use strict;

use Carp;
use Getopt::Long;
use IO::File;
eval 'use Pod::Usage;';
if ($@) {
  eval 'sub pod2usage {
    print STDERR "Usage information would be presented here if you had Pod::Usage installed.\n"
      . "Try: perl -MCPAN -e \'install Pod::Usage\'\nAbort.\n";
    exit 2;
  }';
}
use Text::ParseWords;
use Text::Tabs;
use Text::Wrap;

# --------------------------------------------------------------------
# customize the following line to change the indentation of the change
# lines, $indent1 is used for the first line of an entry, $indent for
# all subsequent lines. $indent is auto-generated from $indent1.
my $indent1 = "  o ";
my $indent  = " " x length($indent1);
# change this to enable some debugging stuff:
my $debug = 0;
# --------------------------------------------------------------------

# the key is the email address in ALL LOWER CAPS!
# the value is the real name of the person
#
# Unless otherwise noted, the addresses below have been obtained using
# lbdbq.
my %addresses = (
'[e-mail]' => 'Abraham van der Merwe',
'[e-mail]' => 'Georg Acher',
'[e-mail]' => 'Javier Achirica',
'[e-mail]' => 'Arnaldo Carvalho de Melo',
'[e-mail]' => 'Arnaldo Carvalho de Melo',
'[e-mail]' => 'Adam J. Richter',
'[e-mail]' => 'Andreas Dilger',
'[e-mail]' => 'Andy Grover',
'[e-mail]' => 'Andy Grover',
'[e-mail]' => 'Anton Altaparmakov',
'[e-mail]' => 'Anton Altaparmakov',
'[e-mail]' => 'Anton Altaparmakov',
'[e-mail]' => 'Ani Joshi',
'[e-mail]' => 'Andi Kleen',
'[e-mail]' => 'Andrew Morton',
'[e-mail]' => 'Alan Cox',
'[e-mail]' => 'Alan Cox',
'[e-mail]' => 'Alfredo Sanjuán',
'[e-mail]' => 'Alberto Munoz',
'[e-mail]' => 'Erik Andersen',
'[e-mail]' => 'Anders Gustafsson',
'[e-mail]' => 'Andrea Arcangeli',
'[e-mail]' => 'Andries E. Brouwer',
'[e-mail]' => 'Andrzej Krzysztofowicz',
'[e-mail]' => 'Anton Blanchard',
'[e-mail]' => 'Arjan van de Ven',
'[e-mail]' => 'Arjan van de Ven',
'[e-mail]' => 'Arnd Bergmann',
'[e-mail]' => 'Asit K. Mallick', # by Kristian Peters
'[e-mail]' => 'Jens Axboe',
'[e-mail]' => 'Jens Axboe',
'[e-mail]' => 'D. J. Barrow',
'[e-mail]' => 'Ben Collins',
'[e-mail]' => 'Benjamin LaHaise',
'[e-mail]' => 'Brian Beattie', # from david.nelson
'[e-mail]' => 'Benjamin Herrenschmidt',
'[e-mail]' => 'Ben Fennema',
'[e-mail]' => 'Brian Gerst',
'[e-mail]' => 'Brad Hards',
'[e-mail]' => 'Bjorn Wesen',
'[e-mail]' => 'Bjorn Helgaas',
'[e-mail]' => 'Boris Itkis', # by Kristian Peters
'[e-mail]' => 'Brett Pemberton',
'[e-mail]' => 'Ken Brownfield',
'[e-mail]' => 'Adrian Bunk',
'[e-mail]' => 'Lennert Buytenhek',
'[e-mail]' => 'Chris Caputo',
'[e-mail]' => 'Christopher Hoover', # by Kristian Peters
'[e-mail]' => 'Samuel S. Chessman',
'[e-mail]' => 'Chris Wright',
'[e-mail]' => 'Christopher Leech',
'[e-mail]' => 'Colin Gibbs',
'[e-mail]' => 'Chris Hanson',
'[e-mail]' => 'Christoph Rohland',
'[e-mail]' => 'Charles-Edouard Ruault',
'[e-mail]' => 'Chad N. Tindel',
'[e-mail]' => 'Christopher Yeoh',
'[e-mail]' => 'Martin Dalecki',
'[e-mail]' => 'Martin Dalecki',
'[e-mail]' => 'Dave Jones',
'[e-mail]' => 'David S. Miller',
'[e-mail]' => 'David S. Miller',
'[e-mail]' => 'David Brownell',
'[e-mail]' => 'David Nelson',
'[e-mail]' => 'David Gibson',
'[e-mail]' => 'Davide Libenzi',
'[e-mail]' => 'David Mosberger',
'[e-mail]' => 'David Mosberger',
'[e-mail]' => 'David Mosberger',
'[e-mail]' => 'Dan Streetman',
'[e-mail]' => "Thomas 'Dent' Mirlacher",
'[e-mail]' => 'David Howells',
'[e-mail]' => 'Dirk Uffmann',
'[e-mail]' => 'Doug Ledford',
'[e-mail]' => 'Dave McCracken',
'[e-mail]' => 'Denis Oliver Kropp',
'[e-mail]' => 'Douglas Gilbert',
'[e-mail]' => 'David Woodhouse',
'[e-mail]' => 'David Woodhouse',
'[e-mail]' => 'Eric Brower',
'[e-mail]' => 'Ed Vance',
'[e-mail]' => 'Edward Peng',
'[e-mail]' => 'Erich Focht',
'[e-mail]' => 'Rolf Eike Beer',
'[e-mail]' => 'Steven Cole',
'[e-mail]' => 'Stéphane Eranian',
'[e-mail]' => 'Erik Habbinga',
'[e-mail]' => 'Frank Davis',
'[e-mail]' => 'Felipe Damasio', # by self (did not ask to include the W.)
'[e-mail]' => 'Bakonyi Ferenc',
'[e-mail]' => 'Jürgen E. Fischer',
'[e-mail]' => 'Florian Lohoff',
'[e-mail]' => 'Erich Focht',
'[e-mail]' => 'V. Ganesh',
'[e-mail]' => 'V. Ganesh',
'[e-mail]' => 'Kurt Garloff',
'[e-mail]' => 'Geert Uytterhoeven',
'[e-mail]' => 'Geert Uytterhoeven',
'[e-mail]' => 'George Anzinger',
'[e-mail]' => 'Ghozlane Toumi',
'[e-mail]' => 'Justin T. Gibbs',
'[e-mail]' => 'Justin T. Gibbs',
'[e-mail]' => 'Dr. David Alan Gilbert',
'[e-mail]' => 'Guennadi Liakhovetski',
'[e-mail]' => 'Greg Banks',
'[e-mail]' => 'Go Taniguchi',
'[e-mail]' => 'Patricia Guaghen',
'[e-mail]' => 'Oleg Drokin',
'[e-mail]' => 'Oleg Drokin',
'[e-mail]' => 'Greg Kroah-Hartman',
'[e-mail]' => 'Grant Grundler',
'[e-mail]' => 'Guillermo S. Romero',
'[e-mail]' => 'Ghozlane Toumi',
'[e-mail]' => 'Hanna Linder',
'[e-mail]' => 'Dave Hansen',
'[e-mail]' => 'Christoph Hellwig',
'[e-mail]' => 'Christoph Hellwig',
'[e-mail]' => 'Christoph Hellwig',
'[e-mail]' => 'Christoph Hellwig',
'[e-mail]' => 'Christoph Hellwig', # by Kristian Peters
'[e-mail]' => 'Henrique Gobbi',
'[e-mail]' => 'David Gibson',
'[e-mail]' => 'Hirofumi Ogawa', # corrected by himself
'[e-mail]' => 'Colin Slater',
'[e-mail]' => 'Hugh Dickins',
'[e-mail]' => 'Ivan Kokshaysky',
'[e-mail]' => 'Ion Badulescu',
'[e-mail]' => 'Ishan O. Jayawardena',
'[e-mail]' => 'Ingo Rohlfs',
'[e-mail]' => 'Ivan Gyurdiev',
'[e-mail]' => 'Jan Kara',
'[e-mail]' => 'Jan Harkes',
'[e-mail]' => 'Jakob Kemi',
'[e-mail]' => 'J. A. Magallon',
'[e-mail]' => 'James Mayer',
'[e-mail]' => 'Jamey Hicks',
'[e-mail]' => 'Jani Monoses',
'[e-mail]' => 'Jani Monoses',
'[e-mail]' => 'Jan-Benedict Glaw',
'[e-mail]' => 'David Ruggiero',
'[e-mail]' => 'David Ruggiero',
'[e-mail]' => 'Jes Degn Sørensen',
'[e-mail]' => 'Jeff Garzik',
'[e-mail]' => 'Jack Hammer',
'[e-mail]' => 'James Morris',
'[e-mail]' => 'Jochen Suckfuell',
'[e-mail]' => 'Johannes Erdfelt',
'[e-mail]' => 'John Clemens',
'[e-mail]' => 'John Kim',
'[e-mail]' => 'John Stultz',
'[e-mail]' => 'James Simmons',
'[e-mail]' => 'James Simmons',
'[e-mail]' => 'Jean Tourrilhes',
'[e-mail]' => 'Jean Tourrilhes',
'[e-mail]' => 'Karol Kasprzak', # by Kristian Peters
'[e-mail]' => 'Patrick McHardy',
'[e-mail]' => 'Kai Germaschewski',
'[e-mail]' => 'Kai Makisara',
'[e-mail]' => 'Kai Reichert',
'[e-mail]' => 'Kai Germaschewski',
'[e-mail]' => 'Kanoj Sarcar', # sent by Arnaldo Carvalho de Melo
'[e-mail]' => 'Kanoj Sarcar',
'[e-mail]' => 'Keith Owens',
'[e-mail]' => 'Kasper Dupont',
'[e-mail]' => 'Kent Yoder',
'[e-mail]' => 'Khalid Aziz',
'[e-mail]' => 'Khalid Aziz',
'[e-mail]' => 'Krzysztof Halasa',
'[e-mail]' => 'Ravikiran G. Thirumalai',
'[e-mail]' => 'Erik Inge Bolsø',
'[e-mail]' => 'Gerd Knorr',
'[e-mail]' => 'Gerd Knorr',
'[e-mail]' => 'Robert Kuebel',
'[e-mail]' => 'Alexey Kuznetsov',
'[e-mail]' => 'Ladislav Michl',
'[e-mail]' => 'Harald Welte',
'[e-mail]' => 'Laurent Latil',
'[e-mail]' => 'Luca Barbieri',
'[e-mail]' => 'Lionel Bouton',
'[e-mail]' => 'Martin Diehl',
'[e-mail]' => 'Liyang Hu',
'[e-mail]' => 'Larry McVoy',
'[e-mail]' => 'Marcus Alanen',
'[e-mail]' => 'Maciej W. Rozycki',
'[e-mail]' => 'Manfred Spraul',
'[e-mail]' => 'Marc Boucher',
'[e-mail]' => 'Marcel Holtmann', # sent by himself
'[e-mail]' => 'Marcelo Tosatti',
'[e-mail]' => 'Marcelo Tosatti',
'[e-mail]' => 'Mark McClelland',
'[e-mail]' => 'Martin J. Bligh',
'[e-mail]' => 'Martin Schwenke',
'[e-mail]' => 'Chris Mason',
'[e-mail]' => 'Heinz J. Mauelshagen',
'[e-mail]' => 'Maksim Krasnyanskiy',
'[e-mail]' => 'Marc-Christian Petersen',
'[e-mail]' => 'Matthew Dharm',
'[e-mail]' => 'Matthew Dharm',
'[e-mail]' => 'Michael Elizabeth Chastain',
'[e-mail]' => 'Michal Jaegermann',
'[e-mail]' => 'Mike Phillips',
'[e-mail]' => 'Mikael Pettersson',
'[e-mail]' => 'Mikulas Patocka',
'[e-mail]' => 'Miles Lane',
'[e-mail]' => 'Milton Miller', # by Kristian Peters
'[e-mail]' => 'Ingo Molnar',
'[e-mail]' => 'Martin Mares',
'[e-mail]' => 'Mirko Lindner',
'[e-mail]' => 'Mark McClelland',
'[e-mail]' => 'Patrick Mochel',
'[e-mail]' => 'Patrick Mochel',
'[e-mail]' => 'Patrick Mochel',
'[e-mail]' => 'Michal Ostrowski',
'[e-mail]' => 'Matt Wilson',
'[e-mail]' => 'Mufasa Yang', # sent by himself
'[e-mail]' => 'Muli Ben-Yehuda', # sent by himself
'[e-mail]' => 'Michael Westermann',
'[e-mail]' => 'Itai Nahshon',
'[e-mail]' => 'Nathan Scott',
'[e-mail]' => 'Neil Brown',
'[e-mail]' => 'Nemosoft Unv.',
'[e-mail]' => 'Nicolas Pitre',
'[e-mail]' => 'Nicolas Aspert',
'[e-mail]' => 'Niels Kristian Bech Jensen',
'[e-mail]' => 'Olaf Hering',
'[e-mail]' => 'Dave Olien',
'[e-mail]' => 'Oliver Neukum',
'[e-mail]' => 'Oliver Neukum',
'[e-mail]' => 'Oskar Schirmer', # sent by himself
'[e-mail]' => 'Owen Taylor',
'[e-mail]' => 'Peter De Shrijver',
'[e-mail]' => 'Paul Gortmaker',
'[e-mail]' => 'Paul Fulghum',
'[e-mail]' => 'Paul Mackerras',
'[e-mail]' => 'Paul Mackerras',
'[e-mail]' => 'Paul Mackerras',
'[e-mail]' => 'Pavel Janík',
'[e-mail]' => 'Pavel Machek',
'[e-mail]' => 'Pavel Machek',
'[e-mail]' => 'Andrey Panin',
'[e-mail]' => 'Jaroslav Kysela',
'[e-mail]' => 'Jaroslav Kysela',
'[e-mail]' => 'Peter Samuelson',
'[e-mail]' => 'Peter Chubb',
'[e-mail]' => 'Peter Osterlund',
'[e-mail]' => 'Petr Vandrovec',
'[e-mail]' => 'Pawel Kot',
'[e-mail]' => 'Paul Larson',
'[e-mail]' => 'Paul Menage',
'[e-mail]' => 'Ingo Albrecht',
'[e-mail]' => 'Daniel Quinlan',
'[e-mail]' => 'Juan Quintela',
'[e-mail]' => 'Ralf Baechle',
'[e-mail]' => 'Robert Cardell',
'[e-mail]' => 'Randy Dunlap',
'[e-mail]' => 'Udo A. Steinberg',
'[e-mail]' => 'Hans Reiser',
'[e-mail]' => 'Bob Miller',
'[e-mail]' => 'Richard Gooch',
'[e-mail]' => 'Richard Gooch',
'[e-mail]' => 'Richard Hirst',
'[e-mail]' => 'Riley Williams',
'[e-mail]' => 'Richard Brunner',
'[e-mail]' => 'Rik van Riel',
'[e-mail]' => 'Roger Luethi',
'[e-mail]' => 'Romain Lievin',
'[e-mail]' => 'Russell King',
'[e-mail]' => 'Russell King',
'[e-mail]' => 'Robert Love',
'[e-mail]' => 'Rob Radez',
'[e-mail]' => 'Robert Olsson',
'[e-mail]' => 'Roland Dreier',
'[e-mail]' => 'François Romieu',
'[e-mail]' => 'Richard Henderson',
'[e-mail]' => 'Rui Sousa',
'[e-mail]' => 'Rusty Russell',
'[e-mail]' => 'Randy Hron',
'[e-mail]' => 'Thomas Sailer',
'[e-mail]' => 'Eric Sandeen',
'[e-mail]' => 'Santiago A. Nullo', # sent by self
'[e-mail]' => 'sawa',
'[e-mail]' => 'Andreas Schwab',
'[e-mail]' => 'Martin Schwidefsky',
'[e-mail]' => 'Scott Feldman',
'[e-mail]' => 'Scott Anderson',
'[e-mail]' => 'Sebastian Dröge',
'[e-mail]' => 'Stephen Rothwell',
'[e-mail]' => 'Dave Kleikamp',
'[e-mail]' => 'Dave Kleikamp',
'[e-mail]' => 'Shing Chuang',
'[e-mail]' => 'Simon Burley',
'[e-mail]' => 'Stuart Lynne',
'[e-mail]' => 'Nathan Dabney',
'[e-mail]' => 'Geoffrey Lee', # by himself
'[e-mail]' => 'Simon Evans', # by Kristian Peters
'[e-mail]' => 'Jack Steiner',
'[e-mail]' => 'Stelian Pop',
'[e-mail]' => 'Steven Whitehouse',
'[e-mail]' => 'Stuart MacDonald',
'[e-mail]' => 'Sunil Saxena',
'[e-mail]' => 'Alan Swanson',
'[e-mail]' => 'Tomas Szepe',
'[e-mail]' => 'Taisuke Yamada',
'[e-mail]' => 'Tom Callaway',
'[e-mail]' => 'Tero Pirkkanen', # by Kristian Peters
'[e-mail]' => 'Tim Hockin',
'[e-mail]' => 'Tigran Aivazian',
'[e-mail]' => 'Tim Schmielau',
'[e-mail]' => 'Osamu Tomita',
'[e-mail]' => 'Anthony J. Breeds-Taurima',
'[e-mail]' => 'Linus Torvalds',
'[e-mail]' => 'Linus Torvalds',
'[e-mail]' => 'Linus Torvalds',
'[e-mail]' => 'Linus Torvalds',
'[e-mail]' => 'Tom Rini',
'[e-mail]' => 'Tom Rini',
'[e-mail]' => 'Trond Myklebust',
'[e-mail]' => 'Thierry Vignaud',
'[e-mail]' => 'Tim Waugh',
'[e-mail]' => 'Urban Widmark',
'[e-mail]' => 'Joshua Uziel',
'[e-mail]' => 'Petr Vandrovec',
'[e-mail]' => 'Alexander Viro',
'[e-mail]' => 'Vojtech Pavlik',
'[e-mail]' => 'Vojtech Pavlik',
'[e-mail]' => 'Vojtech Pavlik',
'[e-mail]' => 'Werner Almesberger',
'[e-mail]' => 'Matthew Wilcox',
'[e-mail]' => 'Willy Tarreau',
'[e-mail]' => 'Wim Van Sebroeck',
'[e-mail]' => 'Wolfgang Fritz', # by Kristian Peters
'[e-mail]' => 'William Stinson',
'[e-mail]' => 'Kasparek Tomas',
'[e-mail]' => 'Pete Zaitcev',
'[e-mail]' => 'Roman Zippel',
'[e-mail]' => 'Zwane Mwaikambo',
'~~~~~~thisentrylastforconvenience~~~~~' => 'Cesar Brutus Anonymous'
);

my %address_unknown;

# get name associated to an email address
sub rmap_address {
  my @o = map {defined $addresses{$_} ? $addresses{$_} :
		 scalar (($address_unknown{$_} = 1), $_); }
          map { lc; } @_;
  return wantarray ? @o : $o[0];
}

# case insensitive string comparison
# FIXME: use locale?
sub caseicmp { uc($a) cmp uc($b) };

# case insensitive string comparison by surname
# Strings are of the form
# "Firstname Surname <mailaddress>"
# or
# "<mailaddress>"
sub caseicmpbysurname {
  my $alast = "";
  my $blast = "";
  if ($a =~ m/([^\s]+)\s+\</) { $alast = $1; }
  if ($b =~ m/([^\s]+)\s+\</) { $blast = $1; }
  return uc($alast . $a) cmp uc($blast . $b);
}

my ($author, $address, $name);
# * $address is always an email address
# * $author can be the email address or Joe N. Sixpack II <[e-mail]>
#   (ready formatted to print)
# * $name is the name (Joe N. Sixpack II) or the mail address
#   (<[e-mail]>) 

sub get_name()   { return $name; }
sub get_author() { return $author; }

# This table maps MODE => { myhash }
# myhash knows the keys "index" and "print" to choose the respective functions
my %table =
  (
   'oneline' => { 'index' => \&get_name,
		  'print' => \&print_oneline },
   'terse'   => { 'index' => \&get_name,
		  'print' => \&print_terse },
   'grouped' => { 'index' => \&get_author,
		  'print' => \&print_grouped },
   'full'    => { 'index' => \&get_author,
		  'print' => \&print_full }
  );

# temp store
my $indexby;

# The sort function we will use
my $namesortfunc;

# Global store #############
# We store our options here.
my %opt;

# As we are parsing, the log is accumulated in the @cur array.  When
# we are done with one item (end of input or new mail address found),
# stuff a copy of this @cur array into the %log hash.
sub append_item(\%@)
# arguments: reference to hash
#            array to push
{
  my $log = shift;
  my @cur = @_;
  return unless @cur;
  return unless &$indexby;
  $log->{&$indexby} = () unless defined $log->{&$indexby};

  # strip trailing blank lines
  my $t;
  while (($t = pop(@cur)) eq '') { };
  push @cur, $t;

  # store the array
  push @{$log->{&$indexby}}, [@cur];
}

# Remove duplicates from hash, without changing the order.
# Prefix duplicates with the count.
sub countdups(@) {
  my %t;
  croak "do not call removedups() in scalar context" unless wantarray;
  my @u = grep (!$t{lc $_}++, @_);
  return map {
    $t{lc $_} > 1 ? sprintf("%d x ", $t{lc $_}) . $_ : $_; 
  } @u;
}

# Remove duplicates from array, without changing the order. The
# duplicates need not follow each other, so A B A is properly
# stripped down to A B
sub removedups(@) {
  my %t;
  croak "do not call removedups() in scalar context" unless wantarray;
  return grep (!$t{lc $_}++, @_);
}

# Compress the hash passed in, depending on the --compress and --count
# options in the %opt hash.
sub compress(@) {
  croak "do not call compress() in scalar context" unless wantarray;
  if ($opt{compress}) {
    if ($opt{count}) {
      return countdups(@_);
    } else {
      return removedups(@_);
    }
  } else {
    return @_;
  }
}

# report write error, exit
# do not return
sub write_error() {
  croak "Write error: $!\nAborting";
  exit (1);
}

# implementation of "grouped" output:
# author:
#   first line of log1
#   first line of log2
sub print_grouped(\%) {
  my $log = shift;
  for (sort $namesortfunc keys %$log) {
    my @lines = compress(map { $_->[0] . "\n"; } @{$log->{$_}});
    if ($opt{width}) {
      @lines = map { expand(wrap($indent1, $indent, ($_))); } @lines;
    } else {
      @lines = map { "$indent1$_" } @lines;
    }
    printtag($_) or write_error();
    print join("", @lines), "\n" or write_error();
  }
}

# implementation of "full" output
# author:
#   o log1
#     more information on changeset1
#   o log2
#     more information on changeset2
sub print_full(\%) {
  my $log = shift;
  for (sort $namesortfunc keys %$log) {
    printtag($_) or write_error();
    foreach (compress(@{$log->{$_}})) {
      my @lines = map { s/^\t//; "$_\n"; } @$_;
      if ($opt{width}) {
	@lines = expand(wrap($indent1, $indent, @lines));
      } else {
	@lines = map { "$indent$_"; } @lines;
	substr($lines[0], $[, length($indent1)) = $indent1;
      }
      print join("", @lines), "\n"  or write_error();
    }
  }
  print "\n"  or write_error();
}

# implementation of "terse" output
# with --swap          without --swap
# author1: log1        log1    (author1)
# author1: log2        log2    (author2)
# author2: log3        log3    (author3)
sub print_terse(\%) {
  my $log = shift;
  for (sort $namesortfunc keys %$log) {
    my $a = $_;
    if ($opt{width}) {
      if ($opt{swap}) {
	foreach (compress(map { $_->[0]; } @{$log->{$_}})) {
	  my @lines = expand(wrap($indent1, $indent, ("$a: $_")));
	  print join("\n", @lines), "\n"  or write_error();
	}
      } else {
	# width, but not swap set
	foreach (compress(map { $_->[0]; } @{$log->{$_}})) {
	  my @addr = expand(split(/\n/, wrap('', $indent, " ($a)")));
	  my @lines = expand(split(/\n/, wrap($indent1, $indent, ($_))));

	  if (length($lines[$#lines]) + length($addr[0]) > $opt{width}) {
	    push @lines, '';
	  }
	  $lines[$#lines] .= sprintf("%*s", $opt{width}
				     - length($lines[$#lines]), $addr[0]);
	  shift @addr;
	  print join("\n", @lines), "\n"  or write_error();
	  foreach (@addr) {
	    printf "%*s\n", $opt{width}, $_  or write_error();
	  }
	}
      }
    } else {
      # using the ?: operator within the map is more maintainable, but
      # less efficient.
      if ($opt{swap}) {
	print join("\n", map { "$indent1$a: $_" }
		   compress(map { $_->[0]; } @{$log->{$_}})), "\n"
		     or write_error();
      } else {
	print join("\n", map { "$indent1$_ ($a)" } 
		   compress(map { $_->[0]; } @{$log->{$_}})), "\n"
		     or write_error();
      }
    }
  }
}

# implementation of "oneline" output
# which is similar to terse but reformats to one line exactly
# with --swap          without --swap
# author1: log1        log1    (author1)
# author1: log2        log2    (author2)
# author2: log3        log3    (author3)
sub print_oneline(\%) {
  my $log = shift;
  for (sort $namesortfunc keys %$log) {
    my $a = $_;
    if ($opt{width}) {
      if ($opt{swap}) {
	foreach (compress(map { $_->[0]; } @{$log->{$_}})) {
	  my $str = "$a: $_";
	  if (length($str) > $opt{width}) {
	    printf "%-.*s...\n", $opt{width}-3, $indent1 . "$a: $_"
	      or write_error();
	  } else {
	    printf "%-.*s\n", $opt{width}, $indent1 . "$a: $_"
	      or write_error();
	  }
	}
      } else { # not swapping
	foreach (compress(map { $_->[0]; } @{$log->{$_}})) {
	  my $l = $opt{width} - length($indent1) - length($a) - 3;
	  if (length($_) > $l) {
	    $l -= 3;
	    printf "%s%-*.*s... (%s)\n", $indent1, $l, $l, $_, $a;
	  } else {
	    printf "%s%-*.*s (%s)\n", $indent1, $l, $l, $_, $a;
	  }
	}
      }
    } else {
      # not $opt{width} -> same as print_terse
      print_terse(%$log);
    }
  }
}

# Abbreviate all components of the name except the last.  If capital
# Roman numerals form the last component, leave that and the previous
# component alone.
sub abbreviate_name($ ) {
  my @a = split /\s+/, $_[0];

  # treat Roman numerals as last part of name
  my $off = 0;
  $off = 1 if ($a[$#a] =~ /^[IVXLCMD]+$/);

  for (my $i = 0; $i < $#a - $off; $i++) {
    $a[$i] =~ s/^(.).*/$1./;
  }
  return join(" ", @a);
}

# Read a file and parse it into the %log hash.
sub parse_file(\%$$ ) {
# arguments: %log hash
#            file name
#            file handle (IO::Handle or IO::File)
  croak unless wantarray;
  my $log = shift;
  my $fn = shift;
  my $fh = shift;
  my @prolog;
  local $_;

  # initialize
  my @cur = ();
  my $first = 0;
  my $firstpar = 0;
  undef $address;

  # now go!

  # NOTE: the first @cur item can consist of multiple lines in the
  # source file which are joined together. This happens when the first
  # paragraph is longer than a single line.
  while($_ = $fh -> getline) {
    chomp;
    s/^  (\S)/\t$1/;
    # expand all tabs but the first
    $_ = expand($_);
    s/^        /\t/;

    if (defined $address and $opt{multi}
	and m{^[^<[:space:]]} and not m{^ChangeSet@}) {
      # if we are in multi mode, if we encounter a non-address
      # left-justified line, flush all data and print the header. The
      # defined $address trick lets this only trigger to switch back
      # from "log entry" to "prolog" mode
      append_item(%$log, @cur); @cur = ();
      doprint(@prolog);
      print "\n" or write_error(); # print blank line between changelogs
      @prolog = ($_);
      undef %$log;
      undef $address;
    } elsif (m{^<([^>]+)>} or m{^ChangeSet@[0-9.]+,\s*[-0-9:+ ]+,\s*(.*)}) {
      # go figure if a line starts with an address, if so, take it
      # resolve the address to a name if possible
      append_item(%$log, @cur); @cur = ();
      $address = $1;
      $name = rmap_address($address);
      if ($name ne $address) {
	if ($opt{'abbreviate-names'}) {
	  $name = abbreviate_name($name);
	}
	$author = $name . ' <' . $address . '>';
      } else {
	$author = '<' . $address . '>';
      }
      $first = 1;
      $firstpar = 1;
    } elsif ($first) {
      # we have a "first" line after an address, take it, 
      # strip common redundant tags

      # kill "PATCH" tag
      s/^\s*\[PATCH\]//;
      s/^\s*PATCH//;
      s/^\s*[-:]+\s*//;

      # strip trailing colon or period, and if we strip one,
      # we don't parse further lines as part of the first paragraph
      if (s/[:.]+\s*$//) { $firstpar = 0; }

      # kill leading and trailing whitespace for consistent indentation
      s/^\s+//; s/\s+$//;

      push @cur, $_;
      $first = 0;
    } elsif (defined $address) {
      # second or subsequent lines -- if in first paragraph,
      # append this line to the first log line.
      if (m/^\s*$/) { $firstpar = 0; }
      elsif (m/^\s*[-*o\#]/) { $firstpar = 0; }
      if ($firstpar) {
	s/^\s*/ /;
	$cur[0] .= $_;
      } else {
	push @cur, $_;
      }
      # we don't parse further lines as part of the first paragraph
      if (s/[:.]+\s*$//) { $firstpar = 0; }
    } else {
      # store header before a changelog
      push @prolog, $_;
    }
  }

  if ($fh -> error) {
    die "Error while reading from \"$fn\": $!";
  }

  # at file end, flush @cur array to %log.
  append_item(%$log, @cur);

  return @prolog;
}

# print a word-wrapped name or mail address, followed by a trailing colon.
# used by print_grouped and print_full
# passes the return value of print back up
sub printtag($ ) {
  my $a = shift;
  $a .= ':';
  return print $opt{width} ? expand(wrap("", "", ($a))) : $a, "\n";
}

# === MAIN PROGRAM ===============================================
# Command line arguments
# What options do we support?
my @opts = ("help|?|h", "man", "mode=s", "compress!", "count!", "width:i",
	    "swap!", "merge!", "warn!", "multi!", "abbreviate-names!",
	    "by-surname!");
#	    "bitkeeper|bk!");

# How do we parse them?
if ($Getopt::Long::VERSION gt '2.24') {
  Getopt::Long::Configure("gnu_getopt");
}

# set default options
$opt{mode} = 'grouped';
$opt{warn} = 1;

# Parse from environment, temporarily storing the original @ARGV.
if (defined $ENV{LINUXKERNEL_BK_FMT}) {
  my @savedargs = @ARGV;
  @ARGV = parse_line('\s+', 0, $ENV{LINUXKERNEL_BK_FMT});
  GetOptions(\%opt, @opts)
    or pod2usage(-verbose => 0,
		 -message => $0 . ': error in $LINUXKERNEL_BK_FMT');
  push @ARGV, @savedargs;
}

# Parse command line. Handle help, check for errors.
GetOptions(\%opt, @opts) or pod2usage(-verbose => 0);
pod2usage(-verbose => 1) if $opt{help};
pod2usage(-verbose => 2) if $opt{man};
pod2usage(-verbose => 0,
	  -message => ("$0: Unknown mode specified.\nValid modes are:\n    "
		       . join(" ", sort keys %table) . "\n"))
  unless defined $table{$opt{mode}};
pod2usage(-verbose => 0,
	  -message => "$0: No files given, refusing to read from a TTY.")
  if (not $opt{bitkeeper} and (@ARGV == 0) and (-t STDIN));
pod2usage(-verbose => 0,
	  -message => "$0: Must have one or two arguments in --bitkeeper mode.")
  if ($opt{bitkeeper} && (@ARGV < 1 || @ARGV > 2));
pod2usage(-verbose => 0,
	  -message => "$0: You cannot use --merge and --multi at the same time.")
  if ($opt{merge} and $opt{multi});

# Shortcut for programmer convenience :-)
$indexby = $table{$opt{mode}}->{'index'};

# --count implies --compress
if ($opt{count}) { $opt{compress} = 1; }

# Set the sort function
$namesortfunc = \&caseicmp;
if ($opt{'by-surname'}) { $namesortfunc = \&caseicmpbysurname; }

# if --width is without argument or the argument is zero,
# try to figure $COLUMNS or fall back to 80.
if (exists $opt{width} and not $opt{width}) {
  $opt{width} = $ENV{COLUMNS} ? $ENV{COLUMNS} : 80;
}

# Print the passed-in array linewise, checking for write errors
# Then call the configured function to print %log formatted
sub doprint(\%@ ) {
  my $log = shift;
  print join("\n", @_), "\n" or write_error();
  $table{$opt{mode}}->{print}->($log);
}

# --------------------------------------------------------------------
# Global initializations
$Text::Tabs::tabstop = 8;
$Text::Wrap::huge = 'wrap';
if ($opt{width}) {
  $Text::Wrap::columns = $opt{width};
}

if ($debug) {
  print STDERR "DEBUG: Options summary:\n";
  while (my ($k, $v) = each %opt) { print STDERR "DEBUG:   '$k' => '$v'\n"; }
  print STDERR "DEBUG: Arguments summary:\n";
  foreach (@ARGV) { print STDERR "DEBUG:   '$_'\n"; }
}

# Main program
my @prolog;
my %log;

if($opt{bitkeeper}) {
  # in Bitkeeper mode, try to figure the change set, and connect the
  # bk program to our stdin.
  die "not yet implemented";
} elsif (@ARGV) {
  # file names
  foreach my $fn (@ARGV) {
    my $fh = new IO::File;
    $fh->open($fn, "r")
      or die "cannot open \"$fn\": $!\nAborting";
    push @prolog, parse_file(%log, $fn, $fh);
    if (not $opt{merge}) {
      doprint(%log, @prolog);
      undef %log;
    }
    undef @prolog;
  }

  if ($opt{merge}) {
    doprint(%log, ());
  }
} else {
  # stdin
  my @prolog;
  my $fh = new IO::Handle;
  $fh->fdopen(fileno(STDIN), "r")
    or die "cannot open stdin: $!\nAborting";
  @prolog = parse_file(%log, "stdin", $fh);
  doprint(%log, @prolog);
}

# Flush STDOUT to prevent clobbering STDOUT with 2>&1-style redirections.
$| = 1;

# Warn about unknown addresses
if ($opt{warn}) {
  foreach (sort caseicmp keys %address_unknown) {
    print STDERR "Warning: unknown address \"$_\"\n" or write_error();
  }
}

__END__
# --------------------------------------------------------------------
# $Log: lk-changelog.pl,v $
# Revision 0.33  2002/08/20 01:29:34  emma
# The usual set of new addresses.
#
# Revision 0.32  2002/08/20 01:14:40  emma
# Add Marcel Holtmann, who sent a patch.
#
# Revision 0.31  2002/08/12 22:34:41  emma
# Patch by Marcus Alanen <[e-mail]>:
# Hi, patch to sort by developer surname, and a couple of more
# developers. Use if you want to.
#
# Revision 0.30  2002/07/20 17:18:28  emma
# Add one new address
#
# Revision 0.29  2002/07/17 23:10:13  emma
# 23 new addresses.
#
# Revision 0.28  2002/06/25 09:46:57  emma
# New mail addresses.
#
# Revision 0.27  2002/06/14 17:05:23  emma
# three new addresses
#
# Revision 0.26  2002/06/06 10:26:51  emma
# Get rid of global %log, pass it to sub functions by reference.
# Move IO::Handle/IO::File treatment back into main program.
# Prepare for integrating Bitkeeper.
#
# Revision 0.25  2002/06/04 00:01:23  emma
# Recognize "bk changes" output format (that is: "ChangeSet@1.234.5.6,
# date, programmer" tag line and body indented by two spaces). Reported
# by Marcelo Tosatti <[e-mail]>. Former versions would
# only recognize the BK-kernel-tools/changelog format (see
# http://gkernel.bkbits.net:8080/BK-kernel-tools/anno/changelog@1.5?nav=index.html|src/).
#
# Revision 0.24  2002/06/03 13:33:00  emma
# * Fix 'grouped', 'terse', 'oneline' modes (change to parse_file()). We
#   now take the first paragraph instead of the first line as log
#   entry. We also guess where the paragraph ends, it ends at a line with
#   trailing dot or colon, or if the next line is empty or starts with a
#   "bullet" (that is -, *, o or #).
# * New option --abbreviate-names.
# * Fix 'full' mode indentation, broken in v0.21 by expanding the tabs.
#   Now, the first tab is unexpanded again.
# * Enhance 'online' mode: if the log is truncated, append an ellipsis ("...").
# * Add more mail addresses.
# * Fix Brian Beattie's name (was "Michael Beattie").
#
# Revision 0.23  2002/06/03 12:36:01  emma
# More e-mail addresses.
#
# Revision 0.22  2002/05/29 20:28:20  emma
# Mail addresses added.
#
# Revision 0.21  2002/05/29 11:45:48  emma
# * Implement --mode=oneline.
# * Expand tabs in input lines (tab stops are spaced 8 columns away from each other).
# * Bugfix --multi mode: all append_item to flush @cur before printing.
# * Restore prolog detection in --multi mode for efficiency.
# * Undo the "unexpand()" that Text::Wrap does, it breaks our line width
#   calculation. In the long run, a replacement for Text::Wrap must be
#   found that does not unexpand().
#
# Revision 0.20  2002/05/29 10:44:35  emma
# New --multi option that states multiple changelogs are in the same file.
#
# Revision 0.19  2002/05/29 10:27:21  emma
# New option: --[no]warn: Warn about unknown addresses. By default
# enabled, use --nowarn to suppress.
#
# Revision 0.18  2002/05/29 10:17:00  emma
# New addresses.
#
# Revision 0.17  2002/05/25 23:32:49  emma
# Four new addresses.
#
# Revision 0.16  2002/05/22 15:52:26  emma
# Fix deliberate typo in use Pod::Usage that was left over from debugging.
#
# Revision 0.15  2002/05/22 14:05:13  emma
# Sort addresses/names case insensitively (not locale aware).
# Heed quotes when parsing $ENV{LINUXKERNEL_BK_FMT}. As I don't
# currently have Perl 5.004 to test the older Text::ParseWords
# implementation, script now requires Perl 5.005.
# Do not require Pod::Usage, but warn if it's missing.
#
# Revision 0.14  2002/05/22 12:39:59  emma
# Fold the print function dispatcher into %table.
# Parse files on command line individually, but allow to treat them as
# one with a new --merge option.
# Make @cur local to the parse function.
# Die on read errors on input files. Use IO::Handle to read files.
#
# Revision 0.13  2002/05/21 12:42:46  emma
# Add 3 mail addresses.
# Add commentary to the code.
# Check for write errors on STDOUT and die if one happens.
#
# Revision 0.12  2002/05/18 16:54:50  emma
# Make --compress work in terse mode.
# New feature: --swap in terse mode swaps address and log entry.
#
# Revision 0.11  2002/05/18 16:43:30  emma
# Support 'terse' mode.
#
# Revision 0.10  2002/05/18 16:15:10  emma
# Another set of addresses.
#
# Revision 0.9  2002/05/18 16:06:43  emma
# Dozens of new addresses.
#
# Revision 0.8  2002/05/18 15:46:01  emma
# 21 new addresses.
#
# Revision 0.7  2002/05/16 13:57:37  emma
# Add some documentation.
#
# Revision 0.6  2002/05/16 13:55:24  emma
# Fix shift ambiguity in printtag().
#
# Revision 0.5  2002/05/16 13:51:43  emma
# Implement grouped and full modes.
#
# Revision 0.4  2002/05/16 12:07:17  emma
# Add some POD.
# Do options and environment parsing.
# Prepare multiple output modes (only grouped supported at the moment.)
#
# Revision 0.3  2002/05/13 16:11:34  emma
# Compress identical ChangeLog lines (they need not be subsequent, note
# this feature has O(n^2) behaviour, where n is the number of stored
# ChangeLog lines per respective author):
#   Soft-fp fix:
#   Soft-fp fix:
# becomes:
#   2 x Soft-fp fix:
#
# Revision 0.2  2002/05/13 10:40:32  emma
# Only consider e-mail addresses that are left-justified.
# Suggested by Greg Kroah-Hartman <[e-mail]>.
#
=head1 NAME

lk-changelog.pl - Reformat BitKeeper ChangeLog for Linux Kernel

=head1 SYNOPSIS

lk-changelog.pl [options] [file [...]]

Try lk-changelog.pl --help or lk-changelog.pl --man for more information.

=head1 OPTIONS

 -h, --help          print this short help
     --man           print the manual page for this program

     --[no]compress  if true, suppress duplicate entries
     --[no]count     if true, fold duplicate entries into one,
                     prefixing it with the count. Implies --compress.
     --[no]swap      in terse and oneline mode, swap address and log entry.
     --[no]merge     treat all files on command line as one big file
                     and suppress the prolog
     --[no]multi     states that multiple changelogs are in one file
     --[no]warn      warn about unknown addresses. Default: set!
     --[no]abbreviate-names
                     abbreviate all but the last name
     --[no]by-surname
                     sort entries by surname

     --mode=MODE     specify the output format (use --man to find out more)
     --width[=WIDTH] specify the line length, if omitted: $COLUMNS or 80.
                     text lines will not exceed this length.

Warning: Neither --compress nor --count are currently functional with
--mode=full.

=head1 DESCRIPTION

Summarizes or reformats BitKeeper ChangeLogs for Linux Kernel 2.X.

=head1 ENVIRONMENT

=over

=item LINUXKERNEL_BK_FMT

Default options. These have the same meaning and syntax as the command
line options and are parsed before them, so you can override defaults
set in this variable on the command line. B<Example:> If you put
--swap here and --noswap on your command line, --noswap takes
precedence.

=back

=head1 EXAMPLES

=over

=item Reformat ChangeLog-2.5.17, displaying all changes grouped by
  their author (that is the default mode, but we specify it anyways),
  with 76 character wide lines:

 lk-changelog.pl --mode=grouped --width=76 ChangeLog-2.5.17

=item Reformat ChangeLog-2.5.18, displaying all changes and their
      author on in "-ac changelog style", with 80 character wide lines:

 lk-changelog.pl --mode=terse --width=80 ChangeLog-2.5.18

=item Reformat 2.4.19-pre ChangeLogs (several in one file) from your mailer:

Use the pipe command to pipe the mail into:

 lk-changelog.pl --multi --mode=terse --width=80

=back

=head1 AUTHOR

=over

=item * Matthias Andree <[e-mail]>

Main developer

=item * Marcus Alanen <[e-mail]>

=item * Tomas Szepe <[e-mail]>

=item * Further help from:

Albert D. Cahalan <[e-mail]>, Robinson Maureira Castillo
<[e-mail]>, Greg Kroah-Hartman <[e-mail]>.

=back

=head1 BUGS

=over

=item * The header is not wrapped for --width character wide lines.

=item * The implementation is not yet finished.

=item * This manual page is incomplete.

=item * --compress does not currently work with --mode=full.

=item * does not detect if the changelog is already summarized (as in Marcelo's 2.4.19-pre9 announcement on the list)

=back

=head1 TODO

=over

=item * --compress-me-harder

 To merge
   o iget_locked  [1/6]
   o iget_locked  [2/6]
   ...
   o iget_locked  [6/6]
 into
   o iget_locked  [1..6/6]

=item * Integrate Bitkeeper

=back

=cut