Re: Changelogs on kernel.org

[Tomas Szepe]

> Somebody make the mode changeable via command-line option...

Done... in a slightly different manner :)

cl:
- clean up
- indentation
- CMODE environment variable

./fmt /usr/src/ChangeLog-2.5.14			gives output in orig. mode
CMODE=2 ./fmt /usr/src/ChangeLog-2.5.14		gives output in orig. mode
CMODE=1 ./fmt /usr/src/ChangeLog-2.5.14		gives output in full mode
CMODE=0 ./fmt /usr/src/ChangeLog-2.5.14		gives output in terse mode

#!/usr/bin/perl -w
#
# 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]>
#
# Version 0.90.
#
# ------------------------------------------------------------------
# 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
#
# Groups and sorts the entries by email address:
#
# [e-mail]:
#	changelog #3
# [e-mail]
#	changelog text
#	yet another changelog
#
# There are three different modes:
# - Short mode (one changelog == one line)
# - Full mode (changelogs separated by dashed line)
# - Original mode (one line consisting of changelog and author)
#
# Where possible, also adds the real name of the author using
# a static hash %addresses
#

use strict;

# CMODE environment variable selects output mode:
# 0 for short, 1 for full, 2 for "original changelog"
# (default is 2 if $CMODE unset)
#
my $mode = 2;
foreach my $en (keys(%ENV)) {
	if ($en eq "CMODE") {
		$mode = $ENV{CMODE};
		if ($mode ne "0" && $mode ne "1" && $mode ne "2") {
			print "CMODE has to be 0 for short, 1 for full, 2 for orig. Undefined defaults to 2.\n";
			die();
		}
	}
}

# minimum space between entry and author for the original mode
my $space = 5;

# the key is the email address in ALL LOWER CAPS!
# the value is the real name of the person
my %addresses = (
	'[e-mail]' => 'Anton Altaparmakov',
	'[e-mail]' => 'Andi Kleen',
	'[e-mail]' => 'Andrew Morton',
	'[e-mail]' => 'Alan Cox',
	'[e-mail]' => 'Andrea Arcangeli',
	'[e-mail]' => 'Andrzej Krzysztofowicz',
	'[e-mail]' => 'Jens Axboe',
	'[e-mail]' => 'Brian Gerst',
	'[e-mail]' => 'Martin Dalecki',
	'[e-mail]' => 'David S. Miller',
	'[e-mail]' => 'Davide Libenzi',
	'[e-mail]' => 'Oleg Drokin',
	'[e-mail]' => 'Christoph Hellwig',
	'[e-mail]' => 'Jeff Garzik',
	'[e-mail]' => 'James Simmons',
	'[e-mail]' => 'James Simmons',
	'[e-mail]' => 'Keith Owens',
	'[e-mail]' => 'Larry McVoy',
	'[e-mail]' => 'Manfred Spraul',
	'[e-mail]' => 'Neil Brown',
	'[e-mail]' => 'Paul Mackerras',
	'[e-mail]' => 'Jaroslav Kysela',
	'[e-mail]' => 'Richard Gooch',
	'[e-mail]' => 'Russell King',
	'[e-mail]' => 'Tomas Szepe',
	'[e-mail]' => 'Linus Torvalds',
	'[e-mail]' => 'Alexander Viro',
	'~~~~~~thisentrylastforconvenience~~~~~' => 'Cesar Brutus Anonymous'
);

my %people = ();
my $addr = "";
my @cur = ();

sub append_item()
{
	if (!$addr) {
		return;
	}
	if (!$people{$addr}) {
		@{$people{$addr}} = ();
	}
	push @{$people{$addr}}, [@cur];

	@cur = ();
}

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

sub print_items($)
{
	my $person = $_[0];
	my $realname = rmap_address($person);
	my @items = @{$people{$person}};
	# Vain attempt to sort patches from one address
	@items = sort @items;
	if ($mode == 0 or $mode == 1) {
		if ($realname ne $person) {
			print "$realname ";
		}
		print "<$person>\n";
	}
	while ($_ = shift @items) {
		if ($mode == 0) {
			print "\to " . @$_[0];
		} elsif ($mode == 1) {
			print "\t------------------------------------------------------------\n";
			foreach $_ (@$_) {
				print "\t$_";
			}
		} elsif ($mode == 2) {
			$_ = @$_[0];
			chop;
			$_ = "o $_";
			# Split it onto two lines if necessary
			if (length("$_ . $realname") > 76 - $space) {
				print ("$_\n" . " " x (76-length($realname)) . "$realname\n");
			} else {
				print ("$_" . " " x (76-length($realname)-length($_)) . "$realname\n");
			}
		}
	}
}

while (<>)
{
	# Match address
	if (/^<([^>]+)>/) {
		# Add old item (if any) before beginning new
		append_item();
		$addr = $1;
	} elsif ($addr) {
		# Add line to patch
		s/^\s*(.*)\s*$/$1/;
		$_ =~ s/\[?PATCH\]?\s*//i;
		push @cur, "$_\n";
	} else {
		# Header information
		print;
	}
}
append_item();

# Print the information
foreach $addr (sort keys %people) {
	print_items($addr);
	if ($mode != 2) { print "\n"; }
}