;;; admin.el --- utilities for Emacs administration
-;; Copyright (C) 2001-2011 Free Software Foundation, Inc.
+;; Copyright (C) 2001-2013 Free Software Foundation, Inc.
;; This file is part of GNU Emacs.
;;; Code:
+(defvar add-log-time-format) ; in add-log
+
(defun add-release-logs (root version)
"Add \"Version VERSION released.\" change log entries in ROOT.
Root must be the root of an Emacs source tree."
(set-version-in-file root "README" version
(rx (and "version" (1+ space)
(submatch (1+ (in "0-9."))))))
- (set-version-in-file root "configure.in" version
+ (set-version-in-file root "configure.ac" version
(rx (and "AC_INIT" (1+ (not (in ?,)))
?, (0+ space)
(submatch (1+ (in "0-9."))))))
(submatch (1+ (in "0-9."))))))
(set-version-in-file root "nt/config.nt" version
(rx (and bol "#" (0+ blank) "define" (1+ blank)
- "VERSION" (1+ blank)
+ "VERSION" (1+ blank) "\""
(submatch (1+ (in "0-9."))))))
(set-version-in-file root "msdos/sed2v2.inp" version
(rx (and bol "/^#undef " (1+ not-newline)
- "define VERSION" (1+ space)
+ "define VERSION" (1+ space) "\""
(submatch (1+ (in "0-9."))))))
(set-version-in-file root "nt/makefile.w32-in" version
(rx (and "VERSION" (0+ space) "=" (0+ space)
(set-version-in-file root "nt/emacsclient.rc" comma-space-version
(rx (and "\"ProductVersion\"" (0+ space) ?,
(0+ space) ?\" (submatch (1+ (in "0-9, ")))
- "\\0\""))))
- ;; nextstep.
- (set-version-in-file
- root "nextstep/Cocoa/Emacs.base/Contents/Info.plist"
- version (rx (and "CFBundleGetInfoString" (1+ anything) "Emacs" (1+ space)
- (submatch (1+ (in "0-9."))))))
- (set-version-in-file
- root "nextstep/Cocoa/Emacs.base/Contents/Info.plist"
- version (rx (and "CFBundleShortVersionString" (1+ not-newline) ?\n
- (0+ not-newline) "<string>" (0+ space)
- (submatch (1+ (in "0-9."))))))
- (set-version-in-file
- root "nextstep/Cocoa/Emacs.base/Contents/Resources/English.lproj/InfoPlist.strings"
- version (rx (and "CFBundleShortVersionString" (0+ space) ?= (0+ space)
- ?\" (0+ space) "Version" (1+ space)
- (submatch (1+ (in "0-9."))))))
- (set-version-in-file
- root "nextstep/Cocoa/Emacs.base/Contents/Resources/English.lproj/InfoPlist.strings"
- version (rx (and "CFBundleGetInfoString" (0+ space) ?= (0+ space)
- ?\" (0+ space) "Emacs version" (1+ space)
- (submatch (1+ (in "0-9."))))))
- (set-version-in-file
- root "nextstep/GNUstep/Emacs.base/Resources/Info-gnustep.plist"
- version (rx (and "ApplicationRelease" (0+ space) ?= (0+ space)
- ?\" (0+ space) (submatch (1+ (in "0-9."))))))
- (set-version-in-file
- root "nextstep/GNUstep/Emacs.base/Resources/Info-gnustep.plist"
- version (rx (and "FullVersionID" (0+ space) ?= (0+ space)
- ?\" (0+ space) "Emacs" (1+ space)
- (submatch (1+ (in "0-9."))))))
- (set-version-in-file
- root "nextstep/GNUstep/Emacs.base/Resources/Emacs.desktop"
- version (rx (and "Version=" (submatch (1+ (in "0-9.")))))))
+ "\\0\"")))
+ ;; Major version only.
+ (when (string-match "\\([0-9]\\{2,\\}\\)" version)
+ (setq version (match-string 1 version))
+ (set-version-in-file root "src/msdos.c" version
+ (rx (and "Vwindow_system_version" (1+ not-newline)
+ ?\( (submatch (1+ (in "0-9"))) ?\))))
+ (set-version-in-file root "etc/refcards/ru-refcard.tex" version
+ "\\\\newcommand{\\\\versionemacs}\\[0\\]\
+{\\([0-9]\\{2,\\}\\)}.+%.+version of Emacs")
+ (set-version-in-file root "etc/refcards/emacsver.tex" version
+ "\\\\def\\\\versionemacs\
+{\\([0-9]\\{2,\\}\\)}.+%.+version of Emacs"))))
+
;; Note this makes some assumptions about form of short copyright.
(defun set-copyright (root copyright)
(format-time-string "%Y")))))
(unless (file-exists-p (expand-file-name "src/emacs.c" root))
(error "%s doesn't seem to be the root of an Emacs source tree" root))
- (set-version-in-file root "src/emacs.c" copyright
- (rx (and "emacs_copyright" (0+ (not (in ?\")))
- ?\" (submatch (1+ (not (in ?\")))) ?\")))
- (set-version-in-file root "lib-src/ebrowse.c" copyright
- (rx (and "emacs_copyright" (0+ (not (in ?\")))
- ?\" (submatch (1+ (not (in ?\")))) ?\")))
- (set-version-in-file root "lib-src/etags.c" copyright
- (rx (and "emacs_copyright" (0+ (not (in ?\")))
+ (set-version-in-file root "configure.ac" copyright
+ (rx (and bol "copyright" (0+ (not (in ?\")))
?\" (submatch (1+ (not (in ?\")))) ?\")))
+ (set-version-in-file root "msdos/sed2v2.inp" copyright
+ (rx (and bol "/^#undef " (1+ not-newline)
+ "define COPYRIGHT" (1+ space)
+ ?\" (submatch (1+ (not (in ?\")))) ?\")))
+ (set-version-in-file root "nt/config.nt" copyright
+ (rx (and bol "#" (0+ blank) "define" (1+ blank)
+ "COPYRIGHT" (1+ blank)
+ ?\" (submatch (1+ (not (in ?\")))) ?\")))
(set-version-in-file root "lib-src/rcs2log" copyright
(rx (and "Copyright" (0+ space) ?= (0+ space)
?\' (submatch (1+ nonl)))))
- ;; This one is a nuisance, as it needs to be split over two lines.
- (string-match "\\(.*[0-9]\\{4\\} *\\)\\(.*\\)" copyright)
- ;; nextstep.
- (set-version-in-file
- root "nextstep/Cocoa/Emacs.base/Contents/Info.plist"
- copyright (rx (and "CFBundleGetInfoString" (1+ anything) "Emacs" (1+ space)
- (1+ (in "0-9.")) (1+ space)
- (submatch (1+ (not (in ?\<)))))))
- (set-version-in-file
- root "nextstep/Cocoa/Emacs.base/Contents/Resources/English.lproj/InfoPlist.strings"
- copyright (rx (and "NSHumanReadableCopyright" (0+ space) ?\= (0+ space)
- ?\" (submatch (1+ (not (in ?\")))))))
- (set-version-in-file
- root "nextstep/GNUstep/Emacs.base/Resources/Info-gnustep.plist"
- copyright (rx (and "Copyright" (0+ space) ?\= (0+ space)
- ?\" (submatch (1+ (not (in ?\")))))))
(when (string-match "\\([0-9]\\{4\\}\\)" copyright)
(setq copyright (match-string 1 copyright))
- (dolist (file (directory-files (expand-file-name "etc/refcards" root)
- t "\\.tex\\'"))
- (unless (string-match "gnus-refcard\\.tex" file)
- (set-version-in-file
- root file copyright
- (concat (if (string-match "ru-refcard\\.tex" file)
- "\\\\newcommand{\\\\cyear}\\[0\\]{"
- "\\\\def\\\\year{")
- "\\([0-9]\\{4\\}\\)}.+%.+copyright year"))))))
+ (set-version-in-file root "etc/refcards/ru-refcard.tex" copyright
+ "\\\\newcommand{\\\\cyear}\\[0\\]\
+{\\([0-9]\\{4\\}\\)}.+%.+copyright year")
+ (set-version-in-file root "etc/refcards/emacsver.tex" copyright
+ "\\\\def\\\\year\
+{\\([0-9]\\{4\\}\\)}.+%.+copyright year")))
;;; Various bits of magic for generating the web manuals
(manual-txt texi (expand-file-name "emacs.txt" txt-dir))
(manual-pdf texi (expand-file-name "emacs.pdf" dest))
(manual-dvi texi (expand-file-name "emacs.dvi" dvi-dir)
- (expand-file-name "emacs.ps" ps-dir)))
+ (expand-file-name "emacs.ps" ps-dir)))
;; Lisp manual
(let ((texi (expand-file-name "doc/lispref/elisp.texi" root)))
(manual-html-node texi (expand-file-name "elisp" html-node-dir))
(manual-txt texi (expand-file-name "elisp.txt" txt-dir))
(manual-pdf texi (expand-file-name "elisp.pdf" dest))
(manual-dvi texi (expand-file-name "elisp.dvi" dvi-dir)
- (expand-file-name "elisp.ps" ps-dir)))
+ (expand-file-name "elisp.ps" ps-dir)))
+ ;; Misc manuals
+ (let ((manuals '("ada-mode" "auth" "autotype" "calc" "cc-mode"
+ "cl" "dbus" "dired-x" "ebrowse" "ede" "ediff"
+ "edt" "eieio" "emacs-mime" "epa" "erc" "ert"
+ "eshell" "eudc" "faq" "flymake" "forms"
+ "gnus" "emacs-gnutls" "idlwave" "info"
+ "mairix-el" "message" "mh-e" "newsticker"
+ "nxml-mode" "org" "pcl-cvs" "pgg" "rcirc"
+ "remember" "reftex" "sasl" "sc" "semantic"
+ "ses" "sieve" "smtpmail" "speedbar" "tramp"
+ "url" "vip" "viper" "widget" "woman")))
+ (dolist (manual manuals)
+ (manual-misc-html manual root html-node-dir html-mono-dir)))
(message "Manuals created in %s" dest)))
(defconst manual-doctype-string
(defconst manual-style-string "<style type=\"text/css\">
@import url('/style.css');\n</style>\n")
+(defun manual-misc-html (name root html-node-dir html-mono-dir)
+ (let ((texi (expand-file-name (format "doc/misc/%s.texi" name) root)))
+ (manual-html-node texi (expand-file-name name html-node-dir))
+ (manual-html-mono texi (expand-file-name (concat name ".html")
+ html-mono-dir))))
+
(defun manual-html-mono (texi-file dest)
"Run Makeinfo on TEXI-FILE, emitting mono HTML output to DEST.
This function also edits the HTML files so that they validate as
(let (copyright-text)
(manual-html-fix-index-1)
;; Move copyright notice to the end.
- (re-search-forward "[ \t]*<p>Copyright ©")
- (setq opoint (match-beginning 0))
- (re-search-forward "</blockquote>")
- (setq copyright-text (buffer-substring opoint (point)))
- (delete-region opoint (point))
+ (when (re-search-forward "[ \t]*<p>Copyright ©" nil t)
+ (setq opoint (match-beginning 0))
+ (re-search-forward "</blockquote>")
+ (setq copyright-text (buffer-substring opoint (point)))
+ (delete-region opoint (point)))
(manual-html-fix-index-2)
- (insert copyright-text "\n</div>\n"))
+ (if copyright-text
+ (insert copyright-text))
+ (insert "\n</div>\n"))
;; For normal nodes, give the header div a blue bg.
(manual-html-fix-node-div))
(save-buffer))))))
(defun manual-dvi (texi-file dest ps-dest)
"Run texi2dvi on TEXI-FILE, emitting dvi output to DEST.
-Also generate postscript output in PS-DEST."
+Also generate PostScript output in PS-DEST."
(call-process "texi2dvi" nil nil nil texi-file "-o" dest)
(call-process "dvips" nil nil nil dest "-o" ps-dest)
(call-process "gzip" nil nil nil dest)
(defun manual-html-fix-index-1 ()
(let (opoint)
- (re-search-forward "<body>\n\\(<h1 class=\"settitle\\)")
- (setq opoint (match-beginning 1))
- (search-forward "<h2 class=\"unnumbered")
+ (re-search-forward "<body>\n")
+ (setq opoint (match-end 0))
+ (search-forward "<h2 class=\"")
(goto-char (match-beginning 0))
(delete-region opoint (point))
(insert "<div id=\"content\" class=\"inner\">\n\n")))
"Replace the index list in the current buffer with a HTML table."
(let (done open-td tag desc)
;; Convert the list that Makeinfo made into a table.
- (search-forward "<ul class=\"menu\">")
+ (or (search-forward "<ul class=\"menu\">" nil t)
+ (search-forward "<ul>"))
(replace-match "<table style=\"float:left\" width=\"100%\">")
(forward-line 1)
(while (not done)
(replace-match " </td></tr></table>\n
<h3>Detailed Node Listing</h3>\n\n" t t)
(search-forward "<p>")
- (search-forward "<p>")
+ (search-forward "<p>" nil t)
(goto-char (match-beginning 0))
(skip-chars-backward "\n ")
(setq open-td nil)
(setq open-td nil))
(insert " <tr>
<th colspan=\"2\" align=\"left\" style=\"text-align:left\">")
- (re-search-forward "</p>[ \t\n]*<ul class=\"menu\">")
- (replace-match " </th></tr>"))
+ (if (re-search-forward "</p>[ \t\n]*<ul class=\"menu\">" nil t)
+ (replace-match " </th></tr>")))
((looking-at "[ \t]*</ul>[ \t]*$")
(replace-match
(if open-td
(setq done t))
(t
(if (eobp)
- (error "Parse error in %s" f))
+ (error "Parse error in %s" f)) ; f is bound in manual-html-node
(unless open-td
(setq done t))))
(forward-line 1))))
+\f
+;; Stuff to check new defcustoms got :version tags.
+;; Adapted from check-declare.el.
+
+(defun cusver-find-files (root &optional old)
+ "Find .el files beneath directory ROOT that contain defcustoms.
+If optional OLD is non-nil, also include defvars."
+ (process-lines find-program root
+ "-name" "*.el"
+ "-exec" grep-program
+ "-l" "-E" (format "^[ \\t]*\\(def%s"
+ (if old "(custom|var)"
+ "custom"
+ ))
+ "{}" "+"))
+
+(defvar cusver-new-version (format "%s.%s" emacs-major-version
+ (1+ emacs-minor-version))
+ "Version number that new defcustoms should have.")
+
+(defun cusver-scan (file &optional old)
+ "Scan FILE for `defcustom' calls.
+Return a list with elements of the form (VAR . VER),
+This means that FILE contains a defcustom for variable VAR, with
+a :version tag having value VER (may be nil).
+If optional argument OLD is non-nil, also scan for defvars."
+ (let ((m (format "Scanning %s..." file))
+ (re (format "^[ \t]*\\((def%s\\)[ \t\n]"
+ (if old "\\(custom\\|var\\)" "\\(custom\\|group\\)")))
+ alist var ver form glist grp)
+ (message "%s" m)
+ (with-temp-buffer
+ (insert-file-contents file)
+ ;; FIXME we could theoretically be inside a string.
+ (while (re-search-forward re nil t)
+ (goto-char (match-beginning 1))
+ (if (and (setq form (ignore-errors (read (current-buffer))))
+ (setq var (car-safe (cdr-safe form)))
+ ;; Exclude macros, eg (defcustom ,varname ...).
+ (symbolp var))
+ (progn
+ (setq ver (car (cdr-safe (memq :version form))))
+ (if (equal "group" (match-string 2))
+ ;; Group :version could be old.
+ (if (equal ver cusver-new-version)
+ (setq glist (cons (cons var ver) glist)))
+ ;; If it specifies a group and the whole group has a
+ ;; version. use that.
+ (unless ver
+ (setq grp (car (cdr-safe (memq :group form))))
+ (and grp
+ (setq grp (car (cdr-safe grp))) ; (quote foo) -> foo
+ (setq ver (assq grp glist))))
+ (setq alist (cons (cons var ver) alist))))
+ (if form (message "Malformed defcustom: `%s'" form)))))
+ (message "%sdone" m)
+ alist))
+
+(defun cusver-scan-cus-start (file)
+ "Scan cus-start.el and return an alist with elements (VAR . VER)."
+ (if (file-readable-p file)
+ (with-temp-buffer
+ (insert-file-contents file)
+ (when (search-forward "(let ((all '(" nil t)
+ (backward-char 1)
+ (let (var ver alist)
+ (dolist (elem (ignore-errors (read (current-buffer))))
+ (when (symbolp (setq var (car-safe elem)))
+ (or (stringp (setq ver (nth 3 elem)))
+ (setq ver nil))
+ (setq alist (cons (cons var ver) alist))))
+ alist)))))
+
+(define-button-type 'cusver-xref 'action #'cusver-goto-xref)
+
+(defun cusver-goto-xref (button)
+ "Jump to a lisp file for the BUTTON at point."
+ (let ((file (button-get button 'file))
+ (var (button-get button 'var)))
+ (if (not (file-readable-p file))
+ (message "Cannot read `%s'" file)
+ (with-current-buffer (find-file-noselect file)
+ (goto-char (point-min))
+ (or (re-search-forward (format "^[ \t]*(defcustom[ \t]*%s" var) nil t)
+ (message "Unable to locate defcustom"))
+ (pop-to-buffer (current-buffer))))))
+
+;; You should probably at least do a grep over the old directory
+;; to check the results of this look sensible.
+;; TODO Check cus-start if something moved from C to Lisp.
+;; TODO Handle renamed things with aliases to the old names.
+(defun cusver-check (newdir olddir version)
+ "Check that defcustoms have :version tags where needed.
+NEWDIR is the current lisp/ directory, OLDDIR is that from the previous
+release. A defcustom that is only in NEWDIR should have a :version
+tag. We exclude cases where a defvar exists in OLDDIR, since
+just converting a defvar to a defcustom does not require a :version bump.
+
+Note that a :version tag should also be added if the value of a defcustom
+changes (in a non-trivial way). This function does not check for that."
+ (interactive (list (read-directory-name "New Lisp directory: ")
+ (read-directory-name "Old Lisp directory: ")
+ (number-to-string
+ (read-number "New version number: "
+ (string-to-number cusver-new-version)))))
+ (or (file-directory-p (setq newdir (expand-file-name newdir)))
+ (error "Directory `%s' not found" newdir))
+ (or (file-directory-p (setq olddir (expand-file-name olddir)))
+ (error "Directory `%s' not found" olddir))
+ (setq cusver-new-version version)
+ (let* ((newfiles (progn (message "Finding new files with defcustoms...")
+ (cusver-find-files newdir)))
+ (oldfiles (progn (message "Finding old files with defcustoms...")
+ (cusver-find-files olddir t)))
+ (newcus (progn (message "Reading new defcustoms...")
+ (mapcar
+ (lambda (file)
+ (cons file (cusver-scan file))) newfiles)))
+ oldcus result thisfile file)
+ (message "Reading old defcustoms...")
+ (dolist (file oldfiles)
+ (setq oldcus (append oldcus (cusver-scan file t))))
+ (setq oldcus (append oldcus (cusver-scan-cus-start
+ (expand-file-name "cus-start.el" olddir))))
+ ;; newcus has elements (FILE (VAR VER) ... ).
+ ;; oldcus just (VAR . VER).
+ (message "Checking for version tags...")
+ (dolist (new newcus)
+ (setq file (car new)
+ thisfile
+ (let (missing var)
+ (dolist (cons (cdr new))
+ (or (cdr cons)
+ (assq (setq var (car cons)) oldcus)
+ (push var missing)))
+ (if missing
+ (cons file missing))))
+ (if thisfile
+ (setq result (cons thisfile result))))
+ (message "Checking for version tags... done")
+ (if (not result)
+ (message "No missing :version tags")
+ (pop-to-buffer "*cusver*")
+ (erase-buffer)
+ (insert "These defcustoms might be missing :version tags:\n\n")
+ (dolist (elem result)
+ (let* ((str (file-relative-name (car elem) newdir))
+ (strlen (length str)))
+ (dolist (var (cdr elem))
+ (insert (format "%s: %s\n" str var))
+ (make-text-button (+ (line-beginning-position 0) strlen 2)
+ (line-end-position 0)
+ 'file (car elem)
+ 'var var
+ 'help-echo "Mouse-2: visit this definition"
+ :type 'cusver-xref)))))))
+
(provide 'admin)
;;; admin.el ends here
HCoop / bpt / emacs.git / blobdiff