gdb/copyright.py

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