;;; admin.el --- utilities for Emacs administration
-;; Copyright (C) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010
-;; Free Software Foundation, Inc.
+;; Copyright (C) 2001-2012 Free Software Foundation, Inc.
;; This file is part of GNU Emacs.
(interactive "DEmacs root directory: \nsVersion number: ")
(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" version
- (rx (and "emacs_version" (0+ (not (in ?\")))
- ?\" (submatch (1+ (not (in ?\")))) ?\")))
(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."))))))
- (set-version-in-file root "doc/emacs/emacs.texi" version
+ (set-version-in-file root "doc/emacs/emacsver.texi" version
(rx (and "EMACSVER" (1+ space)
(submatch (1+ (in "0-9."))))))
- (set-version-in-file root "doc/lispref/elisp.texi" version
- (rx (and "EMACSVER" (1+ space)
- (submatch (1+ (in "0-9."))))))
- (set-version-in-file root "doc/lispref/vol1.texi" version
- (rx (and "EMACSVER" (1+ space)
- (submatch (1+ (in "0-9."))))))
- (set-version-in-file root "doc/lispref/vol2.texi" version
- (rx (and "EMACSVER" (1+ space)
- (submatch (1+ (in "0-9."))))))
- (set-version-in-file root "doc/lispref/book-spine.texinfo" version
- (rx (and "Emacs Version" (1+ space)
- (submatch (1+ (in "0-9."))))))
(set-version-in-file root "doc/man/emacs.1" version
(rx (and ".TH EMACS" (1+ not-newline)
"GNU Emacs" (1+ space)
(submatch (1+ (in "0-9."))))))
- (set-version-in-file root "doc/misc/faq.texi" version
- (rx (and "VER" (1+ space)
+ (set-version-in-file root "nt/config.nt" version
+ (rx (and bol "#" (0+ blank) "define" (1+ blank)
+ "VERSION" (1+ blank) "\""
(submatch (1+ (in "0-9."))))))
- (set-version-in-file root "lib-src/makefile.w32-in" version
- (rx (and "VERSION" (0+ space) "=" (0+ space)
+ (set-version-in-file root "msdos/sed2v2.inp" version
+ (rx (and bol "/^#undef " (1+ not-newline)
+ "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)
version (rx (and "Version=" (submatch (1+ (in "0-9.")))))))
;; Note this makes some assumptions about form of short copyright.
-;; FIXME add the \year in the refcards/*.tex files.
(defun set-copyright (root copyright)
"Set Emacs short copyright to COPYRIGHT in relevant files under ROOT.
Root must be the root of an Emacs source tree."
(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 ?\")))) ?\")))
+ ?\" (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 ?\")))) ?\")))
+ ?\" (submatch (1+ (not (in ?\")))) ?\")))
(set-version-in-file root "lib-src/etags.c" copyright
(rx (and "emacs_copyright" (0+ (not (in ?\")))
- ?\" (submatch (1+ (not (in ?\")))) ?\")))
+ ?\" (submatch (1+ (not (in ?\")))) ?\")))
(set-version-in-file root "lib-src/rcs2log" copyright
- (rx (and "Copyright" (0+ space) ?= (0+ space)
- ?\' (submatch (1+ nonl)))))
+ (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/GNUstep/Emacs.base/Resources/Info-gnustep.plist"
copyright (rx (and "Copyright" (0+ space) ?\= (0+ space)
- ?\" (submatch (1+ (not (in ?\"))))))))
+ ?\" (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"))))))
+
+;;; Various bits of magic for generating the web manuals
+
+(defun make-manuals (root)
+ "Generate the web manuals for the Emacs webpage."
+ (interactive "DEmacs root directory: ")
+ (let* ((dest (expand-file-name "manual" root))
+ (html-node-dir (expand-file-name "html_node" dest))
+ (html-mono-dir (expand-file-name "html_mono" dest))
+ (txt-dir (expand-file-name "text" dest))
+ (dvi-dir (expand-file-name "dvi" dest))
+ (ps-dir (expand-file-name "ps" dest)))
+ (when (file-directory-p dest)
+ (if (y-or-n-p (format "Directory %s exists, delete it first?" dest))
+ (delete-directory dest t)
+ (error "Aborted")))
+ (make-directory dest)
+ (make-directory html-node-dir)
+ (make-directory html-mono-dir)
+ (make-directory txt-dir)
+ (make-directory dvi-dir)
+ (make-directory ps-dir)
+ ;; Emacs manual
+ (let ((texi (expand-file-name "doc/emacs/emacs.texi" root)))
+ (manual-html-node texi (expand-file-name "emacs" html-node-dir))
+ (manual-html-mono texi (expand-file-name "emacs.html" html-mono-dir))
+ (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)))
+ ;; Lisp manual
+ (let ((texi (expand-file-name "doc/lispref/elisp.texi" root)))
+ (manual-html-node texi (expand-file-name "elisp" html-node-dir))
+ (manual-html-mono texi (expand-file-name "elisp.html" html-mono-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)))
+ ;; 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
+ "<!DOCTYPE HTML PUBLIC \"-//W3C//DTD HTML 4.01 Transitional//EN\"
+\"http://www.w3.org/TR/html4/loose.dtd\">\n\n")
+
+(defconst manual-meta-string
+ "<meta http-equiv=\"content-type\" content=\"text/html; charset=utf-8\">
+<link rev=\"made\" href=\"mailto:webmasters@gnu.org\">
+<link rel=\"icon\" type=\"image/png\" href=\"/graphics/gnu-head-mini.png\">
+<meta name=\"ICBM\" content=\"42.256233,-71.006581\">
+<meta name=\"DC.title\" content=\"gnu.org\">\n\n")
+
+(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
+HTML 4.01 Transitional, and pulls in the gnu.org stylesheet using
+the @import directive."
+ (call-process "makeinfo" nil nil nil
+ "--html" "--no-split" texi-file "-o" dest)
+ (with-temp-buffer
+ (insert-file-contents dest)
+ (setq buffer-file-name dest)
+ (manual-html-fix-headers)
+ (manual-html-fix-index-1)
+ (manual-html-fix-index-2 t)
+ (manual-html-fix-node-div)
+ (goto-char (point-max))
+ (re-search-backward "</body>[\n \t]*</html>")
+ (insert "</div>\n\n")
+ (save-buffer)))
+
+(defun manual-html-node (texi-file dir)
+ "Run Makeinfo on TEXI-FILE, emitting per-node HTML output to DIR.
+This function also edits the HTML files so that they validate as
+HTML 4.01 Transitional, and pulls in the gnu.org stylesheet using
+the @import directive."
+ (unless (file-exists-p texi-file)
+ (error "Manual file %s not found" texi-file))
+ (call-process "makeinfo" nil nil nil
+ "--html" texi-file "-o" dir)
+ ;; Loop through the node files, fixing them up.
+ (dolist (f (directory-files dir nil "\\.html\\'"))
+ (let (opoint)
+ (with-temp-buffer
+ (insert-file-contents (expand-file-name f dir))
+ (setq buffer-file-name (expand-file-name f dir))
+ (if (looking-at "<meta http-equiv")
+ ;; Ignore those HTML files that are just redirects.
+ (set-buffer-modified-p nil)
+ (manual-html-fix-headers)
+ (if (equal f "index.html")
+ (let (copyright-text)
+ (manual-html-fix-index-1)
+ ;; Move copyright notice to the end.
+ (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)
+ (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-txt (texi-file dest)
+ "Run Makeinfo on TEXI-FILE, emitting plaintext output to DEST."
+ (call-process "makeinfo" nil nil nil
+ "--plaintext" "--no-split" texi-file "-o" dest)
+ (shell-command (concat "gzip -c " dest " > " (concat dest ".gz"))))
+
+(defun manual-pdf (texi-file dest)
+ "Run texi2pdf on TEXI-FILE, emitting plaintext output to DEST."
+ (call-process "texi2pdf" nil nil nil texi-file "-o" dest))
+
+(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."
+ (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)
+ (call-process "gzip" nil nil nil ps-dest))
+
+(defun manual-html-fix-headers ()
+ "Fix up HTML headers for the Emacs manual in the current buffer."
+ (let (opoint)
+ (insert manual-doctype-string)
+ (search-forward "<head>\n")
+ (insert manual-meta-string)
+ (search-forward "<meta")
+ (setq opoint (match-beginning 0))
+ (re-search-forward "<!--")
+ (goto-char (match-beginning 0))
+ (delete-region opoint (point))
+ (insert manual-style-string)
+ (search-forward "<meta http-equiv=\"Content-Style")
+ (setq opoint (match-beginning 0))
+ (search-forward "</head>")
+ (delete-region opoint (match-beginning 0))))
+
+(defun manual-html-fix-node-div ()
+ "Fix up HTML \"node\" divs in the current buffer."
+ (let (opoint div-end)
+ (while (search-forward "<div class=\"node\">" nil t)
+ (replace-match
+ "<div class=\"node\" style=\"background-color:#DDDDFF\">"
+ t t)
+ (setq opoint (point))
+ (re-search-forward "</div>")
+ (setq div-end (match-beginning 0))
+ (goto-char opoint)
+ (if (search-forward "<hr>" div-end 'move)
+ (replace-match "" t t)))))
+
+(defun manual-html-fix-index-1 ()
+ (let (opoint)
+ (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")))
+
+(defun manual-html-fix-index-2 (&optional table-workaround)
+ "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.
+ (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)
+ (cond
+ ((or (looking-at "<li>\\(<a.+</a>\\):[ \t]+\\(.*\\)$")
+ (looking-at "<li>\\(<a.+</a>\\)$"))
+ (setq tag (match-string 1))
+ (setq desc (match-string 2))
+ (replace-match "" t t)
+ (when open-td
+ (save-excursion
+ (forward-char -1)
+ (skip-chars-backward " ")
+ (delete-region (point) (line-end-position))
+ (insert "</td>\n </tr>")))
+ (insert " <tr>\n ")
+ (if table-workaround
+ ;; This works around a Firefox bug in the mono file.
+ (insert "<td bgcolor=\"white\">")
+ (insert "<td>"))
+ (insert tag "</td>\n <td>" (or desc ""))
+ (setq open-td t))
+ ((eq (char-after) ?\n)
+ (delete-char 1)
+ ;; Negate the following `forward-line'.
+ (forward-line -1))
+ ((looking-at "<!-- ")
+ (search-forward "-->"))
+ ((looking-at "<p>[- ]*The Detailed Node Listing[- \n]*")
+ (replace-match " </td></tr></table>\n
+<h3>Detailed Node Listing</h3>\n\n" t t)
+ (search-forward "<p>")
+ (search-forward "<p>" nil t)
+ (goto-char (match-beginning 0))
+ (skip-chars-backward "\n ")
+ (setq open-td nil)
+ (insert "</p>\n\n<table style=\"float:left\" width=\"100%\">"))
+ ((looking-at "</li></ul>")
+ (replace-match "" t t))
+ ((looking-at "<p>")
+ (replace-match "" t t)
+ (when open-td
+ (insert " </td></tr>")
+ (setq open-td nil))
+ (insert " <tr>
+ <th colspan=\"2\" align=\"left\" style=\"text-align:left\">")
+ (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
+ " </td></tr>\n</table>"
+ "</table>") t t)
+ (setq done t))
+ (t
+ (if (eobp)
+ (error "Parse error in %s" f))
+ (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"
+ ))
+ "{}" "+"))
+
+;; TODO if a defgroup with a version tag, apply to all customs in that
+;; group (eg for new files).
+(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")))
+ alist var ver)
+ (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))
+ (setq ver (car (cdr-safe (memq :version form)))
+ alist (cons (cons var ver) alist))
+ (if form (message "Malformed defcustom: `%s'" form)))))
+ (message "%sdone" m)
+ 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. Eg cus-start if
+;; something moved from C to Lisp.
+;; TODO handle renamed things with aliases to the old names.
+;; What to do about new files? Does everything in there need a :version,
+;; or eg just the defgroup?
+(defun cusver-check (newdir olddir)
+ "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 "DNew Lisp directory: \nDOld Lisp directory: ")
+ (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))
+ (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)
+ (message "Reading old defcustoms...")
+ (dolist (file oldfiles)
+ (setq oldcus (append oldcus (cusver-scan file t))))
+ ;; 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)
-;; arch-tag: 4ea83636-2293-408b-884e-ad64f22a3bf5
;;; admin.el ends here