gdb/copyright.py

   1 #! /usr/bin/env python
   2
   3 # Copyright (C) 2011-2012 Free Software Foundation, Inc.
   4 #
   5 # This file is part of GDB.
   6 #
   7 # This program is free software; you can redistribute it and/or modify
   8 # it under the terms of the GNU General Public License as published by
   9 # the Free Software Foundation; either version 3 of the License, or
  10 # (at your option) any later version.
  11 #
  12 # This program is distributed in the hope that it will be useful,
  13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15 # GNU General Public License for more details.
  16 #
  17 # You should have received a copy of the GNU General Public License
  18 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
  19
  20 """copyright.py
  21
  22 This script updates the list of years in the copyright notices in
  23 most files maintained by the GDB project.
  24
  25 Usage: cd src/gdb && python copyright.py
  26
  27 Always review the output of this script before committing it!
  28 A useful command to review the output is:
  29     % filterdiff -x \*.c -x \*.cc -x \*.h -x \*.exp updates.diff
  30 This removes the bulk of the changes which are most likely to be correct.
  31 """
  32
  33 import datetime
  34 import os
  35 import os.path
  36 import subprocess
  37
  38
  39 def get_update_list():
  40     """Return the list of files to update.
  41
  42     Assumes that the current working directory when called is the root
  43     of the GDB source tree (NOT the gdb/ subdirectory!).  The names of
  44     the files are relative to that root directory.
  45     """
  46     result = []
  47     for gdb_dir in ('gdb', 'sim', 'include/gdb'):
  48         for root, dirs, files in os.walk(gdb_dir, topdown=True):
  49             for dirname in dirs:
  50                 reldirname = "%s/%s" % (root, dirname)
  51                 if (dirname in EXCLUDE_ALL_LIST
  52                     or reldirname in EXCLUDE_LIST
  53                     or reldirname in NOT_FSF_LIST
  54                     or reldirname in BY_HAND):
  55                     # Prune this directory from our search list.
  56                     dirs.remove(dirname)
  57             for filename in files:
  58                 relpath = "%s/%s" % (root, filename)
  59                 if (filename in EXCLUDE_ALL_LIST
  60                     or relpath in EXCLUDE_LIST
  61                     or relpath in NOT_FSF_LIST
  62                     or relpath in BY_HAND):
  63                     # Ignore this file.
  64                     pass
  65                 else:
  66                     result.append(relpath)
  67     return result
  68
  69
  70 def update_files(update_list):
  71     """Update the copyright header of the files in the given list.
  72
  73     We use gnulib's update-copyright script for that.
  74     """
  75     # We want to use year intervals in the copyright notices, and
  76     # all years should be collapsed to one single year interval,
  77     # even if there are "holes" in the list of years found in the
  78     # original copyright notice (OK'ed by the FSF, case [gnu.org #719834]).
  79     os.environ['UPDATE_COPYRIGHT_USE_INTERVALS'] = '2'
  80
  81     # Perform the update, and save the output in a string.
  82     update_cmd = ['bash', 'gdb/gnulib/extra/update-copyright'] + update_list
  83     p = subprocess.Popen(update_cmd, stdout=subprocess.PIPE,
  84                          stderr=subprocess.STDOUT)
  85     update_out = p.communicate()[0]
  86
  87     # Process the output.  Typically, a lot of files do not have
  88     # a copyright notice :-(.  The update-copyright script prints
  89     # a well defined warning when it did not find the copyright notice.
  90     # For each of those, do a sanity check and see if they may in fact
  91     # have one.  For the files that are found not to have one, we filter
  92     # the line out from the output, since there is nothing more to do,
  93     # short of looking at each file and seeing which notice is appropriate.
  94     # Too much work! (~4,000 files listed as of 2012-01-03).
  95     update_out = update_out.splitlines()
  96     warning_string = ': warning: copyright statement not found'
  97     warning_len = len(warning_string)
  98
  99     for line in update_out:
 100         if line.endswith('\n'):
 101             line = line[:-1]
 102         if line.endswith(warning_string):
 103             filename = line[:-warning_len]
 104             if may_have_copyright_notice(filename):
 105                 print line
 106         else:
 107             # Unrecognized file format. !?!
 108             print "*** " + line
 109
 110
 111 def may_have_copyright_notice(filename):
 112     """Check that the given file does not seem to have a copyright notice.
 113
 114     The filename is relative to the root directory.
 115     This function assumes that the current working directory is that root
 116     directory.
 117
 118     The algorigthm is fairly crude, meaning that it might return
 119     some false positives.  I do not think it will return any false
 120     negatives...  We might improve this function to handle more
 121     complex cases later...
 122     """
 123     # For now, it may have a copyright notice if we find the word
 124     # "Copyright" at the (reasonable) start of the given file, say
 125     # 50 lines...
 126     MAX_LINES = 50
 127
 128     fd = open(filename)
 129
 130     lineno = 1
 131     for line in fd:
 132         if 'Copyright' in line:
 133             return True
 134         lineno += 1
 135         if lineno > 50:
 136             return False
 137     return False
 138
 139
 140 def main ():
 141     """The main subprogram."""
 142     if not os.path.isfile("gnulib/extra/update-copyright"):
 143         print "Error: This script must be called from the gdb directory."
 144     root_dir = os.path.dirname(os.getcwd())
 145     os.chdir(root_dir)
 146
 147     update_list = get_update_list()
 148     update_files (update_list)
 149
 150     # Remind the user that some files need to be updated by HAND...
 151     if BY_HAND:
 152         print
 153         print "\033[31mREMINDER: The following files must be updated by hand." \
 154               "\033[0m"
 155         for filename in BY_HAND:
 156             print "  ", filename
 157
 158 ############################################################################
 159 #
 160 # Some constants, placed at the end because they take up a lot of room.
 161 # The actual value of these constants is not significant to the understanding
 162 # of the script.
 163 #
 164 ############################################################################
 165
 166 # Files which should not be modified, either because they are
 167 # generated, non-FSF, or otherwise special (e.g. license text,
 168 # or test cases which must be sensitive to line numbering).
 169 #
 170 # Filenames are relative to the root directory.
 171 EXCLUDE_LIST = (
 172     'gdb/gdbarch.c', 'gdb/gdbarch.h',
 173     'gdb/gnulib'
 174 )
 175
 176 # Files which should not be modified, either because they are
 177 # generated, non-FSF, or otherwise special (e.g. license text,
 178 # or test cases which must be sensitive to line numbering).
 179 #
 180 # Matches any file or directory name anywhere.  Use with caution.
 181 # This is mostly for files that can be found in multiple directories.
 182 # Eg: We want all files named COPYING to be left untouched.
 183
 184 EXCLUDE_ALL_LIST = (
 185     "COPYING", "COPYING.LIB", "CVS", "configure", "copying.c",
 186     "fdl.texi", "gpl.texi", "aclocal.m4",
 187 )
 188
 189 # The list of files to update by hand.
 190 BY_HAND = (
 191     # These files are sensitive to line numbering.
 192     "gdb/testsuite/gdb.base/step-line.inp",
 193     "gdb/testsuite/gdb.base/step-line.c",
 194 )
 195
 196 # The list of file which have a copyright, but not head by the FSF.
 197 # Filenames are relative to the root directory.
 198 NOT_FSF_LIST = (
 199     "gdb/exc_request.defs",
 200     "gdb/osf-share",
 201     "gdb/gdbtk",
 202     "gdb/testsuite/gdb.gdbtk/",
 203     "sim/arm/armemu.h", "sim/arm/armos.c", "sim/arm/gdbhost.c",
 204     "sim/arm/dbg_hif.h", "sim/arm/dbg_conf.h", "sim/arm/communicate.h",
 205     "sim/arm/armos.h", "sim/arm/armcopro.c", "sim/arm/armemu.c",
 206     "sim/arm/kid.c", "sim/arm/thumbemu.c", "sim/arm/armdefs.h",
 207     "sim/arm/armopts.h", "sim/arm/dbg_cp.h", "sim/arm/dbg_rdi.h",
 208     "sim/arm/parent.c", "sim/arm/armsupp.c", "sim/arm/armrdi.c",
 209     "sim/arm/bag.c", "sim/arm/armvirt.c", "sim/arm/main.c", "sim/arm/bag.h",
 210     "sim/arm/communicate.c", "sim/arm/gdbhost.h", "sim/arm/armfpe.h",
 211     "sim/arm/arminit.c",
 212     "sim/common/cgen-fpu.c", "sim/common/cgen-fpu.h", "sim/common/cgen-fpu.h",
 213     "sim/common/cgen-accfp.c", "sim/common/sim-fpu.c",
 214     "sim/erc32/sis.h", "sim/erc32/erc32.c", "sim/erc32/func.c",
 215     "sim/erc32/float.c", "sim/erc32/interf.c", "sim/erc32/sis.c",
 216     "sim/erc32/exec.c",
 217     "sim/mips/m16run.c", "sim/mips/sim-main.c",
 218     "sim/mn10300/sim-main.h",
 219     "sim/moxie/moxie-gdb.dts",
 220     # Not a single file in sim/ppc/ appears to be copyright FSF :-(.
 221     "sim/ppc/filter.h", "sim/ppc/gen-support.h", "sim/ppc/ld-insn.h",
 222     "sim/ppc/hw_sem.c", "sim/ppc/hw_disk.c", "sim/ppc/idecode_branch.h",
 223     "sim/ppc/sim-endian.h", "sim/ppc/table.c", "sim/ppc/hw_core.c",
 224     "sim/ppc/gen-support.c", "sim/ppc/gen-semantics.h", "sim/ppc/cpu.h",
 225     "sim/ppc/sim_callbacks.h", "sim/ppc/RUN", "sim/ppc/Makefile.in",
 226     "sim/ppc/emul_chirp.c", "sim/ppc/hw_nvram.c", "sim/ppc/dc-test.01",
 227     "sim/ppc/hw_phb.c", "sim/ppc/hw_eeprom.c", "sim/ppc/bits.h",
 228     "sim/ppc/hw_vm.c", "sim/ppc/cap.h", "sim/ppc/os_emul.h",
 229     "sim/ppc/options.h", "sim/ppc/gen-idecode.c", "sim/ppc/filter.c",
 230     "sim/ppc/corefile-n.h", "sim/ppc/std-config.h", "sim/ppc/ld-decode.h",
 231     "sim/ppc/filter_filename.h", "sim/ppc/hw_shm.c",
 232     "sim/ppc/pk_disklabel.c", "sim/ppc/dc-simple", "sim/ppc/misc.h",
 233     "sim/ppc/device_table.h", "sim/ppc/ld-insn.c", "sim/ppc/inline.c",
 234     "sim/ppc/emul_bugapi.h", "sim/ppc/hw_cpu.h", "sim/ppc/debug.h",
 235     "sim/ppc/hw_ide.c", "sim/ppc/debug.c", "sim/ppc/gen-itable.h",
 236     "sim/ppc/interrupts.c", "sim/ppc/hw_glue.c", "sim/ppc/emul_unix.c",
 237     "sim/ppc/sim_calls.c", "sim/ppc/dc-complex", "sim/ppc/ld-cache.c",
 238     "sim/ppc/registers.h", "sim/ppc/dc-test.02", "sim/ppc/options.c",
 239     "sim/ppc/igen.h", "sim/ppc/registers.c", "sim/ppc/device.h",
 240     "sim/ppc/emul_chirp.h", "sim/ppc/hw_register.c", "sim/ppc/hw_init.c",
 241     "sim/ppc/sim-endian-n.h", "sim/ppc/filter_filename.c",
 242     "sim/ppc/bits.c", "sim/ppc/idecode_fields.h", "sim/ppc/hw_memory.c",
 243     "sim/ppc/misc.c", "sim/ppc/double.c", "sim/ppc/psim.h",
 244     "sim/ppc/hw_trace.c", "sim/ppc/emul_netbsd.h", "sim/ppc/psim.c",
 245     "sim/ppc/ppc-instructions", "sim/ppc/tree.h", "sim/ppc/README",
 246     "sim/ppc/gen-icache.h", "sim/ppc/gen-model.h", "sim/ppc/ld-cache.h",
 247     "sim/ppc/mon.c", "sim/ppc/corefile.h", "sim/ppc/vm.c",
 248     "sim/ppc/INSTALL", "sim/ppc/gen-model.c", "sim/ppc/hw_cpu.c",
 249     "sim/ppc/corefile.c", "sim/ppc/hw_opic.c", "sim/ppc/gen-icache.c",
 250     "sim/ppc/events.h", "sim/ppc/os_emul.c", "sim/ppc/emul_generic.c",
 251     "sim/ppc/main.c", "sim/ppc/hw_com.c", "sim/ppc/gen-semantics.c",
 252     "sim/ppc/emul_bugapi.c", "sim/ppc/device.c", "sim/ppc/emul_generic.h",
 253     "sim/ppc/tree.c", "sim/ppc/mon.h", "sim/ppc/interrupts.h",
 254     "sim/ppc/cap.c", "sim/ppc/cpu.c", "sim/ppc/hw_phb.h",
 255     "sim/ppc/device_table.c", "sim/ppc/lf.c", "sim/ppc/lf.c",
 256     "sim/ppc/dc-stupid", "sim/ppc/hw_pal.c", "sim/ppc/ppc-spr-table",
 257     "sim/ppc/emul_unix.h", "sim/ppc/words.h", "sim/ppc/basics.h",
 258     "sim/ppc/hw_htab.c", "sim/ppc/lf.h", "sim/ppc/ld-decode.c",
 259     "sim/ppc/sim-endian.c", "sim/ppc/gen-itable.c",
 260     "sim/ppc/idecode_expression.h", "sim/ppc/table.h", "sim/ppc/dgen.c",
 261     "sim/ppc/events.c", "sim/ppc/gen-idecode.h", "sim/ppc/emul_netbsd.c",
 262     "sim/ppc/igen.c", "sim/ppc/vm_n.h", "sim/ppc/vm.h",
 263     "sim/ppc/hw_iobus.c", "sim/ppc/inline.h",
 264     "sim/testsuite/sim/bfin/s21.s", "sim/testsuite/sim/mips/mips32-dsp2.s",
 265 )
 266
 267 if __name__ == "__main__":
 268     main()
 269