X-Git-Url: https://git.hcoop.net/bpt/emacs.git/blobdiff_plain/0273a428450950cf846767982cdb77cc9937a1f3..515b1c5f795e6f4c55b0d0abead601e6b0e904b6:/admin/admin.el
diff --git a/admin/admin.el b/admin/admin.el
index e815dfade4..7af9ffa417 100644
--- a/admin/admin.el
+++ b/admin/admin.el
@@ -1,6 +1,6 @@
;;; admin.el --- utilities for Emacs administration
-;; Copyright (C) 2001-2013 Free Software Foundation, Inc.
+;; Copyright (C) 2001-2014 Free Software Foundation, Inc.
;; This file is part of GNU Emacs.
@@ -21,46 +21,72 @@
;; add-release-logs Add ``Version X released'' change log entries.
;; set-version Change Emacs version number in source tree.
-;; set-copyright Change emacs short copyright string (eg as
+;; set-copyright Change Emacs short copyright string (eg as
;; printed by --version) in source tree.
;;; Code:
(defvar add-log-time-format) ; in add-log
-(defun add-release-logs (root version)
+;; Does this information need to be in every ChangeLog, as opposed to
+;; just the top-level one? Only if you allow changes the same
+;; day as the release.
+;; http://lists.gnu.org/archive/html/emacs-devel/2013-03/msg00161.html
+(defun add-release-logs (root version &optional date)
"Add \"Version VERSION released.\" change log entries in ROOT.
-Root must be the root of an Emacs source tree."
- (interactive "DEmacs root directory: \nNVersion number: ")
+Root must be the root of an Emacs source tree.
+Optional argument DATE is the release date, default today."
+ (interactive (list (read-directory-name "Emacs root directory: ")
+ (read-string "Version number: "
+ (format "%s.%s" emacs-major-version
+ emacs-minor-version))
+ (read-string "Release date: "
+ (progn (require 'add-log)
+ (let ((add-log-time-zone-rule t))
+ (funcall add-log-time-format))))))
(setq root (expand-file-name root))
(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))
+ (user-error "%s doesn't seem to be the root of an Emacs source tree" root))
(require 'add-log)
+ (or date (setq date (let ((add-log-time-zone-rule t))
+ (funcall add-log-time-format))))
(let* ((logs (process-lines "find" root "-name" "ChangeLog"))
(entry (format "%s %s <%s>\n\n\t* Version %s released.\n\n"
- (funcall add-log-time-format)
+ date
(or add-log-full-name (user-full-name))
(or add-log-mailing-address user-mail-address)
version)))
(dolist (log logs)
- (unless (string-match "/gnus/" log)
- (find-file log)
- (goto-char (point-min))
- (insert entry)))))
+ (find-file log)
+ (goto-char (point-min))
+ (insert entry))))
(defun set-version-in-file (root file version rx)
+ "Subroutine of `set-version' and `set-copyright'."
(find-file (expand-file-name file root))
(goto-char (point-min))
- (unless (re-search-forward rx nil t)
- (error "Version not found in %s" file))
- (replace-match (format "%s" version) nil nil nil 1))
+ (setq version (format "%s" version))
+ (unless (re-search-forward rx nil :noerror)
+ (user-error "Version not found in %s" file))
+ (if (not (equal version (match-string 1)))
+ (replace-match version nil nil nil 1)
+ (kill-buffer)
+ (message "No need to update `%s'" file)))
(defun set-version (root version)
"Set Emacs version to VERSION in relevant files under ROOT.
Root must be the root of an Emacs source tree."
- (interactive "DEmacs root directory: \nsVersion number: ")
+ (interactive (list
+ (read-directory-name "Emacs root directory: " source-directory)
+ (read-string "Version number: "
+ (replace-regexp-in-string "\\.[0-9]+\\'" ""
+ emacs-version))))
(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))
+ (user-error "%s doesn't seem to be the root of an Emacs source tree" root))
+ (message "Setting version numbers...")
+ ;; There's also a "version 3" (standing for GPLv3) at the end of
+ ;; `README', but since `set-version-in-file' only replaces the first
+ ;; occurrence, it won't be replaced.
(set-version-in-file root "README" version
(rx (and "version" (1+ space)
(submatch (1+ (in "0-9."))))))
@@ -91,7 +117,7 @@ Root must be the root of an Emacs source tree."
;; in two places those commas are followed by space, in two other
;; places they are not.
(let* ((version-components (append (split-string version "\\.")
- '("0" "0")))
+ '("0" "0")))
(comma-version
(concat (car version-components) ","
(cadr version-components) ","
@@ -140,8 +166,8 @@ Root must be the root of an Emacs source tree."
{\\([0-9]\\{2,\\}\\)}.+%.+version of Emacs")
(set-version-in-file root "etc/refcards/emacsver.tex" version
"\\\\def\\\\versionemacs\
-{\\([0-9]\\{2,\\}\\)}.+%.+version of Emacs"))))
-
+{\\([0-9]\\{2,\\}\\)}.+%.+version of Emacs")))
+ (message "Setting version numbers...done"))
;; Note this makes some assumptions about form of short copyright.
(defun set-copyright (root copyright)
@@ -154,7 +180,8 @@ Root must be the root of an Emacs source tree."
(format "Copyright (C) %s Free Software Foundation, Inc."
(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))
+ (user-error "%s doesn't seem to be the root of an Emacs source tree" root))
+ (message "Setting copyrights...")
(set-version-in-file root "configure.ac" copyright
(rx (and bol "copyright" (0+ (not (in ?\")))
?\" (submatch (1+ (not (in ?\")))) ?\")))
@@ -176,58 +203,92 @@ Root must be the root of an Emacs source tree."
{\\([0-9]\\{4\\}\\)}.+%.+copyright year")
(set-version-in-file root "etc/refcards/emacsver.tex" copyright
"\\\\def\\\\year\
-{\\([0-9]\\{4\\}\\)}.+%.+copyright year")))
+{\\([0-9]\\{4\\}\\)}.+%.+copyright year"))
+ (message "Setting copyrights...done"))
;;; 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: ")
+(defun manual-misc-manuals (root)
+ "Return doc/misc manuals as list of strings.
+ROOT should be the root of an Emacs source tree."
+ ;; Similar to `make -C doc/misc echo-info', but works if unconfigured,
+ ;; and for INFO_TARGETS rather than INFO_INSTALL.
+ (with-temp-buffer
+ (insert-file-contents (expand-file-name "doc/misc/Makefile.in" root))
+ ;; Should really use expanded value of INFO_TARGETS.
+ (search-forward "INFO_COMMON = ")
+ (let ((start (point)))
+ (end-of-line)
+ (while (and (looking-back "\\\\")
+ (zerop (forward-line 1)))
+ (end-of-line))
+ (append (split-string (replace-regexp-in-string
+ "\\(\\\\\\|\\.info\\)" ""
+ (buffer-substring start (point))))
+ '("efaq-w32")))))
+
+;; TODO report the progress
+(defun make-manuals (root &optional type)
+ "Generate the web manuals for the Emacs webpage.
+ROOT should be the root of an Emacs source tree.
+Interactively with a prefix argument, prompt for TYPE.
+Optional argument TYPE is type of output (nil means all)."
+ (interactive (let ((root (read-directory-name "Emacs root directory: "
+ source-directory nil t)))
+ (list root
+ (if current-prefix-arg
+ (completing-read
+ "Type: "
+ (append
+ '("misc" "pdf" "ps")
+ (let (res)
+ (dolist (i '("emacs" "elisp" "eintr") res)
+ (dolist (j '("" "-mono" "-node" "-ps" "-pdf"))
+ (push (concat i j) res))))
+ (manual-misc-manuals root)))))))
(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)))
+ (ps-dir (expand-file-name "ps" dest))
+ (pdf-dir (expand-file-name "pdf" dest))
+ (emacs (expand-file-name "doc/emacs/emacs.texi" root))
+ (elisp (expand-file-name "doc/lispref/elisp.texi" root))
+ (eintr (expand-file-name "doc/lispintro/emacs-lisp-intro.texi" root))
+ (misc (manual-misc-manuals root)))
+ ;; TODO this makes it non-continuable.
+ ;; Instead, delete the individual dest directory each time.
(when (file-directory-p dest)
- (if (y-or-n-p (format "Directory %s exists, delete it first?" 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)))
+ (user-error "Aborted")))
+ (if (member type '(nil "emacs" "emacs-node"))
+ (manual-html-node emacs (expand-file-name "emacs" html-node-dir)))
+ (if (member type '(nil "emacs" "emacs-mono"))
+ (manual-html-mono emacs (expand-file-name "emacs.html" html-mono-dir)))
+ (if (member type '(nil "emacs" "emacs-pdf" "pdf"))
+ (manual-pdf emacs (expand-file-name "emacs.pdf" pdf-dir)))
+ (if (member type '(nil "emacs" "emacs-ps" "ps"))
+ (manual-ps emacs (expand-file-name "emacs.ps" ps-dir)))
+ (if (member type '(nil "elisp" "elisp-node"))
+ (manual-html-node elisp (expand-file-name "elisp" html-node-dir)))
+ (if (member type '(nil "elisp" "elisp-mono"))
+ (manual-html-mono elisp (expand-file-name "elisp.html" html-mono-dir)))
+ (if (member type '(nil "elisp" "elisp-pdf" "pdf"))
+ (manual-pdf elisp (expand-file-name "elisp.pdf" pdf-dir)))
+ (if (member type '(nil "elisp" "elisp-ps" "ps"))
+ (manual-ps elisp (expand-file-name "elisp.ps" ps-dir)))
+ (if (member type '(nil "eintr" "eintr-node"))
+ (manual-html-node eintr (expand-file-name "eintr" html-node-dir)))
+ (if (member type '(nil "eintr" "eintr-node"))
+ (manual-html-mono eintr (expand-file-name "eintr.html" html-mono-dir)))
+ (if (member type '(nil "eintr" "eintr-pdf" "pdf"))
+ (manual-pdf eintr (expand-file-name "eintr.pdf" pdf-dir)))
+ (if (member type '(nil "eintr" "eintr-ps" "ps"))
+ (manual-ps eintr (expand-file-name "eintr.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)))
+ (dolist (manual misc)
+ (if (member type `(nil ,manual "misc"))
+ (manual-misc-html manual root html-node-dir html-mono-dir)))
(message "Manuals created in %s" dest)))
(defconst manual-doctype-string
@@ -242,10 +303,14 @@ Root must be the root of an Emacs source tree."
\n\n")
(defconst manual-style-string "\n")
+@import url('/software/emacs/manual.css');\n\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)))
+ ;; Hack to deal with the cases where .texi creates a different .info.
+ ;; Blech. TODO Why not just rename the .texi (or .info) files?
+ (let* ((texiname (cond ((equal name "ccmode") "cc-mode")
+ (t name)))
+ (texi (expand-file-name (format "doc/misc/%s.texi" texiname) 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))))
@@ -255,7 +320,13 @@ Root must be the root of an Emacs source tree."
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."
+ (make-directory (or (file-name-directory dest) ".") t)
(call-process "makeinfo" nil nil nil
+ "-D" "WWW_GNU_ORG"
+ "-I" (expand-file-name "../emacs"
+ (file-name-directory texi-file))
+ "-I" (expand-file-name "../misc"
+ (file-name-directory texi-file))
"--html" "--no-split" texi-file "-o" dest)
(with-temp-buffer
(insert-file-contents dest)
@@ -266,6 +337,7 @@ the @import directive."
(manual-html-fix-node-div)
(goto-char (point-max))
(re-search-backward "