HCoop / bpt / emacs.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
Switch to recommended form of GPLv3 permissions notice.
[bpt/emacs.git] / lisp / emacs-lisp / authors.el
CommitLineData
66fd374b 1;;; authors.el --- utility for maintaining Emacs' AUTHORS file -*-coding: iso-2022-7bit;-*-
3215096c 2
d59c3137 3;; Copyright (C) 2000, 2001, 2002, 2003, 2004, 2005,
8b72699e 4;; 2006, 2007, 2008 Free Software Foundation, Inc.
3215096c 5
60e8e0a5 6;; Author: Gerd Moellmann <gerd@gnu.org>
f39caf44 7;; Maintainer: Kim F. Storm <storm@cua.dk>
60e8e0a5
GM		 8;; Keywords: maint
9
3215096c
GM		 10;; This file is part of GNU Emacs.
11
d6cba7ae 12;; GNU Emacs is free software: you can redistribute it and/or modify
3215096c 13;; it under the terms of the GNU General Public License as published by
d6cba7ae
GM		 14;; the Free Software Foundation, either version 3 of the License, or
15;; (at your option) any later version.
3215096c
GM		 16
17;; GNU Emacs is distributed in the hope that it will be useful,
18;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20;; GNU General Public License for more details.
21
22;; You should have received a copy of the GNU General Public License
d6cba7ae 23;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
3215096c
GM		 24
25;;; Commentary:
26
27;; Use M-x authors RET to create an *Authors* buffer that can used as
28;; or merged with Emacs' AUTHORS file.
29
30;;; Code:
31
f39caf44
KS		 32(defvar authors-coding-system 'iso-2022-7bit
33 "Coding system used in the AUTHORS file.")
34
3215096c
GM		 35(defconst authors-many-files 20
36 "Maximum number of files for which to print individual information.
f39caf44
KS		 37If an author has modified more files, only the names of the most
38frequently modified files are printed and a count of the additional
39files.")
3215096c
GM		 40
41(defconst authors-aliases
f39caf44 42 '(
9109bf49 43 ("Andrew Csillag" "Drew Csillag")
9dfa8726 44 ("Anna M. Bigatti" "Anna Bigatti")
f39caf44
KS		 45 ("Barry A. Warsaw" "Barry A. Warsaw, Century Computing, Inc."
46 "Barry A. Warsaw, ITB" "Barry Warsaw")
47 ("Bj\e,Av\e(Brn Torkelsson" "Bjorn Torkelsson")
48 ("Brian Fox" "Brian J. Fox")
49 ("Christoph Wedler" "Christoph.Wedler@sap.com")
50 ("Daniel Pfeiffer" "<Daniel.Pfeiffer@Informatik.START.db.de>"
51 "<Daniel.Pfeiffer@Informatik.START.dbp.de>")
52 ("David Gillespie" "Dave Gillespie")
53 ("David K\e,Ae\e(Bgedal" "David K..edal")
605046ef
KS		 54 ("David M. Koppelman" "David M. Koppelman, Koppel@Ee.Lsu.Edu"
55 "David Koppelman")
d0f483e8
KS		 56 ("David M. Smith" "David Smith" "David M Smith")
57 ("Ed L. Cashin" "Ed L Cashin")
f39caf44
KS		 58 ("Edward M. Reingold" "Ed Reingold" "Edward M Reingold"
59 "Reingold Edward M")
60 ("Eli Zaretskii" "eliz")
4ee02020 61 ("Emilio C. Lopes" "Emilio Lopes")
d0f483e8 62 ("Era Eriksson" "Era@Iki.Fi")
f39caf44
KS		 63 ("Eric M. Ludlam" "Eric Ludlam")
64 ("Eric S. Raymond" "Eric Raymond")
65 ("Eric Youngdale" "(Eric Youngdale at youngdale@v6550c.nrl.navy.mil)")
d0f483e8 66 ("Francis J. Wright" "Dr Francis J. Wright" "Francis Wright")
f39caf44 67 ("Fran\e,Ag\e(Bois Pinard" "Francois Pinard")
97c437db 68 ("Francesco Potort\e,Al\e(B" "Francesco Potorti" "Francesco Potorti`")
f39caf44
KS		 69 ("Frederic Pierresteguy" "Fred Pierresteguy")
70 ("Geoff Voelker" "voelker")
fd6780a5 71 ("Gerd M\e,Av\e(Bllmann" "Gerd Moellmann")
f39caf44 72 ("Hallvard B. Furuseth" "Hallvard B Furuseth")
621af279 73 ("Hrvoje Nik\e$,1!!\e(Bi\e$,1 '\e(B" "Hrvoje Niksic")
f39caf44
KS		 74 (nil "(afs@hplb.hpl.hp.com)")
75 (nil "<Use-Author-Address-Header@\\[127.1\\]>")
76 (nil "Code Extracted")
92158bc3 77 (nil "\\`FSF")
f39caf44
KS		 78 (nil "ISO-2022-JP")
79 ("Jaeyoun Chung" "Jae-youn Chung" "Jae-you Chung" "Chung Jae-youn")
80 ("Jan Dj\e,Ad\e(Brv" "Jan D." "Jan Djarv")
d0f483e8 81 ("Jay K. Adams" "jka@ece.cmu.edu" "Jay Adams")
621af279 82 ("J\e,Ai\e(Br\e,At\e(Bme Marant" "J\e,Ai\e(Br\e,At\e(Bme Marant" "Jerome Marant")
f39caf44 83 ("Jens-Ulrik Holger Petersen" "Jens-Ulrik Petersen")
605046ef 84 ("Jeremy Bertram Maitin-Shepard" "Jeremy Maitin-Shepard")
56c3f16c 85 ("Johan Bockg\e,Ae\e(Brd" "Johan Bockgard")
4ee02020 86 ("John W. Eaton" "John Eaton")
f39caf44
KS		 87 ("Jonathan I. Kamens" "Jonathan Kamens")
88 ("Joseph Arceneaux" "Joe Arceneaux")
4ee02020 89 ("Juan Le\e,As\e(Bn Lahoz Garc\e,Am\e(Ba" "Juan-Leon Lahoz Garcia")
f39caf44 90 ("K. Shane Hartman" "Shane Hartman")
621af279 91 ("Kai Gro\e,A_\e(Bjohann" "Kai Grossjohann" "Kai Gro\e,A_\e(Bjohann"
d0f483e8
KS		 92 "Kai.Grossjohann@Cs.Uni-Dortmund.De"
93 "Kai.Grossjohann@Gmx.Net")
f39caf44 94 ("Karl Berry" "K. Berry")
621af279 95 ("K\e,Aa\e(Broly L\e$,1 q\e(Brentey" "K\e,Aa\e(Broly L\e$,1 q\e(Brentey" "L\e$,1 q\e(Brentey K\e,Aa\e(Broly")
d0f483e8 96 ("Kazushi Marukawa" "Kazushi")
f39caf44
KS		 97 ("Ken Manheimer" "Kenneth Manheimer")
98 ("Kenichi Handa" "Ken'ichi Handa" "Kenichi HANDA")
4ee02020 99 ("Kevin Greiner" "Kevin J. Greiner")
f39caf44 100 ("Kim F. Storm" "Kim Storm")
d0f483e8 101 ("Kyle Jones" "Kyle E. Jones")
f39caf44 102 ("Marcus G. Daniels" "Marcus Daniels")
d0f483e8 103 ("Mark D. Baushke" "Mark D Baushke")
0af6d7f3 104 ("Agust\e,Am\e(Bn Mart\e,Am\e(Bn" "Agustin Martin")
d0f483e8
KS		 105 ("Martin Lorentzon" "Martin Lorentzson")
106 ("Matt Swift" "Matthew Swift")
4ee02020 107 ("Michael R. Mauger" "Michael Mauger")
f39caf44 108 ("Michael D. Ernst" "Michael Ernst")
c0b1307a 109 ("Micha\e,Ak\e(Bl Cadilhac" "Michael Cadilhac")
f39caf44 110 ("Michael I. Bushnell" "Michael I Bushnell" "Michael I. Bushnell, P/Bsg")
4ee02020 111 ("Mikio Nakajima" "Nakajima Mikio")
f39caf44
KS		 112 ("Paul Eggert" "eggert")
113 ("Paul Reilly" "(pmr@legacy.pajato.com)")
621af279 114 ("Pavel Jan\e,Am\e(Bk" "Pavel Jan\e,Am\e(Bk Ml." "Pavel Jan\e,Am\e(Bk" "Pavel@Janik.Cz")
f39caf44 115 ("Per Abrahamsen" "Per Abhiddenware")
d0f483e8
KS		 116 ("Peter S. Galbraith" "Peter Galbraith")
117 ("Peter Runestig" "Peter 'luna' Runestig")
f39caf44
KS		 118 ("Peter S. Galbraith" "Peter S Galbraith")
119 ("Richard M. Stallman" "Richard M. Stallman,,," "Richard Stallman"
a1506d29 120 "rms" "rms@gnu.org")
f39caf44
KS		 121 ("Robert J. Chassell" "Bob Chassell")
122 ("Roland B. Roberts" "Roland B Roberts" "Roland Roberts")
123 ("Rui-Tao Dong" "Rui-Tao Dong ~{6-Hpln~}")
a8d37031 124 ("Sacha Chua" "Sandra Jean Chua")
f39caf44 125 ("Sam Steingold" "Sam Shteingold")
9109bf49 126 ("Satyaki Das" "Indexed search by Satyaki Das")
d0f483e8 127 ("Stefan Monnier" "Stefan")
f39caf44
KS		 128 ("Stephen A. Wood" "(saw@cebaf.gov)")
129 ("Steven L. Baur" "SL Baur" "Steven L Baur")
130 ("Takaaki Ota" "Tak Ota")
4ee02020 131 ("Takahashi Naoto" "Naoto Takahashi")
d0f483e8 132 ("Teodor Zlatanov" "Ted Zlatanov")
f39caf44
KS		 133 ("Torbj\e,Av\e(Brn Axelsson" "Torbjvrn Axelsson")
134 ("Torbj\e,Av\e(Brn Einarsson" "Torbj.*rn Einarsson")
135 ("Toru Tomabechi" "Toru Tomabechi,")
136 ("Vincent Del Vecchio" "Vince Del Vecchio")
9109bf49 137 ("William M. Perry" "Bill Perry")
f39caf44
KS		 138 ("Wlodzimierz Bzyl" "W.*dek Bzyl")
139 ("Yutaka NIIBE" "NIIBE Yutaka")
d5ab63b2 140 )
3215096c
GM		 141 "Alist of author aliases.
142
f39caf44 143Each entry is of the form (REALNAME REGEXP...). If an author's name
a1506d29 144matches one of the REGEXPs, use REALNAME instead.
f39caf44 145If REALNAME is nil, ignore that author.")
3215096c
GM		 146
147
0a521885
GM		 148(defvar authors-public-domain-files
149 '("auto-show\\.el"
150 "form-d2\\.el"
151 "emerge\\.el"
152 "unused\\.el"
153 "vi\\.el"
154 "feedmail\\.el"
155 "mailpost\\.el"
156 "hanoi\\.el"
157 "meese\\.el"
158 "studly\\.el"
159 "modula2\\.el")
160 "List of regexps matching files for which the FSF doesn't need papers.")
161
162
8a5506f2
GM		 163(defvar authors-obsolete-files-regexps
164 '("vc-\\*\\.el$"
165 "spec.txt$"
166 "vc-\\(rcs\\|cvs\\|sccs\\)-hooks\\.el$")
167 "List of regexps matching obsolete files.
168Changes to files matching one of the regexps in this list are not
169listed.")
170
4ee02020
KS		 171(defconst authors-ignored-files
172 '("external-lisp"
173 "lock" "share-lib" "local-lisp"
174 "noleim-Makefile.in"
56e48725 175 "NEWS" "PROBLEMS" "FAQ" "AUTHORS" "FOR-RELEASE" "TODO")
4ee02020
KS		 176 "List of files and directories to ignore.
177Changes to files in this list are not listed.")
8a5506f2 178
d5ab63b2 179(defconst authors-fixed-entries
8b1163a3 180 '(("Richard M. Stallman" :wrote "[The original GNU Emacs and numerous files]")
f39caf44 181 ("Joseph Arceneaux" :wrote "xrdb.c")
d5ab63b2
GM		 182 ("Blitz Product Development Corporation" :wrote "ispell.el")
183 ("Frank Bresz" :wrote "diff.el")
184 ("David M. Brown" :wrote "array.el")
185 ("Gary Byers" :changed "xenix.h")
186 ("Shawn M. Carey" :wrote "freebsd.h")
187 ("Eric Decker" :changed "hp9000s800.h" "hpux.h" "sysdep.c")
188 ("Lawrence R. Dodd" :wrote "dired-x.el")
189 ("Viktor Dukhovni" :wrote "unexsunos4.c")
190 ("Paul Eggert" :wrote "rcs2log" "vcdiff")
191 ("Fred Fish" :changed "unexec.c")
192 ("Tim Fleehart" :wrote "makefile.nt")
193 ("Keith Gabryelski" :wrote "hexl.c")
194 ("Kevin Gallagher" :wrote "flow-ctrl.el")
195 ("Howard Gayle" :wrote "disp-table.el" "iso-syntax.el" "casetab.c")
196 ("Stephen Gildea" :wrote "refcard.tex" "mh-funcs.el" "mh-pick.el")
197 ("David Gillespie" :wrote "cl.texinfo")
198 ("Hewlett-Packard" :changed "emacsclient.c" "emacsserver.c"
199 "server.el" "keyboard.c")
200 ("Thomas Horsley" :wrote "cxux.h" "cxux7.h")
201 ("Indiana University Foundation" :changed "buffer.c" "buffer.h"
202 "indent.c" "search.c" "xdisp.c" "region-cache.c" "region-cache.h")
203 ("International Business Machines" :changed "emacs.c" "fileio.c"
204 "ibmrt.h" "process.c" "sysdep.c" "unexec.c" "ibmrt-aix.h")
205 ("Ishikawa Chiaki" :changed "aviion.h" "dgux.h")
206 ("Michael K. Johnson" :changed "configure.in" "emacs.c" "intel386.h"
207 "mem-limits.h" "process.c" "template.h" "sysdep.c" "syssignal.h" "systty.h" "unexec.c"
208 "ymakefile" "linux.h")
56c3f16c 209 ("Kyle Jones" :wrote "mldrag.el")
4ee02020 210 ("Henry Kautz" :wrote "bib-mode.el")
d5ab63b2
GM		 211 ("Joseph M. Kelsey" :changed "fileio.c" "vms-pwd.h" "vmsfns.c" "dir.h"
212 "uaf.h")
213 ("Sam Kendall" :changed "etags.c" "etags.el")
214 ("Richard King" :wrote "backquote.el" "userlock.el" "filelock.c")
215 ("Larry Kolodney" :wrote "cvtmail.c")
216 ("Sebastian Kremer" :changed "add-log.el")
217 ("Mark Lambert" :changed "process.c" "process.h")
218 ("Aaron Larson" :changed "bibtex.el")
219 ("James R. Larus" :wrote "mh-e.el")
220 ("Lars Lindberg" :changed "dabbrev.el" :wrote "imenu.el")
221 ("Lucid, Inc." :changed "bytecode.c" "byte-opt.el" "byte-run.el"
222 "bytecomp.el" "delsel.el" "disass.el" "faces.el" "font-lock.el"
223 "lmenu.el" "lselect.el" "mailabbrev.el" "select.el" "xfaces.c"
224 "xselect.c")
225 ("MCC" :changed "etags.c" "emacsclient.c" "emacsserver.c" "movemail.c"
226 "rmail.el" "rmailedit.el" "rmailkwd.el"
227 "rmailmsc.el" "rmailout.el" "rmailsum.el" "scribe.el"
228 "server.el" "lisp.h" "sysdep.c" "unexec.c" :wrote "xmenu.c")
229 ("Niall Mansfield" :changed "etags.c")
230 ("Brian Marick" :wrote "hideif.el")
231 ("Marko Kohtala" :changed "info.el")
232 ("Sidney Markowitz" :changed "doctor.el")
233 ("Richard Mlynarik" :wrote "env.c" "ehelp.el")
234 ("Mosur Mohan" :changed "etags.c")
235 ("Jeff Morgenthaler" :changed "flow-ctrl.el" "vt200.el" "vt201.el"
236 "vt220.el" "vt240.el")
237 ("Motorola" :changed "buff-menu.el")
238 ("Hiroshi Nakano" :changed "ralloc.c")
239 ("Sundar Narasimhan" :changed "rnewspost.el")
240 ("NeXT, Inc." :wrote "unexnext.c")
241 ("Mark Neale" :changed "fortran.el")
242 ("Martin Neitzel" :changed "sc.el")
243 ("Andrew Oram" :changed "miscellaneous changes to files in man/"
244 "man/calendar.texi")
245 ("Frederic Pierresteguy" :wrote "widget.c")
246 ("Michael D. Prange" :changed "tex-mode.el")
247 ("Paul Reilly" :wrote "gux5-4r2.h" "dgux5-4r3.h")
d0f483e8 248 ("Roland B. Roberts" :changed "files.el" "sort.el" "vmsproc.el"
d5ab63b2
GM		 249 "buffer.h" "callproc.c" "dired.c" "process.c" "sysdep.c" "systty.h"
250 "vmspaths.h" "build.com" "compile.com" "kepteditor.com" "precomp.com"
251 :wrote "logout.com" "mailemacs.com")
252 ("Guillermo J. Rozas" :wrote "fakemail.c")
253 ("Wolfgang Rupprecht" :changed "lisp-mode.el" "loadup.el"
254 "sort.el" "alloc.c" "callint.c"
255 "config.h.in" "crt0.c" "data.c" "fns.c"
256 "lisp.h" "lread.c" "sun3.h"
257 "print.c" "ymakefile" :wrote "float-sup.el" "floatfns.c")
258 ("Schlumberger Technology Corporation" :changed "gud.el")
259 ("Gregor Schmid" :wrote "tcl-mode.el")
260 ("Rainer Schoepf" :wrote "alpha.h" "unexalpha.c")
261 ("William Sommerfeld" :wrote "emacsclient.c" "emacsserver.c" "scribe.el")
262 ("Leigh Stoller" :changed "emacsclient.c" "emacsserver.c" "server.el")
263 ("Steve Strassman" :wrote "spook.el")
264 ("Shinichirou Sugou" :changed "etags.c")
265 ("Sun Microsystems, Inc" :changed "emacsclient.c" "emacsserver.c"
266 "server.el" :wrote "emacs.icon" "emacstool.1" "emacstool.c" "sun-curs.el"
267 "sun-fns.el" "sun-mouse.el" "sun.el" "sunfns.c")
268 ("Kayvan Sylvan" :changed "sc.el")
269 ("Spencer Thomas" :changed "emacsclient.c" "emacsserver.c" "server.el"
270 "dabbrev.el" "unexec.c" "tcp.c" "gnus.texi")
271 ("Jonathan Vail" :changed "vc.el")
272 ("James Van Artsdalen" :changed "usg5-4.h" "unexec.c")
273 ("Geoff Voelker" :wrote "src/makefile.nt" "lisp/makefile.nt" "winnt.el"
274 "nt.c" "nt.h" "ntheap.c" "ntheap.h" "ntinevt.c"
275 "ntproc.c" "ntterm.c" "windowsnt.h")
276 ("Morten Welinder" :wrote "dosfns.c" "[many MSDOS files]" "msdos.h")
277 ("Pace Willisson" :wrote "ispell.el")
278 ("Garrett Wollman" :changed "sendmail.el")
9109bf49 279 ("Dale R. Worley" :changed "mail-extr.el")
d5ab63b2
GM		 280 ("Jamie Zawinski" :changed "bytecode.c" :wrote "disass.el" "tar-mode.el"))
281 "Actions taken from the original, manually (un)maintained AUTHORS file.")
282
283
f39caf44
KS		 284(defconst authors-valid-file-names
285 '("aclocal.m4"
4ee02020
KS		 286 "makedist.bat"
287 "make-delta")
f39caf44
KS		 288 "File names which are valid, but no longer exists (or cannot be
289found) in the repository.")
290
291(defconst authors-renamed-files-alist
292 '(("nt.c" . "w32.c") ("nt.h" . "w32.h")
293 ("ntheap.c" . "w32heap.c") ("ntheap.h" . "w32heap.h")
294 ("ntinevt.c" . "w32inevt.c") ("ntinevt.h" . "w32inevt.h")
295 ("ntproc.c" . "w32proc.c")
296 ("w32console.c" . "w32term.c")
297 ("unexnt.c" . "unexw32.c")
298 ("s/windowsnt.h" . "s/ms-w32.h")
299 ("config.emacs" . "configure")
300 ("GETTING.GNU.SOFTWARE" . "FTP")
4ee02020
KS		 301 ("leim-Makefile" . "leim/Makefile")
302 ("leim-Makefile.in" . "leim/Makefile.in")
92158bc3
KS		 303 ("emacs-lisp/testcover-ses.el" . "tcover-ses.el")
304 ("emacs-lisp/testcover-unsafep.el" . "tcover-unsafep.el")
4ee02020 305 ("INSTALL-CVS" . "INSTALL.CVS")
f39caf44
KS		 306 )
307 "Alist of files which have been renamed during their lifetime.
308Elements are (OLDNAME . NEWNAME).")
309
310(defconst authors-renamed-files-regexps
311 '(("^m/m-\\(.*\\.h\\)$" . "m/\\1")
312 ("^m-\\(.*\\.h\\)$" . "\\1")
313 ("^s/s-\\(.*\\.h\\)$" . "s/\\1")
314 ("^s-\\(.*\\.h\\)$" . "\\1")
315 ("^s/[-.a-zA-Z0-9_]+\\.h$" . t)
316 ("\\(.*\\)\\.cmd$" . "\\1.bat")
317 ("\\.bat$" . t)
318 ("\\.[ch]$" . t)
319 ("\\.el$" . t)
320 ("\\.ps$" . t)
321 ("\\.texi?$" . t)
322 ("\\.texinfo$" . t)
323 ("\\.xml?$" . t)
324 ("\\.x[pb]m$" . t)
325 ("\\.[xp]bm$" . t)
326 ("^paths\\." . t)
327 ("^install\\." . t)
328 )
329 "List regexps and rewriting rules for renamed files.
330Elements are (REGEXP . REPLACE). If REPLACE is a string, the file
331name matching REGEXP is replaced by REPLACE using `replace-string'.
332Otherwise, the file name is accepted as is.")
333
334(defvar authors-checked-files-alist)
335(defvar authors-invalid-file-names)
336
337(defun authors-canonical-file-name (file log-file pos author)
338 "Return canonical file name for FILE found in LOG-FILE at POS for AUTHOR.
339Checks whether FILE is a valid (existing) file name, has been renamed,
340or is on the list of removed files. Returns the non-diretory part of
341the file name."
342 (let ((entry (assoc file authors-checked-files-alist))
343 relname
344 valid)
345 (if entry
346 (cdr entry)
347 (setq relname (file-name-nondirectory file))
348 (if (or (member relname authors-valid-file-names)
349 (file-exists-p file)
350 (file-exists-p relname)
351 (file-exists-p (concat "etc/" relname)))
352 (setq valid relname)
353 (setq valid (assoc file authors-renamed-files-alist))
354 (if valid
355 (setq valid (cdr valid))
356 (let ((rules authors-renamed-files-regexps))
357 (while rules
358 (if (string-match (car (car rules)) file)
359 (setq valid (if (stringp (cdr (car rules)))
360 (file-name-nondirectory
361 (replace-match (cdr (car rules)) t nil file))
362 relname)
363 rules nil))
364 (setq rules (cdr rules))))))
365 (setq authors-checked-files-alist
366 (cons (cons file valid) authors-checked-files-alist))
9109bf49
KS		 367 (unless (or valid
368 (string-match "[*]" file)
369 (string-match "^[0-9.]+$" file))
a1506d29 370 (setq authors-invalid-file-names
f39caf44
KS		 371 (cons (format "%s:%d: unrecognized `%s' for %s"
372 log-file
373 (1+ (count-lines (point-min) pos))
374 file author)
375 authors-invalid-file-names)))
376 valid)))
377
d5ab63b2
GM		 378(defun authors-add-fixed-entries (table)
379 "Add actions from `authors-fixed-entries' to TABLE."
380 (dolist (entry authors-fixed-entries)
381 (let ((author (car entry))
382 action)
383 (dolist (item (cdr entry))
384 (if (symbolp item)
385 (setq action item)
386 (authors-add author item action table))))))
387
3932b29a 388
8a5506f2
GM		 389(defun authors-obsolete-file-p (file)
390 "Return non-nil if FILE is obsolete.
3932b29a 391FILE is considered obsolete if it matches one of the regular expressions
8a5506f2
GM		 392from `authors-obsolete-files-regexps'."
393 (let (obsolete-p
394 (regexps authors-obsolete-files-regexps))
395 (while (and regexps (not obsolete-p))
396 (setq obsolete-p (string-match (car regexps) file)
397 regexps (cdr regexps)))
398 obsolete-p))
399
400
3215096c
GM		 401(defun authors-add (author file action table)
402 "Record that AUTHOR worked on FILE.
403ACTION is a keyword symbol describing what he did. Record file,
404author and what he did in hash table TABLE. See the description of
405`authors-scan-change-log' for the structure of the hash table."
4ee02020
KS		 406 (unless (or (member file authors-ignored-files)
407 (authors-obsolete-file-p file)
9c1af546 408 (equal author ""))
8a5506f2 409 (let* ((value (gethash author table))
f39caf44
KS		 410 (entry (assoc file value))
411 slot)
8a5506f2 412 (if (null entry)
f39caf44
KS		 413 (puthash author (cons (list file (cons action 1)) value) table)
414 (if (setq slot (assoc action (cdr entry)))
415 (setcdr slot (1+ (cdr slot)))
416 (nconc entry (list (cons action 1))))))))
3215096c
GM		 417
418
3215096c
GM		 419(defun authors-canonical-author-name (author)
420 "Return a canonicalized form of AUTHOR, an author name.
421If AUTHOR has an alias, use that. Remove email addresses. Capitalize
422words in the author's name."
f39caf44
KS		 423 (let* ((aliases authors-aliases)
424 regexps realname)
3215096c 425 (while aliases
f39caf44
KS		 426 (setq realname (car (car aliases))
427 regexps (cdr (car aliases))
428 aliases (cdr aliases))
429 (while regexps
430 (if (string-match (car regexps) author)
431 (setq author realname
432 regexps nil
433 aliases nil)
434 (setq regexps (cdr regexps))))))
435 (when author
436 (setq author (replace-regexp-in-string "[ \t]*[(<].*$" "" author))
d0f483e8 437 (setq author (replace-regexp-in-string "\`[ \t]+" "" author))
f39caf44 438 (setq author (replace-regexp-in-string "[ \t]+$" "" author))
d0f483e8
KS		 439 (setq author (replace-regexp-in-string "[ \t]+" " " author))
440 (unless (string-match "[-, \t]" author)
441 (setq author ""))
f39caf44
KS		 442 (capitalize author)))
443
f39caf44
KS		 444(defun authors-scan-change-log (log-file table)
445 "Scan change log LOG-FILE for author information.
3215096c
GM		 446
447For each change mentioned in the log, add an entry to hash table TABLE
448under the author's canonical name.
449
450Keys of TABLE are author names. Values are alists of entries (FILE
f39caf44
KS		 451\(ACTION . COUNT) ...). FILE is one file the author worked on. The
452rest of the entry is a list of keyword symbols describing what he did
453with the file and the number of each action.
3215096c
GM		 454
455:wrote means the author wrote the file
f39caf44 456:changed means he changed the file COUNT times."
3932b29a 457
68013cfa
GM		 458 (let* ((enable-local-variables :safe)
459 (enable-local-eval nil)
f39caf44
KS		 460 (existing-buffer (get-file-buffer log-file))
461 (buffer (find-file-noselect log-file))
462 author file pos)
3215096c
GM		 463 (save-excursion
464 (set-buffer buffer)
465 (save-restriction
466 (widen)
467 (goto-char (point-min))
468 (while (re-search-forward "^[0-9]\\|^[ \t]+\\* " nil t)
469 (beginning-of-line)
f39caf44 470 (setq pos (point))
3215096c
GM		 471 (cond ((looking-at "^[0-9]+-[0-9]+-[0-9]+")
472 (skip-chars-forward " \t+:0-9-")
473 (setq author (buffer-substring-no-properties
474 (point) (line-end-position)))
475 (setq author (authors-canonical-author-name author))
476 (forward-line 1))
477 ((looking-at "^[ \t]+\\*")
478 (let ((line (buffer-substring-no-properties
479 (match-end 0) (line-end-position))))
480 (while (and (not (string-match ":" line))
481 (forward-line 1)
482 (not (looking-at ":\\|^[ \t]*$")))
483 (setq line (concat line
484 (buffer-substring-no-properties
485 (line-beginning-position)
486 (line-end-position)))))
487 (when (string-match ":" line)
488 (setq line (substring line 0 (match-beginning 0)))
489 (setq line (replace-regexp-in-string "[[(<{].*$" "" line))
490 (setq line (replace-regexp-in-string "," "" line))
491 (dolist (file (split-string line))
f39caf44
KS		 492 (when (setq file (authors-canonical-file-name file log-file pos author))
493 ;;(message "%s changed %s" author file)
494 (authors-add author file :changed table))))
3215096c
GM		 495 (forward-line 1)))))))
496 (unless existing-buffer
497 (kill-buffer buffer))))
498
499
500(defun authors-scan-el (file table)
501 "Scan Lisp file FILE for author information.
502TABLE is a hash table to add author information to."
503 (let* ((existing-buffer (get-file-buffer file))
68013cfa
GM		 504 (enable-local-variables :safe)
505 (enable-local-eval nil)
3215096c
GM		 506 (buffer (find-file-noselect file)))
507 (save-excursion
508 (set-buffer buffer)
509 (save-restriction
510 (widen)
511 (goto-char (point-min))
512 (while (and (re-search-forward
513 "^;+[ \t]*\\(Author\\|Commentary\\):[ \t]*" nil t)
514 (not (string= (match-string 1) "Commentary")))
515 ;; Some entries contain a year range in front of the
516 ;; author's name.
517 (skip-chars-forward "-0-9 \t")
518 (let ((author (buffer-substring-no-properties
519 (point) (line-end-position))))
520 (setq author (authors-canonical-author-name author))
521 (setq file (file-name-nondirectory file))
522 (authors-add author file :wrote table)))))
523 (unless existing-buffer
524 (kill-buffer buffer))))
525
526
0a521885
GM		 527(defun authors-public-domain-p (file)
528 "Return t if FILE is a file that was put in public domain."
529 (let ((public-domain-p nil)
530 (list authors-public-domain-files))
531 (while (and list (not public-domain-p))
532 (when (string-match (car list) file)
533 (setq public-domain-p t))
534 (setq list (cdr list)))
535 public-domain-p))
536
f39caf44
KS		 537(defvar authors-author-list)
538
539(defun authors-add-to-author-list (author changes)
540 "Insert information about AUTHOR's work on Emacs into `authors-author-list'.
541CHANGES is an alist of entries (FILE (ACTION . COUNT) ...), as produced by
542`authors-scan-change-log'.
543The element added to `authors-author-list' is (AUTHOR WROTE CHANGED), where
a1506d29 544WROTE and CHANGED are lists of the files written and changed by AUTHOR."
f39caf44
KS		 545 (when author
546 (let ((nchanged 0)
547 wrote-list
548 changed-list)
3215096c
GM		 549 (dolist (change changes)
550 (let ((actions (cdr change))
f39caf44
KS		 551 (file (car change))
552 slot)
553 (if (assq :wrote actions)
554 (setq wrote-list
555 (cons
556 (if (authors-public-domain-p file)
557 (concat file " (public domain)")
558 file)
559 wrote-list))
560 (setq changed-list
561 (cons (cons file (cdr (assq :changed actions)))
562 changed-list)))))
563 (if wrote-list
564 (setq wrote-list (sort wrote-list 'string-lessp)))
565 (when changed-list
566 (setq changed-list (sort changed-list
567 (lambda (a b)
568 (if (= (cdr a) (cdr b))
569 (string-lessp (car a) (car b))
570 (> (cdr a) (cdr b))))))
571 (setq nchanged (length changed-list))
572 (setq changed-list (mapcar 'car changed-list)))
573 (if (> (- nchanged authors-many-files) 2)
574 (setcdr (nthcdr authors-many-files changed-list)
575 (list (format "and %d other files" (- nchanged authors-many-files)))))
576 (setq authors-author-list
577 (cons (list author wrote-list changed-list)
578 authors-author-list)))))
3215096c 579
3215096c
GM		 580(defun authors (root)
581 "Extract author information from change logs and Lisp source files.
582ROOT is the root directory under which to find the files. If called
a1506d29 583interactively, ROOT is read from the minibuffer.
f39caf44
KS		 584Result is a buffer *Authors* containing authorship information, and a
585buffer *Authors Errors* containing references to unknown files."
3215096c 586 (interactive "DEmacs source directory: ")
d2f288c6 587 (setq root (expand-file-name root))
c7efbb12 588 (let ((logs (process-lines find-program root "-name" "ChangeLog*"))
3215096c 589 (table (make-hash-table :test 'equal))
f39caf44
KS		 590 (buffer-name "*Authors*")
591 authors-checked-files-alist
592 authors-invalid-file-names)
621af279
DK		 593 (authors-add-fixed-entries table)
594 (unless (file-exists-p (expand-file-name "src/emacs.c" root))
595 (error "Not the root directory of Emacs: %s" root))
3215096c 596 (dolist (log logs)
77777daf 597 (when (string-match "ChangeLog\\(.[0-9]+\\)?$" log)
3215096c
GM		 598 (message "Scanning %s..." log)
599 (authors-scan-change-log log table)))
c7efbb12 600 (let ((els (process-lines find-program root "-name" "*.el")))
3215096c
GM		 601 (dolist (file els)
602 (message "Scanning %s..." file)
603 (authors-scan-el file table)))
f39caf44 604 (message "Generating buffer %s..." buffer-name)
3215096c
GM		 605 (set-buffer (get-buffer-create buffer-name))
606 (erase-buffer)
f39caf44 607 (set-buffer-file-coding-system authors-coding-system)
a1506d29 608 (insert
f39caf44
KS		 609"Many people have contributed code included in the Free Software
610Foundation's distribution of GNU Emacs. To show our appreciation for
611their public spirit, we list here in alphabetical order a condensed
612list of their contributions.\n")
613 (let (authors-author-list a)
614 (maphash #'authors-add-to-author-list table)
a1506d29 615 (setq authors-author-list
f39caf44
KS		 616 (sort authors-author-list
617 (lambda (a b) (string-lessp (car a) (car b)))))
618 (dolist (a authors-author-list)
619 (let ((author (car a))
620 (wrote (nth 1 a))
621 (changed (nth 2 a))
622 file)
623 (insert "\n" author ": ")
624 (when wrote
625 (insert "wrote")
626 (dolist (file wrote)
627 (if (> (+ (current-column) (length file)) 72)
628 (insert "\n "))
629 (insert " " file))
630 (insert "\n"))
631 (when changed
632 (if wrote
633 (insert "and "))
634 (insert "changed")
635 (dolist (file changed)
636 (if (> (+ (current-column) (length file)) 72)
637 (insert "\n "))
638 (insert " " file))
639 (insert "\n")))))
a1506d29 640 (insert "\nLocal" " Variables:\ncoding: "
f39caf44
KS		 641 (symbol-name authors-coding-system) "\nEnd:\n")
642 (message "Generating buffer %s... done" buffer-name)
d5ab63b2 643 (unless noninteractive
f39caf44
KS		 644 (when authors-invalid-file-names
645 (with-current-buffer (get-buffer-create "*Authors Errors*")
646 (erase-buffer)
647 (set-buffer-file-coding-system authors-coding-system)
648 (insert "Unrecognized file entries found:\n\n")
0c8b414f
JB		 649 (mapc (lambda (f) (if (not (string-match "^[A-Za-z]+$" f)) (insert f "\n")))
650 (sort authors-invalid-file-names 'string-lessp))
f39caf44
KS		 651 (goto-char (point-min))
652 (compilation-mode)
653 (message "Errors were found. See buffer %s" (buffer-name))))
d5ab63b2
GM		 654 (pop-to-buffer buffer-name))))
655
656
d5ab63b2
GM		 657(defun batch-update-authors ()
658 "Produce an AUTHORS file.
659Call this function in batch mode with two command line arguments FILE
660and ROOT. FILE is the file to write, ROOT is the root directory of
661the Emacs source tree, from which to build the file."
662 (unless noninteractive
663 (error "`batch-update-authors' is to be used only with -batch"))
664 (when (/= (length command-line-args-left) 2)
665 (error "Call `batch-update-authors' with the name of the file to write"))
666 (let* ((file (pop command-line-args-left))
667 (root (pop command-line-args-left)))
668 (authors root)
669 (write-file file)))
3215096c 670
c420eb36
GM		 671(provide 'authors)
672
cbee283d 673;; arch-tag: 659d5900-5ff2-43b0-954c-a315cc1e4dc1
55535639 674;;; authors.el ends here
Unnamed repository; edit this file 'description' to name the repository.