#!/usr/bin/perl
# $Id: changelog2doc.pl,v 1.5 2010/10/31 13:27:03 fabiankeil Exp $
# $Source: /cvsroot/ijbswa/current/utils/changelog2doc.pl,v $
# Filter to parse the ChangeLog and translate the changes for
# the most recent version into something that looks like markup
# for the documentation but still needs fine-tuning.
use strict;
use warnings;
my @entries;
sub read_entries() {
my $section_reached = 0;
my $i = -1;
while (<>) {
if (/^\*{3} /) {
last if $section_reached;
$section_reached = 1;
next;
}
next unless $section_reached;
next if /^\s*$/;
if (/^(\s*)-/) {
my $indentation = length($1);
if ($i > 1 and $entries[$i]{indentation} > $indentation) {
$entries[$i]{last_list_item} = 1;
}
$i++;
$entries[$i]{description} = '';
$entries[$i]{indentation} = $indentation;
}
if (/:\s*$/) {
$entries[$i]{list_header} = 1;
}
s@^\s*-?\s*@@;
$entries[$i]{description} .= $_;
}
if ($entries[$i]{indentation} != 0) {
$entries[$i]{last_list_item} = 1;
}
print "Parsed " . @entries . " entries.\n";
}
sub create_listitem_markup($) {
my $entry = shift;
my $description = $entry->{description};
my $markup = '';
my $default_lws = ' ';
my $lws = $default_lws x ($entry->{indentation} ? 2 : 1);
chomp $description;
$description =~ s@\n@\n ${lws}@g;
$markup .= $lws . "\n" .
$lws . " \n";
$markup .= $lws . " " . $description . "\n";
if (defined $entry->{list_header}) {
$markup .= $lws . " \n";
} else {
if (defined $entry->{last_list_item}) {
$markup .= $lws . " \n";
$markup .= $lws . "\n";
$lws = $default_lws;
}
$markup .= $lws . " \n" .
$lws . "\n";
}
return $markup;
}
sub wrap_in_para_itemlist_markup($) {
my $content = shift;
my $markup = "\n" .
" \n" .
" $content" .
" \n" .
"\n";
return $markup;
}
sub generate_markup() {
my $markup = '';
foreach my $entry (@entries) {
$markup .= create_listitem_markup(\%{$entry});
}
print wrap_in_para_itemlist_markup($markup);
}
sub main () {
read_entries();
generate_markup();
}
main();