X-Git-Url: http://erislabs.net/gitweb/?a=blobdiff_plain;f=build-aux%2Fupdate-copyright;h=c72d0e67da7bdbb80fc58f71a015e04c0df98a24;hb=fa1db0dd22768f09a507674a30beb5b8a87bb35f;hp=59ce6b6c6bffa4c912c92e126ec8a2f24dee052b;hpb=1c63e541d1b8be95158ffdcc2a724bb8848e8a6a;p=gnulib.git diff --git a/build-aux/update-copyright b/build-aux/update-copyright index 59ce6b6c6..c72d0e67d 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-07-31.12:44'; # UTC +my $VERSION = '2013-01-03.09:41'; # UTC -# Copyright (C) 2009 Free Software Foundation +# Copyright (C) 2009-2013 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. @@ -18,154 +20,231 @@ my $VERSION = '2009-07-31.12:44'; # UTC # You should have received a copy of the GNU General Public License # along with this program. If not, see . -# Written by Jim Meyering +# 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 your top-level makefile in your -# project: +# The arguments to this script should be names of files that contain +# copyright statements to be updated. The copyright holder's name +# defaults to "Free Software Foundation, Inc." but may be changed to +# any other name by using the "UPDATE_COPYRIGHT_HOLDER" environment +# variable. # -# .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 +# For example, you might wish to use the update-copyright target rule +# in maint.mk from gnulib's maintainer-makefile module. # -# In the second grep, you can build a list of files to skip within your -# project. +# Iff a 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: # -# 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. +# 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.) # -# Each file's FSF copyright statement must be formated correctly in -# order to be recognized, and it must appear before other text that -# looks like the start of a copyright statement. For example, each of -# these by itself is fine: +# A warning is printed for every file for which no copyright +# statement is recognized. # -# Copyright (C) 1990-2005, 2007-2009 Free Software Foundation, -# Inc. +# Each file's copyright statement must be formatted correctly in +# order to be recognized. For example, each of these is fine: +# +# Copyright @copyright{} 1990-2005, 2007-2009 Free Software +# Foundation, Inc. # # # Copyright (C) 1990-2005, 2007-2009 Free Software # # Foundation, Inc. # # /* -# * Copyright (C) 90,2005,2007-2009 Free Software -# * Foundation, Inc. +# * Copyright © 90,2005,2007-2009 +# * Free Software Foundation, Inc. # */ # # 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: +# However, any correctly formatted copyright statement following +# a non-matching copyright statements would be recognized. # -# Copyright (C) 1990-2005, 2007-2009 Acme, Inc. +# The exact conditions that a file's copyright statement must meet +# to be recognized are: # -# Moreover, any FSF copyright statement following either of the previous -# copyright statements might not be recognized. +# 1. It is the first copyright statement that meets all of the +# following conditions. Subsequent copyright statements are +# ignored. +# 2. Its format is "Copyright (C)", then a list of copyright years, +# and then the name of the copyright holder. +# 3. The "(C)" takes one of the following forms or is omitted +# entirely: # -# The exact conditions that a file's FSF copyright statement must meet -# to be recognized are listed below. They may seem slightly complex, -# but you need not worry if some file in your project accidentally -# breaks one. The worse that can happen is a warning that the file was -# not updated. +# A. (C) +# B. (c) +# C. @copyright{} +# D. © # -# 1. The format is "Copyright (C)" (where "(C)" can be "(c)"), then a -# list of copyright years, and then the name of the copyright -# holder, which is "Free Software Foundation, Inc.". -# 2. "Copyright (C)" appears at the beginning of a line except that it +# 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. -# 3. The prefix of "Copyright (C)" is the same as the prefix on the -# file's first occurrence of "Copyright (C)" that matches condition -# #2. Stated more simply, if something that looks like the start -# of a copyright statement appears earlier than the FSF copyright -# statement, the FSF copyright statement might not be recognized. -# This condition might be removed in the future. -# 4. Iff a prefix is present before "Copyright (C)", the same prefix -# appears at the beginning of each remaining line within the FSF -# copyright statement. -# 5. Blank lines, even if preceded by the prefix, do not appear +# 5 characters -- including white space. +# 5. Iff such a prefix is present, the same prefix appears at the +# beginning of each remaining line within the FSF copyright +# 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. -# 6. Each copyright year is 2 or 4 digits, and years are separated by -# commas or dashes. Whitespace may occur after commas. +# 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. +# If UPDATE_COPYRIGHT_USE_INTERVALS=2, convert a sequence with gaps +# to the minimal containing range. For example, convert +# 2000, 2004-2007, 2009 to 2000-2009. +# 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. +# 5. Set UPDATE_COPYRIGHT_HOLDER if the copyright holder is other +# than "Free Software Foundation, Inc.". use strict; use warnings; -my ($sec, $min, $hour, $mday, $month, $year) = localtime (time()); -my $this_year = $year + 1900; -my $copyright = 'Copyright \([cC]\)'; -my $holder = 'Free Software Foundation, Inc.'; +my $copyright_re = 'Copyright'; +my $circle_c_re = '(?:\([cC]\)|@copyright{}|©)'; +my $holder = $ENV{UPDATE_COPYRIGHT_HOLDER}; +$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}; +if (!$this_year || $this_year !~ m/^\d{4}$/) + { + my ($sec, $min, $hour, $mday, $month, $year) = localtime (time ()); + $this_year = $year + 1900; + } + +# Unless the file consistently uses "\r\n" as the EOL, use "\n" instead. +my $eol = /(?:^|[^\r])\n/ ? "\n" : "\r\n"; my $leading; my $prefix; -my $ws; -my $old; -if (/(^|\n)(.{0,$prefix_max})$copyright/) +my $ws_re; +my $stmt_re; +while (/(^|\n)(.{0,$prefix_max})$copyright_re/g) { - $leading = $1; + $leading = "$1$2"; $prefix = $2; - $ws = '[ \t\r\f]'; # \s without \n - $ws = "(?:$ws*(?:$ws|\\n" . quotemeta($prefix) . ")$ws*)"; - $holder =~ s/\s/$ws/g; - $old = - quotemeta("$leading$prefix") . "($copyright$ws" - . "(?:(?:\\d\\d)?\\d\\d(,$ws?|-))*" - . "((?:\\d\\d)?\\d\\d)$ws$holder)"; + 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$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) . "($copyright_re$stmt_remainder_re)"; + last; + } } -if (defined($old) && /$old/) +if (defined $stmt_re) { - my $new = $1; - my $sep = $2 ? $2 : ""; - my $last_c_year = $3; + /$stmt_re/ or die; # Should never die. + my $stmt = $1; + my $final_year_orig = $2; # Handle two-digit year numbers like "98" and "99". - $last_c_year <= 99 - and $last_c_year += 1900; + my $final_year = $final_year_orig; + $final_year <= 99 + and $final_year += 1900; - if ($last_c_year != $this_year) + if ($final_year != $this_year) { # Update the year. - if ($sep eq '-' && $last_c_year + 1 == $this_year) - { - $new =~ s/$last_c_year/$this_year/; - } - elsif ($sep ne '-' && $last_c_year + 1 == $this_year) + $stmt =~ s/\b$final_year_orig\b/$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}) { - $new =~ s/$last_c_year/$last_c_year-$this_year/; + $stmt =~ s/(\d{4})-(\d{4})/join(', ', $1..$2)/eg; } else { - $new =~ s/$last_c_year/$last_c_year, $this_year/; - } - - # Normalize all whitespace including newline-prefix sequences. - $new =~ s/$ws/ /g; + $stmt =~ + s/ + (\d{4}) + (?: + (,\ |-) + ((??{ + if ($2 eq '-') { '\d{4}'; } + elsif (!$3) { $1 + 1; } + else { $3 + 1; } + })) + )+ + /$1-$3/gx; - # Put spaces after commas. - $new =~ s/, ?/, /g; + # When it's 2, emit a single range encompassing all year numbers. + $ENV{UPDATE_COPYRIGHT_USE_INTERVALS} == 2 + and $stmt =~ s/\b(\d{4})\b.*\b(\d{4})\b/$1-$2/; + } # Format within margin. - my $new_wrapped; + my $stmt_wrapped; my $text_margin = $margin - length($prefix); - while (length($new)) + if ($prefix =~ /^(\t+)/) + { + $text_margin -= length($1) * ($tab_width - 1); + } + while (length $stmt) { - if (($new =~ s/^(.{1,$text_margin})(?: |$)//) - || ($new =~ s/^([\S]+)(?: |$)//)) + if (($stmt =~ s/^(.{1,$text_margin})(?: |$)//) + || ($stmt =~ s/^([\S]+)(?: |$)//)) { my $line = $1; - $new_wrapped .= $new_wrapped ? "\n" : $leading; - $new_wrapped .= "$prefix$line"; + $stmt_wrapped .= $stmt_wrapped ? "$eol$prefix" : $leading; + $stmt_wrapped .= $line; } else { @@ -176,15 +255,16 @@ if (defined($old) && /$old/) } # Replace the old copyright statement. - s/$old/$new_wrapped/; + s/$stmt_re/$stmt_wrapped/; } } else { - print STDERR "$ARGV: warning: FSF copyright statement not found\n"; + print STDERR "$ARGV: warning: copyright statement not found\n"; } # Local variables: +# mode: perl # indent-tabs-mode: nil # eval: (add-hook 'write-file-hooks 'time-stamp) # time-stamp-start: "my $VERSION = '"