X-Git-Url: http://erislabs.net/gitweb/?a=blobdiff_plain;f=build-aux%2Fupdate-copyright;h=28ff44180e75e8a305c4edee0bf1d9e7755d2370;hb=6147723cd9000c4e840205fec3e64b0a5a5c1d04;hp=dd0d758ec0b32306ca970d1ffab68f1a30de8db9;hpb=9faeba562c0527b5cf1fca4f79ba657553c2a31b;p=gnulib.git diff --git a/build-aux/update-copyright b/build-aux/update-copyright index dd0d758ec..28ff44180 100755 --- a/build-aux/update-copyright +++ b/build-aux/update-copyright @@ -1,11 +1,13 @@ -#!/usr/bin/perl -0777 -pi +eval '(exit $?0)' && eval 'exec perl -wS -0777 -pi "$0" ${1+"$@"}' + & eval 'exec perl -wS -0777 -pi "$0" $argv:q' + if 0; # Update an FSF copyright year list to include the current year. -my $VERSION = '2009-08-05.20:47'; # UTC +my $VERSION = '2009-12-28.11:09'; # UTC -# Copyright (C) 2009 Free Software Foundation, Inc. +# Copyright (C) 2009-2010 Free Software Foundation, Inc. # -# This program is free software; you can redistribute it and/or modify +# This program is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation; either version 3, or (at your option) # any later version. @@ -21,25 +23,21 @@ my $VERSION = '2009-08-05.20:47'; # UTC # Written by Jim Meyering and Joel E. Denny # The arguments to this script should be names of files that contain FSF -# copyright statements to be updated. For example, you may wish to -# place a target like the following in the top-level makefile in your -# project: -# -# .PHONY: update-copyright -# update-copyright: -# if test -d .git; then \ -# git grep -l -w Copyright \ -# | grep -v -E '(^|/)(COPYING|ChangeLog)' \ -# | xargs $(srcdir)/build-aux/$@; \ -# fi -# -# In the second grep, you can build a list of files to skip within your -# project. -# -# Iff an FSF copyright statement is discovered in a file and the final -# year is not the current year, the statement is updated for the new -# year and reformatted to fit within 72 columns. A warning is printed -# for every file for which no FSF copyright statement is discovered. +# copyright statements to be updated. For example, you might wish to +# use the update-copyright target rule in maint.mk from gnulib's +# maintainer-makefile module. +# +# Iff an FSF copyright statement is recognized in a file and the final +# year is not the current year, then the statement is updated for the +# new year and it is reformatted to: +# +# 1. Fit within 72 columns. +# 2. Convert 2-digit years to 4-digit years by prepending "19". +# 3. Expand copyright year intervals. (See "Environment variables" +# below.) +# +# A warning is printed for every file for which no FSF copyright +# statement is recognized. # # Each file's FSF copyright statement must be formated correctly in # order to be recognized. For example, each of these is fine: @@ -58,8 +56,8 @@ my $VERSION = '2009-08-05.20:47'; # UTC # However, the following format is not recognized because the line # prefix changes after the first line: # -# /* Copyright (C) 1990-2005, 2007-2009 Free Software -# * Foundation, Inc. */ +# ## Copyright (C) 1990-2005, 2007-2009 Free Software +# # Foundation, Inc. # # The following copyright statement is not recognized because the # copyright holder is not the FSF: @@ -72,31 +70,64 @@ my $VERSION = '2009-08-05.20:47'; # UTC # The exact conditions that a file's FSF copyright statement must meet # to be recognized are: # -# 1. The format is "Copyright (C)" (where "(C)" can also be "(c)", -# "@copyright{}", or "©"), then a list of copyright years, and -# then the name of the copyright holder, which is "Free Software -# Foundation, Inc.". -# 2. The "Copyright (C)" appears at the beginning of a line except -# that it may be prefixed by any sequence (e.g., a comment) of no -# more than 5 characters. -# 3. Iff such a prefix is present, the same prefix appears at the +# 1. It is the first FSF copyright statement that meets all of the +# following conditions. Subsequent FSF copyright statements are +# ignored. +# 2. Its format is "Copyright (C)", then a list of copyright years, +# and then the name of the copyright holder, which is "Free +# Software Foundation, Inc.". +# 3. The "(C)" takes one of the following forms or is omitted +# entirely: +# +# A. (C) +# B. (c) +# C. @copyright{} +# D. © +# +# 4. The "Copyright" appears at the beginning of a line except that it +# may be prefixed by any sequence (e.g., a comment) of no more than +# 5 characters. +# 5. Iff such a prefix is present, the same prefix appears at the # beginning of each remaining line within the FSF copyright -# statement. -# 4. Blank lines, even if preceded by the prefix, do not appear +# statement. There is one exception in order to support C-style +# comments: if the first line's prefix contains nothing but +# whitespace surrounding a "/*", then the prefix for all subsequent +# lines is the same as the first line's prefix except with each of +# "/" and possibly "*" replaced by a " ". The replacement of "*" +# by " " is consistent throughout all subsequent lines. +# 6. Blank lines, even if preceded by the prefix, do not appear # within the FSF copyright statement. -# 5. Each copyright year is 2 or 4 digits, and years are separated by -# commas or dashes. Whitespace may occur after commas. -# 6. It is the first FSF copyright statement that meets all of the -# above conditions. Subsequent FSF copyright statements are -# ignored. +# 7. Each copyright year is 2 or 4 digits, and years are separated by +# commas or dashes. Whitespace may appear after commas. +# +# Environment variables: +# +# 1. If UPDATE_COPYRIGHT_FORCE=1, a recognized FSF copyright statement +# is reformatted even if it does not need updating for the new +# year. If unset or set to 0, only updated FSF copyright +# statements are reformatted. +# 2. If UPDATE_COPYRIGHT_USE_INTERVALS=1, every series of consecutive +# copyright years (such as 90, 1991, 1992-2007, 2008) in a +# reformatted FSF copyright statement is collapsed to a single +# interval (such as 1990-2008). If unset or set to 0, all existing +# copyright year intervals in a reformatted FSF copyright statement +# are expanded instead. +# 3. For testing purposes, you can set the assumed current year in +# UPDATE_COPYRIGHT_YEAR. +# 4. The default maximum line length for a copyright line is 72. +# Set UPDATE_COPYRIGHT_MAX_LINE_LENGTH to use a different length. use strict; use warnings; -my $copyright_re = 'Copyright (?:\([cC]\)|@copyright{}|©)'; +my $copyright_re = 'Copyright'; +my $circle_c_re = '(?:\([cC]\)|@copyright{}|©)'; my $holder = 'Free Software Foundation, Inc.'; my $prefix_max = 5; -my $margin = 72; +my $margin = $ENV{UPDATE_COPYRIGHT_MAX_LINE_LENGTH}; +!$margin || $margin !~ m/^\d+$/ + and $margin = 72; + my $tab_width = 8; my $this_year = $ENV{UPDATE_COPYRIGHT_YEAR}; @@ -115,21 +146,31 @@ my $ws_re; my $stmt_re; while (/(^|\n)(.{0,$prefix_max})$copyright_re/g) { - $leading = $1; + $leading = "$1$2"; $prefix = $2; + if ($prefix =~ /^(\s*\/)\*(\s*)$/) + { + $prefix =~ s,/, ,; + my $prefix_ws = $prefix; + $prefix_ws =~ s/\*/ /; # Only whitespace. + if (/\G(?:[^*\n]|\*[^\/\n])*\*?\n$prefix_ws/) + { + $prefix = $prefix_ws; + } + } $ws_re = '[ \t\r\f]'; # \s without \n $ws_re = "(?:$ws_re*(?:$ws_re|\\n" . quotemeta($prefix) . ")$ws_re*)"; my $holder_re = $holder; $holder_re =~ s/\s/$ws_re/g; my $stmt_remainder_re = - "$ws_re(?:(?:\\d\\d)?\\d\\d(,$ws_re?|-))*" + "(?:$ws_re$circle_c_re)?" + . "$ws_re(?:(?:\\d\\d)?\\d\\d(?:,$ws_re?|-))*" . "((?:\\d\\d)?\\d\\d)$ws_re$holder_re"; if (/\G$stmt_remainder_re/) { $stmt_re = - quotemeta("$leading$prefix") - . "($copyright_re$stmt_remainder_re)"; + quotemeta($leading) . "($copyright_re$stmt_remainder_re)"; last; } } @@ -137,8 +178,7 @@ if (defined $stmt_re) { /$stmt_re/ or die; # Should never die. my $stmt = $1; - my $sep = $2 ? $2 : ""; - my $final_year_orig = $3; + my $final_year_orig = $2; # Handle two-digit year numbers like "98" and "99". my $final_year = $final_year_orig; @@ -148,25 +188,40 @@ if (defined $stmt_re) if ($final_year != $this_year) { # Update the year. - if ($sep eq '-' && $final_year + 1 == $this_year) - { - $stmt =~ s/$final_year_orig/$this_year/; - } - elsif ($sep ne '-' && $final_year + 1 == $this_year) - { - $stmt =~ s/$final_year_orig/$final_year-$this_year/; - } - else - { - $stmt =~ s/$final_year_orig/$final_year, $this_year/; - } - + $stmt =~ s/$final_year_orig/$final_year, $this_year/; + } + if ($final_year != $this_year || $ENV{'UPDATE_COPYRIGHT_FORCE'}) + { # Normalize all whitespace including newline-prefix sequences. $stmt =~ s/$ws_re/ /g; # Put spaces after commas. $stmt =~ s/, ?/, /g; + # Convert 2-digit to 4-digit years. + $stmt =~ s/(\b\d\d\b)/19$1/g; + + # Make the use of intervals consistent. + if (!$ENV{UPDATE_COPYRIGHT_USE_INTERVALS}) + { + $stmt =~ s/(\d{4})-(\d{4})/join(', ', $1..$2)/eg; + } + else + { + $stmt =~ + s/ + (\d{4}) + (?: + (,\ |-) + ((??{ + if ($2 eq '-') { '\d{4}'; } + elsif (!$3) { $1 + 1; } + else { $3 + 1; } + })) + )+ + /$1-$3/gx; + } + # Format within margin. my $stmt_wrapped; my $text_margin = $margin - length($prefix); @@ -180,8 +235,8 @@ if (defined $stmt_re) || ($stmt =~ s/^([\S]+)(?: |$)//)) { my $line = $1; - $stmt_wrapped .= $stmt_wrapped ? $eol : $leading; - $stmt_wrapped .= "$prefix$line"; + $stmt_wrapped .= $stmt_wrapped ? "$eol$prefix" : $leading; + $stmt_wrapped .= $line; } else { @@ -201,6 +256,7 @@ else } # Local variables: +# mode: perl # indent-tabs-mode: nil # eval: (add-hook 'write-file-hooks 'time-stamp) # time-stamp-start: "my $VERSION = '"