-#! /usr/bin/env python
+#! /usr/bin/env python3
-# Copyright (C) 2011-2012 Free Software Foundation, Inc.
+# Copyright (C) 2011-2020 Free Software Foundation, Inc.
#
# This file is part of GDB.
#
"""
import datetime
+import locale
import os
import os.path
import subprocess
-
-# A list of prefixes that start a multi-line comment. These prefixes
-# should not be repeatead when wraping long lines.
-MULTILINE_COMMENT_PREFIXES = (
- '/*', # C/C++
- '<!--', # XML
- '{', # Pascal
-)
+import sys
def get_update_list():
the files are relative to that root directory.
"""
result = []
- for gdb_dir in ('gdb', 'sim', 'include/gdb'):
+ for gdb_dir in ('gdb', 'gnulib', 'sim', 'include/gdb'):
for root, dirs, files in os.walk(gdb_dir, topdown=True):
for dirname in dirs:
reldirname = "%s/%s" % (root, dirname)
We use gnulib's update-copyright script for that.
"""
- # Tell the update-copyright script that we do not want it to
- # repeat the prefixes in MULTILINE_COMMENT_PREFIXES.
- os.environ['MULTILINE_COMMENT_PREFIXES'] = \
- '\n'.join(MULTILINE_COMMENT_PREFIXES)
# We want to use year intervals in the copyright notices, and
# all years should be collapsed to one single year interval,
# even if there are "holes" in the list of years found in the
os.environ['UPDATE_COPYRIGHT_USE_INTERVALS'] = '2'
# Perform the update, and save the output in a string.
- update_cmd = ['bash', 'gdb/gnulib/extra/update-copyright'] + update_list
+ update_cmd = ['bash', 'gnulib/import/extra/update-copyright']
+ update_cmd += update_list
+
p = subprocess.Popen(update_cmd, stdout=subprocess.PIPE,
- stderr=subprocess.STDOUT)
+ stderr=subprocess.STDOUT,
+ encoding=locale.getpreferredencoding())
update_out = p.communicate()[0]
# Process the output. Typically, a lot of files do not have
# the line out from the output, since there is nothing more to do,
# short of looking at each file and seeing which notice is appropriate.
# Too much work! (~4,000 files listed as of 2012-01-03).
- update_out = update_out.splitlines()
+ update_out = update_out.splitlines(keepends=False)
warning_string = ': warning: copyright statement not found'
warning_len = len(warning_string)
for line in update_out:
- if line.endswith('\n'):
- line = line[:-1]
if line.endswith(warning_string):
filename = line[:-warning_len]
if may_have_copyright_notice(filename):
- print line
+ print(line)
else:
# Unrecognized file format. !?!
- print "*** " + line
+ print("*** " + line)
def may_have_copyright_notice(filename):
# 50 lines...
MAX_LINES = 50
- fd = open(filename)
+ # We don't really know what encoding each file might be following,
+ # so just open the file as a byte stream. We only need to search
+ # for a pattern that should be the same regardless of encoding,
+ # so that should be good enough.
+ fd = open(filename, 'rb')
lineno = 1
for line in fd:
- if 'Copyright' in line:
+ if b'Copyright' in line:
return True
lineno += 1
if lineno > 50:
def main ():
"""The main subprogram."""
- if not os.path.isfile("gnulib/extra/update-copyright"):
- print "Error: This script must be called from the gdb directory."
root_dir = os.path.dirname(os.getcwd())
os.chdir(root_dir)
+ if not (os.path.isdir('gdb') and
+ os.path.isfile("gnulib/import/extra/update-copyright")):
+ print("Error: This script must be called from the gdb directory.")
+ sys.exit(1)
+
update_list = get_update_list()
update_files (update_list)
# Remind the user that some files need to be updated by HAND...
+
+ if MULTIPLE_COPYRIGHT_HEADERS:
+ print()
+ print("\033[31m"
+ "REMINDER: Multiple copyright headers must be updated by hand:"
+ "\033[0m")
+ for filename in MULTIPLE_COPYRIGHT_HEADERS:
+ print(" ", filename)
+
if BY_HAND:
- print
- print "\033[31mREMINDER: The following files must be updated by hand." \
- "\033[0m"
+ print()
+ print("\033[31mREMINDER: The following files must be updated by hand." \
+ "\033[0m")
for filename in BY_HAND:
- print " ", filename
+ print(" ", filename)
############################################################################
#
#
# Filenames are relative to the root directory.
EXCLUDE_LIST = (
- 'gdb/gdbarch.c', 'gdb/gdbarch.h',
- 'gdb/gnulib'
+ 'gdb/nat/glibc_thread_db.h',
+ 'gdb/CONTRIBUTE',
+ 'gnulib/import'
)
# Files which should not be modified, either because they are
# The list of files to update by hand.
BY_HAND = (
- # These files are sensitive to line numbering.
- "gdb/testsuite/gdb.base/step-line.inp",
- "gdb/testsuite/gdb.base/step-line.c",
+ # Nothing at the moment :-).
+)
+
+# Files containing multiple copyright headers. This script is only
+# fixing the first one it finds, so we need to finish the update
+# by hand.
+MULTIPLE_COPYRIGHT_HEADERS = (
+ "gdb/doc/gdb.texinfo",
+ "gdb/doc/refcard.tex",
+ "gdb/gdbarch.sh",
)
# The list of file which have a copyright, but not head by the FSF.
# Filenames are relative to the root directory.
NOT_FSF_LIST = (
"gdb/exc_request.defs",
- "gdb/osf-share",
"gdb/gdbtk",
"gdb/testsuite/gdb.gdbtk/",
"sim/arm/armemu.h", "sim/arm/armos.c", "sim/arm/gdbhost.c",
"sim/arm/bag.c", "sim/arm/armvirt.c", "sim/arm/main.c", "sim/arm/bag.h",
"sim/arm/communicate.c", "sim/arm/gdbhost.h", "sim/arm/armfpe.h",
"sim/arm/arminit.c",
- "sim/common/cgen-fpu.c", "sim/common/cgen-fpu.h", "sim/common/cgen-fpu.h",
- "sim/common/cgen-accfp.c", "sim/common/sim-fpu.c",
- "sim/erc32/sis.h", "sim/erc32/erc32.c", "sim/erc32/func.c",
- "sim/erc32/float.c", "sim/erc32/interf.c", "sim/erc32/sis.c",
- "sim/erc32/exec.c",
+ "sim/common/cgen-fpu.c", "sim/common/cgen-fpu.h",
+ "sim/common/cgen-accfp.c",
"sim/mips/m16run.c", "sim/mips/sim-main.c",
- "sim/mn10300/sim-main.h",
"sim/moxie/moxie-gdb.dts",
# Not a single file in sim/ppc/ appears to be copyright FSF :-(.
"sim/ppc/filter.h", "sim/ppc/gen-support.h", "sim/ppc/ld-insn.h",