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