| blob | 2c9ea3c1d591f3b847d60a5d6a9195aa7bd2ef58 |
1 #! /usr/bin/env python3
3 # Copyright (C) 2011-2024 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/>.
20 """copyright.py
22 This script updates the list of years in the copyright notices in
23 most files maintained by the GDB project.
25 Usage: cd src/gdb && ./copyright.py
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 """
33 import argparse
34 import datetime
35 import locale
36 import os
38 import subprocess
39 import sys
44 """Return the list of files to update.
46 Assumes that the current working directory when called is the root
47 of the GDB source tree (NOT the gdb/ subdirectory!). The names of
48 the files are relative to that root directory.
49 """
50 result = []
58 ):
63 dirname in EXCLUDE_ALL_LIST
67 ):
68 # Prune this directory from our search list.
73 filename in EXCLUDE_ALL_LIST
77 ):
78 # Ignore this file.
79 pass
82 return result
86 """Update the copyright header of the files in the given list.
88 We use gnulib's update-copyright script for that.
89 """
90 # We want to use year intervals in the copyright notices, and
91 # all years should be collapsed to one single year interval,
92 # even if there are "holes" in the list of years found in the
93 # original copyright notice (OK'ed by the FSF, case [gnu.org #719834]).
96 # Perform the update, and save the output in a string.
98 update_cmd += update_list
101 update_cmd,
105 )
108 # Process the output. Typically, a lot of files do not have
109 # a copyright notice :-(. The update-copyright script prints
110 # a well defined warning when it did not find the copyright notice.
111 # For each of those, do a sanity check and see if they may in fact
112 # have one. For the files that are found not to have one, we filter
113 # the line out from the output, since there is nothing more to do,
114 # short of looking at each file and seeing which notice is appropriate.
115 # Too much work! (~4,000 files listed as of 2012-01-03).
126 # Unrecognized file format. !?!
131 """Check that the given file does not seem to have a copyright notice.
133 The filename is relative to the root directory.
134 This function assumes that the current working directory is that root
135 directory.
137 The algorithm is fairly crude, meaning that it might return
138 some false positives. I do not think it will return any false
139 negatives... We might improve this function to handle more
140 complex cases later...
141 """
142 # For now, it may have a copyright notice if we find the word
143 # "Copyright" at the (reasonable) start of the given file, say
144 # 50 lines...
147 # We don't really know what encoding each file might be following,
148 # so just open the file as a byte stream. We only need to search
149 # for a pattern that should be the same regardless of encoding,
150 # so that should be good enough.
154 return True
156 break
157 return False
161 """Get a command line parser."""
164 )
165 return parser
169 """The main subprogram."""
177 ):
183 # Remind the user that some files need to be updated by HAND...
189 "REMINDER: Multiple copyright headers must be updated by hand:"
191 )
199 )
204 ############################################################################
205 #
206 # Some constants, placed at the end because they take up a lot of room.
207 # The actual value of these constants is not significant to the understanding
208 # of the script.
209 #
210 ############################################################################
212 # Files which should not be modified, either because they are
213 # generated, non-FSF, or otherwise special (e.g. license text,
214 # or test cases which must be sensitive to line numbering).
215 #
216 # Filenames are relative to the root directory.
217 EXCLUDE_LIST = (
226 )
228 # Files which should not be modified, either because they are
229 # generated, non-FSF, or otherwise special (e.g. license text,
230 # or test cases which must be sensitive to line numbering).
231 #
232 # Matches any file or directory name anywhere. Use with caution.
233 # This is mostly for files that can be found in multiple directories.
234 # Eg: We want all files named COPYING to be left untouched.
236 EXCLUDE_ALL_LIST = (
245 )
247 # The list of files to update by hand.
248 BY_HAND = (
249 # Nothing at the moment :-).
250 )
252 # Files containing multiple copyright headers. This script is only
253 # fixing the first one it finds, so we need to finish the update
254 # by hand.
255 MULTIPLE_COPYRIGHT_HEADERS = (
259 )
261 # The list of file which have a copyright, but not held by the FSF.
262 # Filenames are relative to the root directory.
263 NOT_FSF_LIST = (
299 # Not a single file in sim/ppc/ appears to be copyright FSF :-(.
426 )