diff options
Diffstat (limited to 'src/echangelog')
| -rwxr-xr-x[-rw-r--r--] | src/echangelog/echangelog | 766 | ||||
| -rw-r--r-- | src/echangelog/echangelog.1 | 127 | ||||
| -rw-r--r-- | src/echangelog/test/TEST.pm | 26 | ||||
| -rw-r--r-- | src/echangelog/test/templates/test.patch | 6 | ||||
| -rw-r--r-- | src/echangelog/test/templates/vcstest-0.0.1.ebuild | 16 | ||||
| -rwxr-xr-x | src/echangelog/test/test.sh | 192 |
6 files changed, 745 insertions, 388 deletions
diff --git a/src/echangelog/echangelog b/src/echangelog/echangelog index 1a4bee7..fea1af6 100644..100755 --- a/src/echangelog/echangelog +++ b/src/echangelog/echangelog @@ -11,6 +11,7 @@ use strict; use POSIX qw(strftime getcwd setlocale); use File::Find; +use Getopt::Long; # Fix bug 21022 by restricting to C locale setlocale(&POSIX::LC_ALL, "C"); @@ -21,121 +22,172 @@ $Text::Wrap::unexpand = 0; # Global variables my (@files, @ebuilds, @conflicts, @trivial, @unknown, @new_versions, %actions); -my ($input, $editor, $entry, $user, $date, $text, $version, $year, $vcs); - -my %vcs = ( cvs => { diff => "cvs -f diff -U0", - status => "cvs -fn up", - add => "cvs -f add", - skip => 6, - regex => qr/^Index: ()(([^\/]*?)\.ebuild)\s*$/ }, - svn => { diff => "svn diff -N", - status => "svn status", - add => "svn add", - skip => 6, - regex => qr/^Index: ()(([^\/]*?)\.ebuild)\s*$/ }, - git => { diff => "git diff", - status => "git diff-index HEAD --name-status", - add => "git add", - skip => 4, - regex => qr/^diff \-\-git \S*\/((\S*)\.ebuild)/ } +my ($input, $editor, $entry, $user, $date, $text, $year, $vcs); +my ($opt_help, $opt_strict, $opt_version); + +$opt_help = 0; +$opt_strict = 0; +$opt_version = 0; + +my %vcs = ( + cvs => { + diff => "cvs -f diff -U0", + status => "cvs -fn up", + add => "cvs -f add", + skip => 6, + regex => qr/^Index: (([^\/]*?)\.ebuild)\s*$/ + }, + svn => { + diff => "svn diff -N", + status => "svn status", + add => "svn add", + skip => 4, + regex => qr/^Index: (([^\/]*?)\.ebuild)\s*$/ + }, + git => { + diff => "git diff", + status => "git diff-index HEAD --name-status", + add => "git add", + # This value should usually be 3 but on new file mode we need skip+1. + # So 4 should be fine anyway. + skip => 4, + regex => qr/^diff \-\-git \S*\/((\S*)\.ebuild)/ + }, +); + +sub usage { + (my $usage = <<" EOF") =~ s/^\t//gm; + Usage: echangelog [options] <changelog message> + + Options: + --help err, this screen ... + --strict abort on trivial/no changes + --version show version info + EOF + print $usage; + exit 0; +} + +sub version { + my $Revision = "Last svn change rev"; + my $Date = "Last svn change date"; + my $foo = ""; + print "echangelog\n$Revision$foo \n$Date$foo\n"; + exit 0; +} +GetOptions( + 'help' => \$opt_help, + 'strict' => \$opt_strict, + 'version' => \$opt_version, ); -# Figure out what kind of repo we are in. +usage() if $opt_help; +version() if $opt_version; +# Figure out what kind of repo we are in. if ( -d "CVS" ) { - $vcs = "cvs"; + $vcs = "cvs"; } elsif ( -d '.svn' ) { - $vcs = "svn"; -} elsif ( -f '/usr/bin/git' and open GIT, "git rev-parse --git-dir |" ) { - $vcs = "git"; - close GIT; + $vcs = "svn"; } else { - die "No CVS, .git, .svn directories found, what kind of repo is this?"; + if ( -x '/usr/bin/git' ) { + open(GIT, '-|', "git rev-parse --git-dir 2>/dev/null"); + $vcs = "git" if defined(<GIT>); + close(GIT); + } + + if ( ! $vcs ) { + die "No CVS, .git, .svn directories found, what kind of repo is this?"; + } } # Read the current ChangeLog if (-f 'ChangeLog') { - open I, '<ChangeLog' or die "Can't open ChangeLog for input: $!\n"; - { local $/ = undef; $text = <I>; } - close I; + open I, '<ChangeLog' or die "Can't open ChangeLog for input: $!\n"; + { local $/ = undef; $text = <I>; } + close I; } else { - # No ChangeLog here, maybe we should make one... - if (<*.ebuild>) { - open C, "portageq envvar PORTDIR |" or die "Can't find PORTDIR"; - my ($new) = <C>; - close C; - $new =~ s/\s+$//; - open I, "< $new/skel.ChangeLog" - or die "Can't open $new/skel.ChangeLog for input: $!\n"; - { local $/ = undef; $text = <I>; } - close I; - my ($cwd) = getcwd(); - $cwd =~ m|.*/(\w+-\w+)/([^/]+)| - or die "Can't figure out category/package.. sorry!\n"; - my ($category, $package_name) = ($1, $2); - $text =~ s/^\*.*//ms; # don't need the fake entry - $text =~ s/<CATEGORY>/$category/; - $text =~ s/<PACKAGE_NAME>/$package_name/; - } else { - die "This should be run in a directory with ebuilds...\n"; - } + # No ChangeLog here, maybe we should make one... + if (<*.ebuild>) { + open C, "portageq envvar PORTDIR |" or die "Can't find PORTDIR"; + my ($new) = <C>; + close C; + + $new =~ s/\s+$//; + open I, "< $new/skel.ChangeLog" + or die "Can't open $new/skel.ChangeLog for input: $!\n"; + { local $/ = undef; $text = <I>; } + close I; + $text =~ s/^\*.*//ms; # don't need the fake entry + } else { + die "This should be run in a directory with ebuilds...\n"; + } } # Figure out what has changed around here open C, $vcs{$vcs}{status}.' 2>&1 |' or die "Can't run ".$vcs{$vcs}{status}.": $!\n"; while (<C>) { - if (/^C\s+(\S+)/) { - if($vcs eq "git") { - my $filename = $2; - $filename =~ /\S*\/(\S*)/; - if( -d $1 ) { + if (/^C\s+(\S+)/) { + if($vcs eq "git") { + my $filename = $2; + $filename =~ /\S*\/(\S*)/; + + if( -d $1 ) { + next; + } + + push @conflicts, $1; + next; + } + + push @conflicts, $1; next; - } - push @conflicts, $1; - next; - } - push @conflicts, $1; - next; - } elsif (/^\?\s+(\S+)/) { - if($vcs eq "git") { - my $filename = $2; - $filename =~ /\S*\/(\S*)/; - if( -d $1 ) { + } elsif (/^\?\s+(\S+)/) { + if($vcs eq "git") { + my $filename = $2; + $filename =~ /\S*\/(\S*)/; + + if( -d $1 ) { + next; + } + + push @unknown, $1; + next; + } else { + push @unknown, $1; + } + + $actions{$1} = '+'; next; - } - push @unknown, $1; - next; - } else { - push @unknown, $1; - } - $actions{$1} = '+'; - next; - } elsif (/^([ARMD])\s+(\S+)/) { - my ($status, $filename) = ($1,$2); - if($vcs eq "git") { - open P, "git-rev-parse --sq --show-prefix |"; - my $prefix = <P>; - $prefix = substr($prefix, 0, -1); - close P; - - if ($filename =~ /$prefix(\S*)/) { - $filename = $1 ; - } - else { - next; - } - } - if( -d $filename ) { - next; + } elsif (/^([ARMD])\s+\+?\s*(\S+)/) { + my ($status, $filename) = ($1,$2); + + if($vcs eq "git") { + open P, "git rev-parse --sq --show-prefix |"; + my $prefix = <P>; + $prefix = substr($prefix, 0, -1); + close P; + + if ($filename =~ /$prefix(\S*)/) { + $filename = $1 ; + } + else { + next; + } + } + + if( -d $filename ) { + next; + } + + push @files, $filename; + ($actions{$filename} = $status) =~ tr/DARM/-+-/d; } - push @files, $filename; - ($actions{$filename} = $status) =~ tr/DARM/-+-/d; - } } # git only shows files already added so we need to check for unknown files -# separately here. +# separately here. if($vcs eq "git") { find(\&git_unknown_objects, "./"); } @@ -145,131 +197,144 @@ sub git_unknown_objects { my ($dev,$ino,$mode,$nlink,$uid,$gid); # Ignore empty directories - git doesn't version them and cvs removes them. - if ((($dev,$ino,$mode,$nlink,$uid,$gid) = lstat($_)) && ! -d _) { + if ( (($dev,$ino,$mode,$nlink,$uid,$gid) = lstat($_)) && ! -d _ ) { open C, $vcs." status $_ 2>&1 1>/dev/null |"; - - while (<C>) { + + while (<C>) { $_ = <C>; push @unknown, $object; - }; - close C; + }; + + close C; }; } # Separate out the trivial files for now -@files = grep { - !/files.digest|Manifest|ChangeLog/ or do { push @trivial, $_; 0; } +@files = grep { + !/files.digest|Manifest|ChangeLog/ or do { push @trivial, $_; 0; } } @files; -@unknown = grep { - !/files.digest|Manifest|ChangeLog/ or do { push @trivial, $_; 0; } +@unknown = grep { + !/files.digest|Manifest|ChangeLog/ or do { push @trivial, $_; 0; } } @unknown; # Don't allow any conflicts if (@conflicts) { - print STDERR <<EOT; + print STDERR <<EOT; $vcs reports the following conflicts. Please resolve them before running echangelog. EOT - print STDERR map "C $_\n", @conflicts; - exit 1; + print STDERR map "C $_\n", @conflicts; + exit 1; } # Don't allow unknown files (other than the trivial files that were separated # out above) if (@unknown) { - print STDERR <<EOT; + print STDERR <<EOT; $vcs reports the following unknown files. Please use "$vcs add" before running echangelog, or remove the files in question. EOT - print STDERR map "? $_\n", @unknown; - exit 1; + print STDERR map "? $_\n", @unknown; + exit 1; } # Sort the list of files as portage does. None of the operations through # the rest of the script should break this sort. sub sortfunc($$) { - my ($a, $b) = @_; - (my $va = $a) =~ s/.*?-(\d.*?)(?:\.ebuild)?$/$1/; - (my $vb = $b) =~ s/.*?-(\d.*?)(?:\.ebuild)?$/$1/; - my ($na, $sa, $sna, $ra) = ($va =~ /^(.*?)(?:_(alpha|beta||pre|rc|p)(\d*))?(?:-r(\d+))?$/); - my ($nb, $sb, $snb, $rb) = ($vb =~ /^(.*?)(?:_(alpha|beta||pre|rc|p)(\d*))?(?:-r(\d+))?$/); - my (@na) = split /\.|(?<=\d)(?=[^\d\.])/, $na; - my (@nb) = split /\.|(?<=\d)(?=[^\d\.])/, $nb; - my $retval; - - # - # compare version numbers first - # - for (my $i = 0; defined $na[$i] or defined $nb[$i]; $i++) { - # def vs. undef - return +1 if defined $na[$i] and !defined $nb[$i]; - return -1 if defined $nb[$i] and !defined $na[$i]; - - # num vs. num - if ($na[$i] =~ /^\d/ and $nb[$i] =~ /^\d/) { - $retval = ($na[$i] <=> $nb[$i]); - return $retval if $retval; - next; - } - - # char vs. char - if ($na[$i] =~ /^\D/ and $nb[$i] =~ /^\D/) { - $retval = ($na[$i] cmp $nb[$i]); - return $retval if $retval; - next; - } - - # num vs. char - $retval = ($na[$i] =~ /\d/ and -1 or +1); - return $retval; - } - - # - # compare suffix second - # - if (defined $sa and !defined $sb) { - return +2 if $sa eq "p"; - return -2; - } - if (defined $sb and !defined $sa) { - return -3 if $sb eq "p"; - return +3; - } - - if (defined $sa) { # and defined $sb - $retval = ($sa cmp $sb); - if ($retval) { - return +4 if $sa eq "p"; - return -4 if $sb eq "p"; - return $retval; # suffixes happen to be alphabetical order, mostly - } - - # compare suffix number - return +5 if defined $sna and !defined $snb; - return -5 if defined $snb and !defined $sna; - if (defined $sna) { # and defined $snb - $retval = ($sna <=> $snb); - return $retval if $retval; - } - } - - # - # compare rev third - # - return +6 if defined $ra and !defined $rb; - return -6 if defined $rb and !defined $ra; - if (defined $ra) { # and defined $rb - return ($ra <=> $rb); - } - - # - # nothing left to compare - # - return 0; + my ($a, $b) = @_; + (my $va = $a) =~ s/.*?-(\d.*?)(?:\.ebuild)?$/$1/; + (my $vb = $b) =~ s/.*?-(\d.*?)(?:\.ebuild)?$/$1/; + my ($na, $sa, $sna, $ra) = ($va =~ /^(.*?)(?:_(alpha|beta||pre|rc|p)(\d*))?(?:-r(\d+))?$/); + my ($nb, $sb, $snb, $rb) = ($vb =~ /^(.*?)(?:_(alpha|beta||pre|rc|p)(\d*))?(?:-r(\d+))?$/); + my (@na) = split /\.|(?<=\d)(?=[^\d\.])/, $na; + my (@nb) = split /\.|(?<=\d)(?=[^\d\.])/, $nb; + my $retval; + + # + # compare version numbers first + # + for (my $i = 0; defined $na[$i] or defined $nb[$i]; $i++) { + # def vs. undef + return +1 if defined $na[$i] and !defined $nb[$i]; + return -1 if defined $nb[$i] and !defined $na[$i]; + + # num vs. num + if ($na[$i] =~ /^\d/ and $nb[$i] =~ /^\d/) { + $retval = ($na[$i] <=> $nb[$i]); + return $retval if $retval; + next; + } + + # char vs. char + if ($na[$i] =~ /^\D/ and $nb[$i] =~ /^\D/) { + $retval = ($na[$i] cmp $nb[$i]); + return $retval if $retval; + next; + } + + # num vs. char + $retval = ($na[$i] =~ /\d/ and -1 or +1); + return $retval; + } + + # + # compare suffix second + # + if (defined $sa and !defined $sb) { + return +2 if $sa eq "p"; + return -2; + } + if (defined $sb and !defined $sa) { + return -3 if $sb eq "p"; + return +3; + } + + if (defined $sa) { # and defined $sb + $retval = ($sa cmp $sb); + if ($retval) { + return +4 if $sa eq "p"; + return -4 if $sb eq "p"; + return $retval; # suffixes happen to be alphabetical order, mostly + } + + # compare suffix number + return +5 if defined $sna and !defined $snb; + return -5 if defined $snb and !defined $sna; + + if (defined $sna) { # and defined $snb + $retval = ($sna <=> $snb); + return $retval if $retval; + } + } + + # + # compare rev third + # + return +6 if defined $ra and !defined $rb; + return -6 if defined $rb and !defined $ra; + + if (defined $ra) { # and defined $rb + return ($ra <=> $rb); + } + + # + # nothing left to compare + # + return 0; } + @files = sort sortfunc @files; +# Just to ensure we don't get duplicate entries. +sub mypush(\@@) { + my $aref = shift; + + foreach my $value (@_) { + push(@{$aref}, $value) if !grep(/^$value$/, @{$aref}); + } +} + # Forget ebuilds that only have changed copyrights, unless that's all # the changed files we have @@ -277,62 +342,81 @@ sub sortfunc($$) { @files = grep !/\.ebuild$/, @files; if (@ebuilds) { - if ($vcs eq "git") { - open C, $vcs{$vcs}{diff}." HEAD -- @ebuilds 2>&1 |" or die "Can't run: ".$vcs{$vcs}{diff}."$!\n"; - } else { - open C, $vcs{$vcs}{diff}." @ebuilds 2>&1 |" or die "Can't run: ".$vcs{$vcs}{diff}."$!\n"; - } - $_ = <C>; - while (defined $_) { - # only possible with cvs - if (/^$vcs diff: (([^\/]*?)\.ebuild) was removed/) { - push @files, $1; + if ($vcs eq "git") { + open C, $vcs{$vcs}{diff}." HEAD -- @ebuilds 2>&1 |" or die "Can't run: ".$vcs{$vcs}{diff}."$!\n"; + } else { + open C, $vcs{$vcs}{diff}." @ebuilds 2>&1 |" or die "Can't run: ".$vcs{$vcs}{diff}."$!\n"; } - # We assume GNU diff output format here. - # git format: diff --git a/app-doc/repodoc/metadata.xml b/app-doc/repodoc/metadata.xml - elsif (/$vcs{$vcs}{regex}/) { - my $f; - if ($vcs eq "git") { - ($f) = ($1); - my $version = ($2); - while (<C>) { - last if /^deleted file mode|^index/; - if (/^new file mode/) { - push @new_versions, $version; # new ebuild, will create a new entry - last; - } - } - } else { - ($f) = ($2); - } + $_ = <C>; - # check if more than just copyright date changed. - # skip some lines (vcs dependent) - foreach(1..$vcs{$vcs}{skip}){ + while (defined $_) { + # only possible with cvs + if (/^$vcs diff: (([^\/]*?)\.ebuild) was removed/) { + mypush(@files, $1); + } + # We assume GNU diff output format here. + # git format: diff --git a/app-doc/repodoc/metadata.xml b/app-doc/repodoc/metadata.xml + elsif (/$vcs{$vcs}{regex}/) { + my $f = $1; + + if ($vcs eq "git") { + my $version = $2; + + while (<C>) { + last if /^deleted file mode|^index/; + if (/^new file mode/) { + mypush(@files, $f); + mypush(@new_versions, $version); + last; + } + } + } + + # check if more than just copyright date changed. + # skip some lines (vcs dependent) + foreach(1..$vcs{$vcs}{skip}) { $_ = <C>; - } - while (<C>) { - last if /^[A-Za-z]/; - if (/^[-+](?!# Copyright)/) { - push @files, $f; - last; - } - } - # at this point we've either added $f to @files or not, - # and we have the next line in $_ for processing - next; - } - elsif (/^$vcs.*?: (([^\/]*?)\.ebuild) is a new entry/) { - push @files, $1; - push @new_versions, $2; # new ebuild, will create a new entry - } - # other cvs output is ignored - $_ = <C>; - } + } + + while (<C>) { + last if /^[A-Za-z]/; + if (/^[-+](?!# Copyright)/) { + mypush(@files, $f); + last; + } + } + + # at this point we've either added $f to @files or not, + # and we have the next line in $_ for processing + next; + } + elsif (/^$vcs.*?: (([^\/]*?)\.ebuild) is a new entry/) { + mypush(@files, $1); + mypush(@new_versions, $2); + } + + # other cvs output is ignored + $_ = <C>; + } } close C; +# Subversion diff doesn't identify new versions. So use the status command +if (($vcs eq "svn") and (@ebuilds)) { + open C, $vcs{$vcs}{status}." @ebuilds 2>&1 |" or die "Can't run: ".$vcs{$vcs}{status}."$!\n"; + $_ = <C>; + + while (defined $_) { + if (/^A\s+\+?\s*(([^\s]*)\.ebuild)/) { + mypush(@files, $1); + mypush(@new_versions, $2); + } + + $_ = <C>; + } +} + # When a package move occurs, the versions appear to be new even though they are # not. Trim them from @new_versions in that case. @new_versions = grep { $text !~ /^\*\Q$_\E\s/m } @new_versions; @@ -343,48 +427,62 @@ close C; # Allow ChangeLog entries with no changed files, but give a fat warning unless (@files) { - print STDERR "**\n"; - print STDERR "** NOTE: No non-trivial changed files found. Normally echangelog\n"; - print STDERR "** should be run after all affected files have been added and/or\n"; - print STDERR "** modified. Did you forget to $vcs add?\n"; - print STDERR "**\n"; - @files = sort sortfunc @trivial; - @files = qw/ChangeLog/ unless @files; # last resort to put something in the list + print STDERR "**\n"; + print STDERR "** NOTE: No non-trivial changed files found. Normally echangelog\n"; + print STDERR "** should be run after all affected files have been added and/or\n"; + print STDERR "** modified. Did you forget to $vcs add?\n"; + print STDERR "**\n"; + + if ($opt_strict) { + print STDERR "** In strict mode, exiting\n"; + exit 1; + } + + @files = sort sortfunc @trivial; + @files = qw/ChangeLog/ unless @files; # last resort to put something in the list } +# sort +@files = sort sortfunc @files; +@new_versions = sort sortfunc @new_versions; + # Get the input from the cmdline, editor or stdin if ($ARGV[0]) { - $input = "@ARGV"; + $input = "@ARGV"; } else { - # Testing for defined() allows ECHANGELOG_EDITOR='' to cancel EDITOR - $editor = defined($ENV{'ECHANGELOG_EDITOR'}) ? $ENV{'ECHANGELOG_EDITOR'} : - $ENV{'EDITOR'} || undef; - if ($editor) { - system("$editor ChangeLog.new"); - if ($? != 0) { - # This usually happens when the editor got forcefully killed; and - # the terminal is probably messed up: so we reset things. - system('/usr/bin/stty sane'); - print STDERR "Editor died! Reverting to stdin method.\n"; - undef $editor; - } else { - if (open I, "<ChangeLog.new") { - local $/ = undef; - $input = <I>; - close I; - } else { - print STDERR "Error opening ChangeLog.new: $!\n"; - print STDERR "Reverting to stdin method.\n"; - undef $editor; - } - unlink 'ChangeLog.new'; - } - } - unless ($editor) { - print "Please type the log entry: use Ctrl-d to finish, Ctrl-c to abort...\n"; - local $/ = undef; - $input = <>; - } + # Testing for defined() allows ECHANGELOG_EDITOR='' to cancel EDITOR + $editor = defined($ENV{'ECHANGELOG_EDITOR'}) ? $ENV{'ECHANGELOG_EDITOR'} : + $ENV{'EDITOR'} || undef; + + if ($editor) { + system("$editor ChangeLog.new"); + + if ($? != 0) { + # This usually happens when the editor got forcefully killed; and + # the terminal is probably messed up: so we reset things. + system('/usr/bin/stty sane'); + print STDERR "Editor died! Reverting to stdin method.\n"; + undef $editor; + } else { + if (open I, "<ChangeLog.new") { + local $/ = undef; + $input = <I>; + close I; + } else { + print STDERR "Error opening ChangeLog.new: $!\n"; + print STDERR "Reverting to stdin method.\n"; + undef $editor; + } + + unlink 'ChangeLog.new'; + } + } + + unless ($editor) { + print "Please type the log entry: use Ctrl-d to finish, Ctrl-c to abort...\n"; + local $/ = undef; + $input = <>; + } } die "Empty entry; aborting\n" unless $input =~ /\S/; @@ -395,18 +493,20 @@ $input = Text::Wrap::fill(' ', ' ', $input); # Prepend the user info to the input unless ($user = $ENV{'ECHANGELOG_USER'}) { - my ($fullname, $username) = (getpwuid($<))[6,0]; - $fullname =~ s/,.*//; # remove GECOS, bug 80011 - $user = sprintf "%s <%s\@gentoo.org>", $fullname, $username; + my ($fullname, $username) = (getpwuid($<))[6,0]; + $fullname =~ s/,.*//; # remove GECOS, bug 80011 + $user = sprintf "%s <%s\@gentoo.org>", $fullname, $username; } + # Make sure that we didn't get "root" die "Please set ECHANGELOG_USER or run as non-root\n" if $user =~ /<root@/; + $date = strftime("%d %b %Y", gmtime); $entry = "$date; $user "; $entry .= join ', ', map "$actions{$_}$_", @files; $entry .= ':'; -$entry = Text::Wrap::fill(' ', ' ', $entry); # does not append a \n -$entry .= "\n$input"; # append user input +$entry = Text::Wrap::fill(' ', ' ', $entry); # does not append a \n +$entry .= "\n$input"; # append user input # Each one of these regular expressions will eat the whitespace # leading up to the next entry (except the two-space leader on the @@ -414,28 +514,49 @@ $entry .= "\n$input"; # append user input # double carriage-return. This helps to normalize the spacing in # the ChangeLogs. if (@new_versions) { - # Insert at the top with a new version marker - $text =~ s/^( .*? ) # grab header - \s*\n(?=\ \ \d|\*|\z) # suck up trailing whitespace - /"$1\n\n" . - join("\n", map "*$_ ($date)", reverse @new_versions) . - "\n\n$entry\n\n"/sxe - or die "Failed to insert new entry (4)\n"; + # Insert at the top with a new version marker + $text =~ s/^( .*? ) # grab header + \s*\n(?=\ \ \d|\*|\z) # suck up trailing whitespace + /"$1\n\n" . + join("\n", map "*$_ ($date)", reverse @new_versions) . + "\n\n$entry\n\n"/sxe + or die "Failed to insert new entry (4)\n"; } else { - # Changing an existing patch or ebuild, no new version marker - # required - $text =~ s/^( .*? ) # grab header - \s*\n(?=\ \ \d|\*|\z) # suck up trailing whitespace - /$1\n\n$entry\n\n/sx - or die "Failed to insert new entry (3)\n"; + # Changing an existing patch or ebuild, no new version marker + # required + $text =~ s/^( .*? ) # grab header + \s*\n(?=\ \ \d|\*|\z) # suck up trailing whitespace + /$1\n\n$entry\n\n/sx + or die "Failed to insert new entry (3)\n"; +} + +sub update_cat_pn { + my ($t) = @_; + my ($cwd) = getcwd(); + + $cwd =~ m|.*/(\w+-\w+\|virtual)/([^/]+)| + or die "Can't figure out category/package.. sorry!\n"; + my ($category, $package_name) = ($1, $2); + $t =~ s/^(# ChangeLog for).*/$1 $category\/$package_name/; + + return $t; +} + +# New packages and/or ones that have moved around often have stale data here. +# But only do that in places where ebuilds are around (as echangelog can be +# used in profiles/ and such places). +if (grep(/\.ebuild$/, @files)) { + $text = update_cat_pn($text); } sub update_copyright { - my ($t) = @_; - (my $year = $date) =~ s/.* //; - $t =~ s/^# Copyright \d+(?= )/$&-$year/m or - $t =~ s/^(# Copyright \d+)-(\d+)/$1-$year/m; - return $t; + my ($t) = @_; + (my $year = $date) =~ s/.* //; + + $t =~ s/^# Copyright \d+(?= )/$&-$year/m or + $t =~ s/^(# Copyright) \d+-(\d+)/$1 1999-$year/m; + + return $t; } # Update the copyright year in the ChangeLog @@ -450,25 +571,26 @@ close O or die "Can't close ChangeLog.new: $!\n"; # copyright lines on ebuilds that haven't changed. I verified this with an IP # lawyer. for my $e (grep /\.ebuild$/, @files) { - if (-s $e) { - my ($etext, $netext); - open E, "<$e" or warn("Can't read $e to update copyright year\n"), next; - { local $/ = undef; $etext = <E>; } - close E; - - # Attempt the substitution and compare - $netext = update_copyright($etext); - next if $netext eq $etext; # skip this file if no change. - - # Write the new ebuild - open E, ">$e.new" or warn("Can't open $e.new\n"), next; - print E $netext and - close E or warn("Can't write $e.new\n"), next; - - # Move things around and show the diff - system "diff -U 0 $e $e.new"; - rename "$e.new", $e or warn("Can't rename $e.new: $!\n"); - } + if (-s $e) { + my ($etext, $netext); + + open E, "<$e" or warn("Can't read $e to update copyright year\n"), next; + { local $/ = undef; $etext = <E>; } + close E; + + # Attempt the substitution and compare + $netext = update_copyright($etext); + next if $netext eq $etext; # skip this file if no change. + + # Write the new ebuild + open E, ">$e.new" or warn("Can't open $e.new\n"), next; + print E $netext and + close E or warn("Can't write $e.new\n"), next; + + # Move things around and show the diff + system "diff -U 0 $e $e.new"; + rename "$e.new", $e or warn("Can't rename $e.new: $!\n"); + } } # Move things around and show the ChangeLog diff @@ -476,18 +598,18 @@ system 'diff -Nu ChangeLog ChangeLog.new'; rename 'ChangeLog.new', 'ChangeLog' or die "Can't rename ChangeLog.new: $!\n"; # Okay, now we have a starter ChangeLog to work with. -# The text will be added just like with any other ChangeLog below. +# The text will be added just like with any other ChangeLog below. # Add the new ChangeLog to vcs before continuing. if ($vcs eq "cvs") { - if (open F, "CVS/Entries") { - system("cvs -f add ChangeLog") unless (scalar grep /^\/ChangeLog\//, <F>); - } + if (open F, "CVS/Entries") { + system("cvs -f add ChangeLog") unless (scalar grep /^\/ChangeLog\//, <F>); + } } elsif ($vcs eq "svn") { - if (open F, ".svn/entries") { - system("svn add ChangeLog") unless (scalar grep /ChangeLog/, <F>); - } + if (open F, ".svn/entries") { + system("svn add ChangeLog") unless (scalar grep /ChangeLog/, <F>); + } } else { - system("$vcs{$vcs}{add} ChangeLog 2>&1 >> /dev/null"); + system("$vcs{$vcs}{add} ChangeLog 2>&1 >> /dev/null"); } -# vim:sw=4 ts=8 expandtab +# vim: set ts=4 sw=4 tw=0: diff --git a/src/echangelog/echangelog.1 b/src/echangelog/echangelog.1 index f83eaf7..1575644 100644 --- a/src/echangelog/echangelog.1 +++ b/src/echangelog/echangelog.1 @@ -1,4 +1,4 @@ -.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.13 +.\" Automatically generated by Pod::Man 2.16 (Pod::Simple 3.07) .\" .\" Standard preamble: .\" ======================================================================== @@ -25,11 +25,11 @@ .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left -.\" double quote, and \*(R" will give a right double quote. | will give a -.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to -.\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C' -.\" expand to `' in nroff, nothing in troff, for use with C<>. -.tr \(*W-|\(bv\*(Tr +.\" double quote, and \*(R" will give a right double quote. \*(C+ will +.\" give a nicer C++. Capital omega is used to do unbreakable dashes and +.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, +.\" nothing in troff, for use with C<>. +.tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- @@ -48,22 +48,25 @@ . ds R" '' 'br\} .\" +.\" Escape single quotes in literal strings from groff's Unicode transform. +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" .\" If the F register is turned on, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. -.if \nF \{\ +.ie \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . nr % 0 . rr F .\} -.\" -.\" For nroff, turn off justification. Always turn off hyphenation; it makes -.\" way too many mistakes in technical documents. -.hy 0 -.if n .na +.el \{\ +. de IX +.. +.\} .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. @@ -128,8 +131,12 @@ .rm #[ #] #H #V #F C .\" ======================================================================== .\" -.IX Title "ECHANGELOG 1" -.TH ECHANGELOG 1 "2004-04-02" "perl v5.8.2" "User Contributed Perl Documentation" +.IX Title "echangelog 1" +.TH echangelog 1 "2009-04-28" "perl v5.10.0" "Gentoolkit" +.\" For nroff, turn off justification. Always turn off hyphenation; it makes +.\" way too many mistakes in technical documents. +.if n .ad l +.nh .SH "NAME" echangelog \- Gentoo: update portage ChangeLogs .SH "SYNOPSIS" @@ -141,7 +148,7 @@ This tool provides an easy way to create or update portage ChangeLogs in Gentoo. The tool scans the current directory, which is assumed to be a package directory such as /usr/portage/app\-editors/vim, finds what files have been changed or added, and inserts the appropriate -entry to ChangeLog. If \fItext\fR is not provided on the command\-line, +entry to ChangeLog. If \fItext\fR is not provided on the command-line, echangelog prompts for it. .PP All modifications should occur before running echangelog so that it @@ -152,7 +159,7 @@ echangelog won't know those files are part of the update. If your text would cause the ChangeLog entry to exceed 80 columns, it will be rewrapped to keep the ChangeLog neat. If you need special formatting in the ChangeLog, then you can either (1) run echangelog -with no text on the command\-line, and make sure that your text won't +with no text on the command-line, and make sure that your text won't be too wide, (2) edit the ChangeLog manually. If you prefer (2), I'd recommend something like \*(L"echangelog blah\*(R" so that the header lines are computed correctly, then edit and change \*(L"blah\*(R" to your preferred @@ -173,22 +180,20 @@ To create a ChangeLog for a completely new package. The header is parsed from skel.ebuild. .PP .Vb 2 -\& $ cvs add metalog-0.1.ebuild -\& cvs server: use 'cvs commit' to add this file permanently -.Ve -.PP -.Vb 13 -\& $ echangelog 'New ebuild, thanks to Harvey McGillicuddy' -\& --- ChangeLog 1969-12-31 19:00:00.000000000 -0500 -\& +++ ChangeLog.new 2003-02-23 14:04:06.000000000 -0500 -\& @@ -0,0 +1,9 @@ -\& +# ChangeLog for app-admin/metalog -\& +# Copyright 2000-2003 Gentoo Technologies, Inc.; Distributed under the GPL v2 +\& $ cvs add metalog\-0.1.ebuild +\& cvs server: use \*(Aqcvs commit\*(Aq to add this file permanently +\& +\& $ echangelog \*(AqNew ebuild, thanks to Harvey McGillicuddy\*(Aq +\& \-\-\- ChangeLog 1969\-12\-31 19:00:00.000000000 \-0500 +\& +++ ChangeLog.new 2003\-02\-23 14:04:06.000000000 \-0500 +\& @@ \-0,0 +1,9 @@ +\& +# ChangeLog for app\-admin/metalog +\& +# Copyright 2000\-2003 Gentoo Technologies, Inc.; Distributed under the GPL v2 \& +# $Header$ \& + -\& +*metalog-0.1 (23 Feb 2003) +\& +*metalog\-0.1 (23 Feb 2003) \& + -\& + 23 Feb 2003; Aron Griffis <agriffis@gentoo.org> metalog-0.1.ebuild : +\& + 23 Feb 2003; Aron Griffis <agriffis@gentoo.org> metalog\-0.1.ebuild : \& + New ebuild, thanks to Harvey McGillicuddy \& + .Ve @@ -197,60 +202,50 @@ To bump a revision. Note you need to \*(L"cvs add\*(R" so that echangelog will notice the new file. .PP .Vb 2 -\& $ cvs add metalog-0.1-r1.ebuild -\& cvs server: use 'cvs commit' to add this file permanently -.Ve -.PP -.Vb 6 -\& $ echangelog 'Bump revision to fix bug #999' -\& --- ChangeLog 2003-02-23 14:04:06.000000000 -0500 -\& +++ ChangeLog.new 2003-02-23 14:07:48.000000000 -0500 -\& @@ -2,6 +2,11 @@ -\& # Copyright 2000-2003 Gentoo Technologies, Inc.; Distributed under the GPL v2 +\& $ cvs add metalog\-0.1\-r1.ebuild +\& cvs server: use \*(Aqcvs commit\*(Aq to add this file permanently +\& +\& $ echangelog \*(AqBump revision to fix bug #999\*(Aq +\& \-\-\- ChangeLog 2003\-02\-23 14:04:06.000000000 \-0500 +\& +++ ChangeLog.new 2003\-02\-23 14:07:48.000000000 \-0500 +\& @@ \-2,6 +2,11 @@ +\& # Copyright 2000\-2003 Gentoo Technologies, Inc.; Distributed under the GPL v2 \& # $Header$ -.Ve -.PP -.Vb 6 -\& +*metalog-0.1-r1 (23 Feb 2003) +\& +\& +*metalog\-0.1\-r1 (23 Feb 2003) \& + -\& + 23 Feb 2003; Aron Griffis <agriffis@gentoo.org> metalog-0.1-r1.ebuild : +\& + 23 Feb 2003; Aron Griffis <agriffis@gentoo.org> metalog\-0.1\-r1.ebuild : \& + Bump revision to fix bug #999 \& + -\& *metalog-0.1 (23 Feb 2003) -.Ve -.PP -.Vb 1 -\& 23 Feb 2003; Aron Griffis <agriffis@gentoo.org> metalog-0.1.ebuild : +\& *metalog\-0.1 (23 Feb 2003) +\& +\& 23 Feb 2003; Aron Griffis <agriffis@gentoo.org> metalog\-0.1.ebuild : .Ve .PP For a multi-line entry, omit the command-line arg. .PP .Vb 10 \& $ echangelog -\& Please type the log entry, finish with ctrl-d +\& Please type the log entry, finish with ctrl\-d \& Bump revision to fix bug #999. Necessary to bump the revision because -\& the problem appears at run-time, not compile-time. This should also +\& the problem appears at run\-time, not compile\-time. This should also \& give users the updated default configuration file. -\& --- ChangeLog 2003-02-23 14:09:12.000000000 -0500 -\& +++ ChangeLog.new 2003-02-23 14:12:43.000000000 -0500 -\& @@ -2,6 +2,13 @@ -\& # Copyright 2000-2003 Gentoo Technologies, Inc.; Distributed under the GPL v2 +\& \-\-\- ChangeLog 2003\-02\-23 14:09:12.000000000 \-0500 +\& +++ ChangeLog.new 2003\-02\-23 14:12:43.000000000 \-0500 +\& @@ \-2,6 +2,13 @@ +\& # Copyright 2000\-2003 Gentoo Technologies, Inc.; Distributed under the GPL v2 \& # $Header$ -.Ve -.PP -.Vb 8 -\& +*metalog-0.1-r1 (23 Feb 2003) +\& +\& +*metalog\-0.1\-r1 (23 Feb 2003) \& + -\& + 23 Feb 2003; Aron Griffis <agriffis@gentoo.org> metalog-0.1-r1.ebuild : +\& + 23 Feb 2003; Aron Griffis <agriffis@gentoo.org> metalog\-0.1\-r1.ebuild : \& + Bump revision to fix bug #999. Necessary to bump the revision because -\& + the problem appears at run-time, not compile-time. This should also +\& + the problem appears at run\-time, not compile\-time. This should also \& + give users the updated default configuration file. \& + -\& *metalog-0.1 (23 Feb 2003) -.Ve -.PP -.Vb 1 -\& 23 Feb 2003; Aron Griffis <agriffis@gentoo.org> metalog-0.1.ebuild : +\& *metalog\-0.1 (23 Feb 2003) +\& +\& 23 Feb 2003; Aron Griffis <agriffis@gentoo.org> metalog\-0.1.ebuild : .Ve .SH "ENVIRONMENT VARIABLES" .IX Header "ENVIRONMENT VARIABLES" diff --git a/src/echangelog/test/TEST.pm b/src/echangelog/test/TEST.pm new file mode 100644 index 0000000..6632148 --- /dev/null +++ b/src/echangelog/test/TEST.pm @@ -0,0 +1,26 @@ +# We just return a static/predefined date because we're working with +# static md5 checksums. + +package TEST; + +use strict; +use warnings; + +BEGIN { + use Exporter(); + our ($VERSION, @ISA, @EXPORT, @EXPORT_OK, %EXPORT_TAGS); + + $VERSION = 1.00; + + @ISA = qw(Exporter); + @EXPORT = qw(&strftime); + %EXPORT_TAGS = ( ); + @EXPORT_OK = qw(); +} +our @EXPORT_OK; + +sub strftime { + return "01 Jan 2009"; +} + +1; diff --git a/src/echangelog/test/templates/test.patch b/src/echangelog/test/templates/test.patch new file mode 100644 index 0000000..72d46fa --- /dev/null +++ b/src/echangelog/test/templates/test.patch @@ -0,0 +1,6 @@ +--- test.patch 2009-04-28 14:13:26.171225175 +0200 ++++ test.patch 2009-04-28 14:12:26.246497830 +0200 +@@ -0,0 +1,3 @@ ++This is just an example. ++Its used for several echangelog tests. ++ diff --git a/src/echangelog/test/templates/vcstest-0.0.1.ebuild b/src/echangelog/test/templates/vcstest-0.0.1.ebuild new file mode 100644 index 0000000..2824b83 --- /dev/null +++ b/src/echangelog/test/templates/vcstest-0.0.1.ebuild @@ -0,0 +1,16 @@ +# Copyright 1999-2009 Gentoo Foundation +# Distributed under the terms of the GNU General Public License v2 +# $Header: $ + +DESCRIPTION="echangelog test ebuild" +HOMEPAGE="" +SRC_URI="" + +LICENSE="" +SLOT="0" +KEYWORDS="" +IUSE="" + +DEPEND="" +RDEPEND="" + diff --git a/src/echangelog/test/test.sh b/src/echangelog/test/test.sh new file mode 100755 index 0000000..374522f --- /dev/null +++ b/src/echangelog/test/test.sh @@ -0,0 +1,192 @@ +#!/bin/sh + +source /etc/init.d/functions.sh + +VCSTEST="echangelog-test/vcstest" +_ROOT=$(pwd) + +export ECHANGELOG_USER="Just a test <echangelogtest@gentoo.org>" + +#MD5_INIT="34d54bc2ab1a2154b0c7bd5cdd7f6119" +MD5_INIT="34d54bc2ab1a2154b0c7bd5cdd7f6119" +#MD5_PATCH="d910ab6b76cfb48b68e11ae1f06612bb" +MD5_PATCH="db1ab89bb7374824d0f198078f79a83f" +#MD5_REVBUMP="8e36650a644ba49cc13bcbe93fdb2d2d" +MD5_REVBUMP="31ddfa60d2ae4dd1fccd7e3d2bd2c06c" +#MD5_COPYRIGHT="55a6097d8e3913a9feb0dff250649c00" +MD5_COPYRIGHT="6f39fa409ea14bb6506347c53f6dee50" +#MD5_OBSOLETE="6c30d84f603f5f0e4b09a88d9cfdaaa8" +MD5_OBSOLETE="0aedadf159c6f3add97a3f79fb867221" +#MD5_FINAL="cdd58fea5cfcef5820013d82ccbe0e89" +MD5_FINAL="17eb0df69f501cc6fdaffebd118b7764" + +function md5() { + local fname=$1 + echo $(md5sum ${fname} | awk '{ print $1 }') +} + +function ech() { + local bin=$1 + local msg=$2 + + perl -I$(dirname $(dirname ${bin})) ${bin} "${msg}" +} + +function make_test() { + local root=$1 + local vcs=$2 + + local echangelog="${root}/tmp/echangelog" + local tmp="${root}/tmp/${vcs}" + local template="${root}/templates" + + cd $root + mkdir -p ${tmp} + cd ${tmp} + + [[ "${vcs}" == "cvs" ]] && mkdir -p ${tmp}/cvsroot + [[ "${vcs}" == "svn" ]] && mkdir -p ${tmp}/svnroot + + if [[ "${vcs}" == "git" ]]; + then + git init + touch .gitignore + git add .gitignore + git commit -a -m 'Initial Commit' + elif [[ "${vcs}" == "svn" ]]; + then + svnadmin create svnroot + svn co file://${tmp}/svnroot svn + cd svn + elif [[ "${vcs}" == "cvs" ]]; + then + CVSROOT="${tmp}/cvsroot" cvs init + mkdir cvsroot/cvs + cvs -d:local:${tmp}/cvsroot co cvs + cd cvs + fi + + mkdir -p ${VCSTEST} + + cp ${template}/vcstest-0.0.1.ebuild ${VCSTEST} + ${vcs} add $(dirname ${VCSTEST}) + if [[ "${vcs}" == "cvs" ]]; + then + ${vcs} add ${VCSTEST} + ${vcs} add "${VCSTEST}/vcstest-0.0.1.ebuild" + fi + + cd ${VCSTEST} + ech ${echangelog} 'New ebuild for bug <id>.' + + if [[ "${MD5_INIT}" != "$(md5 ChangeLog)" ]]; + then + eerror "WRONG MD5_INIT!" + fi + + mkdir files + cp ${template}/test.patch files + if [[ "${vcs}" == "cvs" ]]; + then + ${vcs} add files/ + ${vcs} add files/test.patch + else + ${vcs} add files + fi + + ech ${echangelog} "Added adittional patch to fix foo." + + if [[ "${MD5_PATCH}" != "$(md5 ChangeLog)" ]]; + then + eerror "WRONG MD5_PATCH!" + fi + + if [[ "${vcs}" == "svn" ]]; + then + ${vcs} commit -m 'New ebuild for bug <id>.' ../ + else + ${vcs} commit -m 'New ebuild for bug <id>.' + fi + + [[ "${vcs}" == "cvs" ]] && sed -i -e 's:# $Header\: .*$:# $Header\: $:' ChangeLog + + cp vcstest-0.0.1.ebuild vcstest-0.0.1-r1.ebuild + ${vcs} add vcstest-0.0.1-r1.ebuild + + ech ${echangelog} "Revbump..." + + if [[ "${MD5_REVBUMP}" != "$(md5 ChangeLog)" ]]; + then + eerror "WRONG MD5_REVBUMP!" + fi + + sed -i -e 's:# Copyright 1999-2009 Gentoo Foundation:# Copyright 1999-2010 Gentoo Foundation:' vcstest-0.0.1.ebuild + ech ${echangelog} "Revbump...; Just copyright changed." + + if [[ "${MD5_COPYRIGHT}" != "$(md5 ChangeLog)" ]]; + then + eerror "WRONG MD5_COPYRIGHT!" + fi + + if [[ "${vcs}" == "cvs" ]]; + then + rm -f files/test.patch + ${vcs} remove files/test.patch + else + ${vcs} rm files/test.patch + fi + + ech ${echangelog} "Revbump...; Just copyright changed; Removed obsolete patch." + + if [[ "${MD5_OBSOLETE}" != "$(md5 ChangeLog)" ]]; + then + eerror "WRONG MD5_OBSOLETE!" + fi + + echo>>vcstest-0.0.1.ebuild + ech ${echangelog} "Revbump...; Just copyright changed; Removed obsolete patch; Modified more then just the copyright." + + if [[ "${MD5_FINAL}" != "$(md5 ChangeLog)" ]]; + then + eerror "WRONG MD5_FINAL!" + fi +} + +[[ -d "${_ROOT}/tmp" ]] && rm -rf ${_ROOT}/tmp +mkdir -p ${_ROOT}/tmp + +ebegin "Preparing echangelog" + +if [[ -e ../echangelog ]]; +then + cp ../echangelog "${_ROOT}/tmp" || set $? + sed -i -e 's:use POSIX qw.*:use POSIX qw(setlocale getcwd);\nuse TEST qw(strftime);:' "${_ROOT}/tmp/echangelog" || set $? + eend ${1:-0} || exit ${1} +else + eerror "error" + eend ${1:-1} + exit 1 +fi + +if [[ -x $(which git) ]]; +then + ebegin "Starting test with git" + make_test $_ROOT "git" || set $? + eend ${1:-0} +fi + +if [[ -x $(which cvs) ]]; +then + ebegin "Starting test with cvs" + make_test $_ROOT "cvs" || set $? + eend ${1:-0} +fi + +if [[ -x $(which svn) ]]; +then + ebegin "Starting test with svn" + make_test $_ROOT "svn" || set $? + eend ${1:-0} +fi + +rm -rf "${_ROOT}/tmp" |