;;; authors.el --- utility for maintaining Emacs' AUTHORS file -*-coding: iso-2022-7bit;-*-
-;; Copyright (C) 2000 Free Software Foundation, Inc.
+;; Copyright (C) 2000, 2003 Free Software Foundation, Inc.
;; Author: Gerd Moellmann <gerd@gnu.org>
-;; Maintainer: FSF
+;; Maintainer: Kim F. Storm <storm@cua.dk>
;; Keywords: maint
;; This file is part of GNU Emacs.
;;; Code:
+(defvar authors-coding-system 'iso-2022-7bit
+ "Coding system used in the AUTHORS file.")
+
(defconst authors-many-files 20
"Maximum number of files for which to print individual information.
-If an author has modified more files, only a single entry is
-printed telling how many files he changed, instead of listing each
-file individually.")
+If an author has modified more files, only the names of the most
+frequently modified files are printed and a count of the additional
+files.")
(defconst authors-aliases
- '(("eliz" . "Eli Zaretskii")
- ("Richard Stallman" . "Richard M. Stallman")
- ("Richard M. Stallman,,," . "Richard M. Stallman")
- ("rms@gnu.org" . "Richard M. Stallman")
- ("NIIBE Yutaka" . "Yutaka NIIBE")
- ("(saw@cebaf.gov)" . "Stephen A. Wood")
- ("(pmr@legacy.pajato.com)" . "Paul Reilly")
- ("(Eric Youngdale at youngdale@v6550c.nrl.navy.mil)" . "Eric Youngdale")
- ("<Daniel.Pfeiffer@Informatik.START.db.de>" . "Daniel Pfeiffer")
- ("<Daniel.Pfeiffer@Informatik.START.dbp.de>" . "Daniel Pfeiffer")
- ("(afs@hplb.hpl.hp.com)" . "ignore")
- ("<Use-Author-Address-Header@\\[127.1\\]>" . "ignore")
- ("Code Extracted" . "ignore")
- ("Fsf" . "ignore")
- ("David M. Koppelman, Koppel@Ee.Lsu.Edu" . "David M. Koppelman")
- ("jka@ece.cmu.edu" . "Jay K. Adams")
- ("Per Abhiddenware; you can redistribute it and/or modify" . "Per Abrahamsen")
- ("Andrw Innes" . "Andrew Innes")
- ("Barry Warsaw" . "Barry A. Warsaw")
- ("Barry A. Warsaw, Century Computing, Inc." . "Barry A. Warsaw")
- ("Barry A. Warsaw, ITB" . "Barry A. Warsaw")
- ("Ken'ichi Handa" . "Kenichi Handa")
- ("Bob Chassell" . "Robert J. Chassell")
- ("SL Baur" . "Steven L. Baur")
- ("Steven L Baur" . "Steven L. Baur")
- ("eggert" . "Paul Eggert")
- ("voelker" . "Geoff Voelker")
- ("rms" . "Richard M. Stallman")
- ("Edward M Reingold" . "Edward M. Reingold")
- ("Eric Ludlam" . "Eric M. Ludlam")
- ("Eric Raymond" . "Eric S. Raymond")
- ("Francois Pinard" . "Fran\e,Ag\e(Bois Pinard")
- ("Fred Pierresteguy" . "Frederic Pierresteguy")
- ("Hallvard B Furuseth" . "Hallvard B. Furuseth")
- ("ISO-2022-JP" . "ignore")
- ("Jens-Ulrik Petersen" . "Jens-Ulrik Holger Petersen")
- ("Christoph.Wedler@sap.com" . "Christoph Wedler")
- ("Jonathan Kamens" . "Jonathan I. Kamens")
- ("Kim Storm" . "Kim F. Storm")
- ("Marcus Daniels" . "Marcus G. Daniels")
- ("Michael I Bushnell" . "Michael I. Bushnell")
- ("Michael I. Bushnell, P/Bsg" . "Michael I. Bushnell")
- ("Reingold Edward M" . "Edward M. Reingold")
- ("Roland B Roberts" . "Roland B. Roberts")
- ("Sam Shteingold" . "Sam Steingold")
- ("W{\L}Odek Bzyl" . "Wlodzimierz Bzyl")
- ("Kenneth Manheimer" . "Ken Manheimer")
- ("Kenichi HANDA" . "Kenichi Handa")
- ("Jay Adams" . "Jay R. Adams")
- ("Joe Arceneaux" . "Joseph Arceneaux")
- ("K. Berry" . "Karl Berry")
- ("Michael Ernst" . "Michael D. Ernst")
- ("Dave Gillespie" . "David Gillespie")
- ("Shane Hartman" . "K. Shane Hartman")
- ("Francesco Potorti`" . "Francesco Potorti")
- ("Roland Roberts" . "Roland B. Roberts")
- ("David Smith" . "David M. Smith")
- ("Jan Djarv" . "Jan Dj\e,Ad\e(Brv")
- ("Jan D." . "Jan Dj\e,Ad\e(Brv")
+ '(
+ ("Andrew Innes" "Andrw Innes")
+ ("Barry A. Warsaw" "Barry A. Warsaw, Century Computing, Inc."
+ "Barry A. Warsaw, ITB" "Barry Warsaw")
+ ("Bj\e,Av\e(Brn Torkelsson" "Bjorn Torkelsson")
+ ("Brian Fox" "Brian J. Fox")
+ ("Christoph Wedler" "Christoph.Wedler@sap.com")
+ ("Daniel Pfeiffer" "<Daniel.Pfeiffer@Informatik.START.db.de>"
+ "<Daniel.Pfeiffer@Informatik.START.dbp.de>")
+ ("David Gillespie" "Dave Gillespie")
+ ("David K\e,Ae\e(Bgedal" "David K..edal")
+ ("David M. Koppelman" "David M. Koppelman, Koppel@Ee.Lsu.Edu")
+ ("David M. Smith" "David Smith")
+ ("Edward M. Reingold" "Ed Reingold" "Edward M Reingold"
+ "Reingold Edward M")
+ ("Eli Zaretskii" "eliz")
+ ("Eric M. Ludlam" "Eric Ludlam")
+ ("Eric S. Raymond" "Eric Raymond")
+ ("Eric Youngdale" "(Eric Youngdale at youngdale@v6550c.nrl.navy.mil)")
+ ("Fran\e,Ag\e(Bois Pinard" "Francois Pinard")
+ ("Francesco Potorti" "Francesco Potorti`")
+ ("Frederic Pierresteguy" "Fred Pierresteguy")
+ ("Geoff Voelker" "voelker")
+ ("Hallvard B. Furuseth" "Hallvard B Furuseth")
+ (nil "(afs@hplb.hpl.hp.com)")
+ (nil "<Use-Author-Address-Header@\\[127.1\\]>")
+ (nil "Code Extracted")
+ (nil "Fsf")
+ (nil "ISO-2022-JP")
+ ("Jaeyoun Chung" "Jae-youn Chung" "Jae-you Chung" "Chung Jae-youn")
+ ("Jan Dj\e,Ad\e(Brv" "Jan D." "Jan Djarv")
+ ("Jay K. Adams" "jka@ece.cmu.edu")
+ ("Jay R. Adams" "Jay Adams")
+ ("Jens-Ulrik Holger Petersen" "Jens-Ulrik Petersen")
+ ("Jonathan I. Kamens" "Jonathan Kamens")
+ ("Joseph Arceneaux" "Joe Arceneaux")
+ ("K. Shane Hartman" "Shane Hartman")
+ ("Kai Gro\e,A_\e(Bjohann" "Kai Grossjohann" "Kai Gro\e,b_\e(Bjohann"
+ "Kai.Grossjohann@Cs.Uni-Dortmund.De")
+ ("Karl Berry" "K. Berry")
+ ("Ken Manheimer" "Kenneth Manheimer")
+ ("Kenichi Handa" "Ken'ichi Handa" "Kenichi HANDA")
+ ("Kim F. Storm" "Kim Storm")
+ ("Marcus G. Daniels" "Marcus Daniels")
+ ("Michael D. Ernst" "Michael Ernst")
+ ("Michael I. Bushnell" "Michael I Bushnell" "Michael I. Bushnell, P/Bsg")
+ ("Paul Eggert" "eggert")
+ ("Paul Reilly" "(pmr@legacy.pajato.com)")
+ ("Pavel Jan\e,Bm\e(Bk" "Pavel Jan\e,Am\e(Bk Ml.")
+ ("Per Abrahamsen" "Per Abhiddenware")
+ ("Peter S. Galbraith" "Peter S Galbraith")
+ ("Richard M. Stallman" "Richard M. Stallman,,," "Richard Stallman"
+ "rms" "rms@gnu.org")
+ ("Robert J. Chassell" "Bob Chassell")
+ ("Roland B. Roberts" "Roland B Roberts" "Roland Roberts")
+ ("Rui-Tao Dong" "Rui-Tao Dong ~{6-Hpln~}")
+ ("Sam Steingold" "Sam Shteingold")
+ ("Stephen A. Wood" "(saw@cebaf.gov)")
+ ("Steven L. Baur" "SL Baur" "Steven L Baur")
+ ("Takaaki Ota" "Tak Ota")
+ ("Torbj\e,Av\e(Brn Axelsson" "Torbjvrn Axelsson")
+ ("Torbj\e,Av\e(Brn Einarsson" "Torbj.*rn Einarsson")
+ ("Toru Tomabechi" "Toru Tomabechi,")
+ ("Vincent Del Vecchio" "Vince Del Vecchio")
+ ("Wlodzimierz Bzyl" "W.*dek Bzyl")
+ ("Yutaka NIIBE" "NIIBE Yutaka")
)
"Alist of author aliases.
-Each entry is of the form (REGEXP . ALIAS). If an author's name
-matches REGEXP, use ALIAS instead. The special alias \"ignore\" means
-ignore that author.")
+Each entry is of the form (REALNAME REGEXP...). If an author's name
+matches one of the REGEXPs, use REALNAME instead.
+If REALNAME is nil, ignore that author.")
(defvar authors-public-domain-files
(defconst authors-fixed-entries
- '(("Joseph Arceneaux" :wrote "xrdb.c")
+ '(("Richard M. Stallman" :wrote "[The original GNU emacs and numerous files]")
+ ("Joseph Arceneaux" :wrote "xrdb.c")
("Blitz Product Development Corporation" :wrote "ispell.el")
("Frank Bresz" :wrote "diff.el")
("David M. Brown" :wrote "array.el")
"Actions taken from the original, manually (un)maintained AUTHORS file.")
+(defconst authors-valid-file-names
+ '("aclocal.m4"
+ "makedist.bat")
+ "File names which are valid, but no longer exists (or cannot be
+found) in the repository.")
+
+(defconst authors-renamed-files-alist
+ '(("nt.c" . "w32.c") ("nt.h" . "w32.h")
+ ("ntheap.c" . "w32heap.c") ("ntheap.h" . "w32heap.h")
+ ("ntinevt.c" . "w32inevt.c") ("ntinevt.h" . "w32inevt.h")
+ ("ntproc.c" . "w32proc.c")
+ ("w32console.c" . "w32term.c")
+ ("unexnt.c" . "unexw32.c")
+ ("s/windowsnt.h" . "s/ms-w32.h")
+ ("config.emacs" . "configure")
+ ("GETTING.GNU.SOFTWARE" . "FTP")
+ )
+ "Alist of files which have been renamed during their lifetime.
+Elements are (OLDNAME . NEWNAME).")
+
+(defconst authors-renamed-files-regexps
+ '(("^m/m-\\(.*\\.h\\)$" . "m/\\1")
+ ("^m-\\(.*\\.h\\)$" . "\\1")
+ ("^s/s-\\(.*\\.h\\)$" . "s/\\1")
+ ("^s-\\(.*\\.h\\)$" . "\\1")
+ ("^s/[-.a-zA-Z0-9_]+\\.h$" . t)
+ ("\\(.*\\)\\.cmd$" . "\\1.bat")
+ ("\\.bat$" . t)
+ ("\\.[ch]$" . t)
+ ("\\.el$" . t)
+ ("\\.ps$" . t)
+ ("\\.texi?$" . t)
+ ("\\.texinfo$" . t)
+ ("\\.xml?$" . t)
+ ("\\.x[pb]m$" . t)
+ ("\\.[xp]bm$" . t)
+ ("^paths\\." . t)
+ ("^install\\." . t)
+ )
+ "List regexps and rewriting rules for renamed files.
+Elements are (REGEXP . REPLACE). If REPLACE is a string, the file
+name matching REGEXP is replaced by REPLACE using `replace-string'.
+Otherwise, the file name is accepted as is.")
+
+(defvar authors-checked-files-alist)
+(defvar authors-invalid-file-names)
+
+(defun authors-canonical-file-name (file log-file pos author)
+ "Return canonical file name for FILE found in LOG-FILE at POS for AUTHOR.
+Checks whether FILE is a valid (existing) file name, has been renamed,
+or is on the list of removed files. Returns the non-diretory part of
+the file name."
+ (let ((entry (assoc file authors-checked-files-alist))
+ relname
+ valid)
+ (if entry
+ (cdr entry)
+ (setq relname (file-name-nondirectory file))
+ (if (or (member relname authors-valid-file-names)
+ (file-exists-p file)
+ (file-exists-p relname)
+ (file-exists-p (concat "etc/" relname)))
+ (setq valid relname)
+ (setq valid (assoc file authors-renamed-files-alist))
+ (if valid
+ (setq valid (cdr valid))
+ (let ((rules authors-renamed-files-regexps))
+ (while rules
+ (if (string-match (car (car rules)) file)
+ (setq valid (if (stringp (cdr (car rules)))
+ (file-name-nondirectory
+ (replace-match (cdr (car rules)) t nil file))
+ relname)
+ rules nil))
+ (setq rules (cdr rules))))))
+ (setq authors-checked-files-alist
+ (cons (cons file valid) authors-checked-files-alist))
+ (unless valid
+ (setq authors-invalid-file-names
+ (cons (format "%s:%d: unrecognized `%s' for %s"
+ log-file
+ (1+ (count-lines (point-min) pos))
+ file author)
+ authors-invalid-file-names)))
+ valid)))
+
(defun authors-add-fixed-entries (table)
"Add actions from `authors-fixed-entries' to TABLE."
(dolist (entry authors-fixed-entries)
(unless (or (authors-obsolete-file-p file)
(equal author ""))
(let* ((value (gethash author table))
- (entry (assoc file value)))
+ (entry (assoc file value))
+ slot)
(if (null entry)
- (puthash author (cons (list file action) value) table)
- (unless (memq action entry)
- (nconc entry (list action)))))))
+ (puthash author (cons (list file (cons action 1)) value) table)
+ (if (setq slot (assoc action (cdr entry)))
+ (setcdr slot (1+ (cdr slot)))
+ (nconc entry (list (cons action 1))))))))
(defun authors-process-lines (program &rest args)
"Return a canonicalized form of AUTHOR, an author name.
If AUTHOR has an alias, use that. Remove email addresses. Capitalize
words in the author's name."
- (let ((aliases authors-aliases))
+ (let* ((aliases authors-aliases)
+ regexps realname)
(while aliases
- (when (string-match (car (car aliases)) author)
- (setq author (cdr (car aliases))
- aliases nil))
- (setq aliases (cdr aliases))))
- (setq author (replace-regexp-in-string "[ \t]*[(<].*$" "" author))
- (setq author (replace-regexp-in-string "^[ \t]+" "" author))
- (setq author (replace-regexp-in-string "[ \t]+$" "" author))
- (capitalize author))
-
-
-(defun authors-scan-change-log (file table)
- "Scan change log FILE for author information.
+ (setq realname (car (car aliases))
+ regexps (cdr (car aliases))
+ aliases (cdr aliases))
+ (while regexps
+ (if (string-match (car regexps) author)
+ (setq author realname
+ regexps nil
+ aliases nil)
+ (setq regexps (cdr regexps))))))
+ (when author
+ (setq author (replace-regexp-in-string "[ \t]*[(<].*$" "" author))
+ (setq author (replace-regexp-in-string "^[ \t]+" "" author))
+ (setq author (replace-regexp-in-string "[ \t]+$" "" author))
+ (capitalize author)))
+
+
+(defun authors-scan-change-log (log-file table)
+ "Scan change log LOG-FILE for author information.
For each change mentioned in the log, add an entry to hash table TABLE
under the author's canonical name.
Keys of TABLE are author names. Values are alists of entries (FILE
-ACTION...). FILE is one file the author worked on. The rest of the
-entry is a list of keyword symbols describing what he did with the
-file.
+\(ACTION . COUNT) ...). FILE is one file the author worked on. The
+rest of the entry is a list of keyword symbols describing what he did
+with the file and the number of each action.
:wrote means the author wrote the file
-:changed means he changed the file."
+:changed means he changed the file COUNT times."
(let* ((enable-local-variables t)
(enable-local-eval t)
- (existing-buffer (get-file-buffer file))
- (buffer (find-file-noselect file))
- author)
+ (existing-buffer (get-file-buffer log-file))
+ (buffer (find-file-noselect log-file))
+ author file pos)
(save-excursion
(set-buffer buffer)
(save-restriction
(goto-char (point-min))
(while (re-search-forward "^[0-9]\\|^[ \t]+\\* " nil t)
(beginning-of-line)
+ (setq pos (point))
(cond ((looking-at "^[0-9]+-[0-9]+-[0-9]+")
(skip-chars-forward " \t+:0-9-")
(setq author (buffer-substring-no-properties
(setq line (replace-regexp-in-string "[[(<{].*$" "" line))
(setq line (replace-regexp-in-string "," "" line))
(dolist (file (split-string line))
- (setq file (file-name-nondirectory file))
- ;(message "%s changed %s" author file)
- (authors-add author file :changed table)))
+ (when (setq file (authors-canonical-file-name file log-file pos author))
+ ;;(message "%s changed %s" author file)
+ (authors-add author file :changed table))))
(forward-line 1)))))))
(unless existing-buffer
(kill-buffer buffer))))
(setq list (cdr list)))
public-domain-p))
-
-(defun authors-print (author changes)
- "Insert information about AUTHOR's work on Emacs into the current buffer.
-CHANGES is an alist of entries (FILE ACTION...), as produced by
-`authors-scan-change-log'."
- (unless (equal author "Ignore")
- (let ((nchanged 0))
- (dolist (change changes)
- (let ((actions (cdr change))
- (file (car change)))
- (if (memq :wrote actions)
- (progn
- (insert author " (wrote) " file)
- (when (authors-public-domain-p file)
- (insert " (public domain)"))
- (insert "\n"))
- (setq nchanged (1+ nchanged)))))
- (if (> nchanged authors-many-files)
- (insert author " (changed) [more than "
- (int-to-string authors-many-files) " files]\n")
+(defvar authors-author-list)
+
+(defun authors-add-to-author-list (author changes)
+ "Insert information about AUTHOR's work on Emacs into `authors-author-list'.
+CHANGES is an alist of entries (FILE (ACTION . COUNT) ...), as produced by
+`authors-scan-change-log'.
+The element added to `authors-author-list' is (AUTHOR WROTE CHANGED), where
+WROTE and CHANGED are lists of the files written and changed by AUTHOR."
+ (when author
+ (let ((nchanged 0)
+ wrote-list
+ changed-list)
(dolist (change changes)
(let ((actions (cdr change))
- (file (car change)))
- (unless (memq :wrote actions)
- (insert author " (changed) " file "\n"))))))))
-
+ (file (car change))
+ slot)
+ (if (assq :wrote actions)
+ (setq wrote-list
+ (cons
+ (if (authors-public-domain-p file)
+ (concat file " (public domain)")
+ file)
+ wrote-list))
+ (setq changed-list
+ (cons (cons file (cdr (assq :changed actions)))
+ changed-list)))))
+ (if wrote-list
+ (setq wrote-list (sort wrote-list 'string-lessp)))
+ (when changed-list
+ (setq changed-list (sort changed-list
+ (lambda (a b)
+ (if (= (cdr a) (cdr b))
+ (string-lessp (car a) (car b))
+ (> (cdr a) (cdr b))))))
+ (setq nchanged (length changed-list))
+ (setq changed-list (mapcar 'car changed-list)))
+ (if (> (- nchanged authors-many-files) 2)
+ (setcdr (nthcdr authors-many-files changed-list)
+ (list (format "and %d other files" (- nchanged authors-many-files)))))
+ (setq authors-author-list
+ (cons (list author wrote-list changed-list)
+ authors-author-list)))))
(defun authors (root)
"Extract author information from change logs and Lisp source files.
ROOT is the root directory under which to find the files. If called
-interactively, ROOT is read from the minibuffer. Result is a
-buffer *Authors* containing authorship information."
+interactively, ROOT is read from the minibuffer.
+Result is a buffer *Authors* containing authorship information, and a
+buffer *Authors Errors* containing references to unknown files."
(interactive "DEmacs source directory: ")
(setq root (expand-file-name root))
(let ((logs (authors-process-lines "find" root "-name" "ChangeLog*"))
(table (make-hash-table :test 'equal))
- (buffer-name "*Authors*"))
+ (buffer-name "*Authors*")
+ authors-checked-files-alist
+ authors-invalid-file-names)
(authors-add-fixed-entries table)
(unless (file-exists-p (expand-file-name "src/emacs.c" root))
(error "Not the root directory of Emacs: %s" root))
(dolist (file els)
(message "Scanning %s..." file)
(authors-scan-el file table)))
+ (message "Generating buffer %s..." buffer-name)
(set-buffer (get-buffer-create buffer-name))
(erase-buffer)
- (set-buffer-file-coding-system 'iso-2022-7bit)
- (maphash #'authors-print table)
- (sort-lines nil (point-min) (point-max))
- (insert "\nLocal" " Variables:\ncoding: iso-2022-7bit\nEnd:\n")
+ (set-buffer-file-coding-system authors-coding-system)
+ (insert
+"Many people have contributed code included in the Free Software
+Foundation's distribution of GNU Emacs. To show our appreciation for
+their public spirit, we list here in alphabetical order a condensed
+list of their contributions.\n")
+ (let (authors-author-list a)
+ (maphash #'authors-add-to-author-list table)
+ (setq authors-author-list
+ (sort authors-author-list
+ (lambda (a b) (string-lessp (car a) (car b)))))
+ (dolist (a authors-author-list)
+ (let ((author (car a))
+ (wrote (nth 1 a))
+ (changed (nth 2 a))
+ file)
+ (insert "\n" author ": ")
+ (when wrote
+ (insert "wrote")
+ (dolist (file wrote)
+ (if (> (+ (current-column) (length file)) 72)
+ (insert "\n "))
+ (insert " " file))
+ (insert "\n"))
+ (when changed
+ (if wrote
+ (insert "and "))
+ (insert "changed")
+ (dolist (file changed)
+ (if (> (+ (current-column) (length file)) 72)
+ (insert "\n "))
+ (insert " " file))
+ (insert "\n")))))
+ (insert "\nLocal" " Variables:\ncoding: "
+ (symbol-name authors-coding-system) "\nEnd:\n")
+ (message "Generating buffer %s... done" buffer-name)
(unless noninteractive
+ (when authors-invalid-file-names
+ (with-current-buffer (get-buffer-create "*Authors Errors*")
+ (erase-buffer)
+ (set-buffer-file-coding-system authors-coding-system)
+ (insert "Unrecognized file entries found:\n\n")
+ (mapcar (lambda (f) (if (not (string-match "^[A-Za-z]+$" f)) (insert f "\n")))
+ (sort authors-invalid-file-names 'string-lessp))
+ (goto-char (point-min))
+ (compilation-mode)
+ (message "Errors were found. See buffer %s" (buffer-name))))
(pop-to-buffer buffer-name))))
projects / emacs.git / commitdiff