[bpt/emacs.git] / admin / admin.el

;;; admin.el --- utilities for Emacs administration

;; Copyright (C) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008
;;   Free Software Foundation, Inc.

;; This file is part of GNU Emacs.

;; GNU Emacs is free software: you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.

;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.

;;; Commentary:

;; 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
;;                      printed by --version) in source tree.

;;; Code:

(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."
  (interactive "DEmacs root directory: \nNVersion number: ")
  (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))
  (require 'add-log)
  (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)
			(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)))))

(defun set-version-in-file (root file version rx)
  (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))

(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: ")
  (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 "lisp/version.el" version
		       (rx (and "emacs-version" (0+ space)
				?\" (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
		       (rx (and "AC_INIT" (1+ (not (in ?,)))
                                ?, (0+ space)
                                (submatch (1+ (in "0-9."))))))
  (set-version-in-file root "doc/emacs/emacs.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)
				(submatch (1+ (in "0-9."))))))
  (set-version-in-file root "lib-src/makefile.w32-in" version
		       (rx (and "VERSION" (0+ space) "=" (0+ space)
				(submatch (1+ (in "0-9."))))))
  ;; nt/emacs.rc also contains the version number, but in an awkward
  ;; format. It must contain four components, separated by commas, and
  ;; 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")))
	 (comma-version
	  (concat (car version-components) ","
		  (cadr version-components) ","
		  (cadr (cdr version-components)) ","
		  (cadr (cdr (cdr version-components)))))
	 (comma-space-version
	  (concat (car version-components) ", "
		  (cadr version-components) ", "
		  (cadr (cdr version-components)) ", "
		  (cadr (cdr (cdr version-components))))))
    (set-version-in-file root "nt/emacs.rc" comma-version
			 (rx (and "FILEVERSION" (1+ space)
				  (submatch (1+ (in "0-9,"))))))
    (set-version-in-file root "nt/emacs.rc" comma-version
			 (rx (and "PRODUCTVERSION" (1+ space)
				  (submatch (1+ (in "0-9,"))))))
    (set-version-in-file root "nt/emacs.rc" comma-space-version
			 (rx (and "\"FileVersion\"" (0+ space) ?, (0+ space)
				  ?\" (submatch (1+ (in "0-9, "))) "\\0\"")))
    (set-version-in-file root "nt/emacs.rc" comma-space-version
			 (rx (and "\"ProductVersion\"" (0+ space) ?,
				  (0+ space) ?\" (submatch (1+ (in "0-9, ")))
				  "\\0\"")))
    ;; Likewise for emacsclient.rc
    (set-version-in-file root "nt/emacsclient.rc" comma-version
			 (rx (and "FILEVERSION" (1+ space)
				  (submatch (1+ (in "0-9,"))))))
    (set-version-in-file root "nt/emacsclient.rc" comma-version
			 (rx (and "PRODUCTVERSION" (1+ space)
				  (submatch (1+ (in "0-9,"))))))
    (set-version-in-file root "nt/emacsclient.rc" comma-space-version
			 (rx (and "\"FileVersion\"" (0+ space) ?, (0+ space)
				  ?\" (submatch (1+ (in "0-9, "))) "\\0\"")))
    (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+ anything)
                    "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 "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 "FullVersionID" (0+ space) ?= (0+ space)
                    ?\" (0+ space) "Emacs" (1+ space)
                    (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."
  (interactive (list
                (read-directory-name "Emacs root directory: " nil nil t)
                (read-string
                 "Short copyright string: "
                 (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))
  (set-version-in-file root "lisp/version.el" copyright
		       (rx (and "emacs-copyright" (0+ space)
				?\" (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 ?\")))
				?\" (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 ?\"))))))))

(provide 'admin)

;; arch-tag: 4ea83636-2293-408b-884e-ad64f22a3bf5
;;; admin.el ends here
Commit	Line	Data
74499542 GM	1	;;; admin.el --- utilities for Emacs administration
74499542 GM	2
a70c9a7a	3	;; Copyright (C) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008
4e6835db	4	;; Free Software Foundation, Inc.
74499542 GM	5
	6	;; This file is part of GNU Emacs.
	7
9ad5de0c	8	;; GNU Emacs is free software: you can redistribute it and/or modify
74499542	9	;; it under the terms of the GNU General Public License as published by
9ad5de0c GM	10	;; the Free Software Foundation, either version 3 of the License, or
9ad5de0c GM	11	;; (at your option) any later version.
74499542 GM	12
	13	;; GNU Emacs is distributed in the hope that it will be useful,
	14	;; but WITHOUT ANY WARRANTY; without even the implied warranty of
	15	;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	16	;; GNU General Public License for more details.
	17
	18	;; You should have received a copy of the GNU General Public License
9ad5de0c	19	;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
74499542 GM	20
	21	;;; Commentary:
	22
54381691 LK	23	;; add-release-logs Add ``Version X released'' change log entries.
54381691 LK	24	;; set-version Change Emacs version number in source tree.
a3045b7e GM	25	;; set-copyright Change emacs short copyright string (eg as
a3045b7e GM	26	;; printed by --version) in source tree.
74499542 GM	27
	28	;;; Code:
	29
74499542 GM	30	(defun add-release-logs (root version)
	31	"Add \"Version VERSION released.\" change log entries in ROOT.
	32	Root must be the root of an Emacs source tree."
	33	(interactive "DEmacs root directory: \nNVersion number: ")
3f4a4bdf	34	(setq root (expand-file-name root))
74499542 GM	35	(unless (file-exists-p (expand-file-name "src/emacs.c" root))
74499542 GM	36	(error "%s doesn't seem to be the root of an Emacs source tree" root))
54381691	37	(require 'add-log)
74499542 GM	38	(let* ((logs (process-lines "find" root "-name" "ChangeLog"))
74499542 GM	39	(entry (format "%s %s <%s>\n\n\t* Version %s released.\n\n"
3f4a4bdf FP	40	(funcall add-log-time-format)
	41	(or add-log-full-name (user-full-name))
	42	(or add-log-mailing-address user-mail-address)
	43	version)))
74499542	44	(dolist (log logs)
e568708b	45	(unless (string-match "/gnus/" log)
74499542 GM	46	(find-file log)
	47	(goto-char (point-min))
	48	(insert entry)))))
	49
74499542 GM	50	(defun set-version-in-file (root file version rx)
	51	(find-file (expand-file-name file root))
	52	(goto-char (point-min))
	53	(unless (re-search-forward rx nil t)
	54	(error "Version not found in %s" file))
	55	(replace-match (format "%s" version) nil nil nil 1))
	56
74499542 GM	57	(defun set-version (root version)
	58	"Set Emacs version to VERSION in relevant files under ROOT.
	59	Root must be the root of an Emacs source tree."
91ebb8c9	60	(interactive "DEmacs root directory: \nsVersion number: ")
74499542 GM	61	(unless (file-exists-p (expand-file-name "src/emacs.c" root))
	62	(error "%s doesn't seem to be the root of an Emacs source tree" root))
	63	(set-version-in-file root "lisp/version.el" version
	64	(rx (and "emacs-version" (0+ space)
	65	?\" (submatch (1+ (not (in ?\")))) ?\")))
	66	(set-version-in-file root "README" version
	67	(rx (and "version" (1+ space)
	68	(submatch (1+ (in "0-9."))))))
24bbe01e GM	69	(set-version-in-file root "configure.in" version
	70	(rx (and "AC_INIT" (1+ (not (in ?,)))
	71	?, (0+ space)
	72	(submatch (1+ (in "0-9."))))))
	73	(set-version-in-file root "doc/emacs/emacs.texi" version
49e3fad2 LK	74	(rx (and "EMACSVER" (1+ space)
49e3fad2 LK	75	(submatch (1+ (in "0-9."))))))
24bbe01e	76	(set-version-in-file root "doc/lispref/elisp.texi" version
74499542	77	(rx (and "EMACSVER" (1+ space)
95f76284	78	(submatch (1+ (in "0-9."))))))
f2d8d275 GM	79	(set-version-in-file root "doc/lispref/vol1.texi" version
	80	(rx (and "EMACSVER" (1+ space)
	81	(submatch (1+ (in "0-9."))))))
	82	(set-version-in-file root "doc/lispref/vol2.texi" version
	83	(rx (and "EMACSVER" (1+ space)
	84	(submatch (1+ (in "0-9."))))))
5de85e83 GM	85	(set-version-in-file root "doc/lispref/book-spine.texinfo" version
	86	(rx (and "Emacs Version" (1+ space)
	87	(submatch (1+ (in "0-9."))))))
adf94aa6 GM	88	(set-version-in-file root "doc/man/emacs.1" version
	89	(rx (and ".TH EMACS" (1+ not-newline)
	90	"GNU Emacs" (1+ space)
	91	(submatch (1+ (in "0-9."))))))
611bee81 GM	92	(set-version-in-file root "doc/misc/faq.texi" version
	93	(rx (and "VER" (1+ space)
	94	(submatch (1+ (in "0-9."))))))
1fe1ef05 JB	95	(set-version-in-file root "lib-src/makefile.w32-in" version
	96	(rx (and "VERSION" (0+ space) "=" (0+ space)
	97	(submatch (1+ (in "0-9."))))))
95f76284 JR	98	;; nt/emacs.rc also contains the version number, but in an awkward
	99	;; format. It must contain four components, separated by commas, and
	100	;; in two places those commas are followed by space, in two other
	101	;; places they are not.
	102	(let* ((version-components (append (split-string version "\\.")
	103	'("0" "0")))
	104	(comma-version
	105	(concat (car version-components) ","
	106	(cadr version-components) ","
d0834a5c	107	(cadr (cdr version-components)) ","
95f76284 JR	108	(cadr (cdr (cdr version-components)))))
	109	(comma-space-version
	110	(concat (car version-components) ", "
	111	(cadr version-components) ", "
d0834a5c	112	(cadr (cdr version-components)) ", "
95f76284 JR	113	(cadr (cdr (cdr version-components))))))
	114	(set-version-in-file root "nt/emacs.rc" comma-version
	115	(rx (and "FILEVERSION" (1+ space)
	116	(submatch (1+ (in "0-9,"))))))
	117	(set-version-in-file root "nt/emacs.rc" comma-version
	118	(rx (and "PRODUCTVERSION" (1+ space)
	119	(submatch (1+ (in "0-9,"))))))
	120	(set-version-in-file root "nt/emacs.rc" comma-space-version
	121	(rx (and "\"FileVersion\"" (0+ space) ?, (0+ space)
	122	?\" (submatch (1+ (in "0-9, "))) "\\0\"")))
	123	(set-version-in-file root "nt/emacs.rc" comma-space-version
	124	(rx (and "\"ProductVersion\"" (0+ space) ?,
	125	(0+ space) ?\" (submatch (1+ (in "0-9, ")))
b7063e7e JR	126	"\\0\"")))
	127	;; Likewise for emacsclient.rc
	128	(set-version-in-file root "nt/emacsclient.rc" comma-version
	129	(rx (and "FILEVERSION" (1+ space)
	130	(submatch (1+ (in "0-9,"))))))
	131	(set-version-in-file root "nt/emacsclient.rc" comma-version
	132	(rx (and "PRODUCTVERSION" (1+ space)
	133	(submatch (1+ (in "0-9,"))))))
	134	(set-version-in-file root "nt/emacsclient.rc" comma-space-version
	135	(rx (and "\"FileVersion\"" (0+ space) ?, (0+ space)
	136	?\" (submatch (1+ (in "0-9, "))) "\\0\"")))
	137	(set-version-in-file root "nt/emacsclient.rc" comma-space-version
95f76284 JR	138	(rx (and "\"ProductVersion\"" (0+ space) ?,
95f76284 JR	139	(0+ space) ?\" (submatch (1+ (in "0-9, ")))
9e2a2647	140	"\\0\""))))
d3841127 GM	141	;; nextstep.
	142	(set-version-in-file
	143	root "nextstep/Cocoa/Emacs.base/Contents/Info.plist"
	144	version (rx (and "CFBundleGetInfoString" (1+ anything) "Emacs" (1+ space)
	145	(submatch (1+ (in "0-9."))))))
	146	(set-version-in-file
	147	root "nextstep/Cocoa/Emacs.base/Contents/Info.plist"
	148	version (rx (and "CFBundleShortVersionString" (1+ anything)
	149	"Version" (1+ space)
	150	(submatch (1+ (in "0-9."))))))
	151	(set-version-in-file
	152	root "nextstep/Cocoa/Emacs.base/Contents/Resources/English.lproj/InfoPlist.strings"
	153	version (rx (and "CFBundleShortVersionString" (0+ space) ?= (0+ space)
	154	?\" (0+ space) "Version" (1+ space)
	155	(submatch (1+ (in "0-9."))))))
	156	(set-version-in-file
	157	root "nextstep/Cocoa/Emacs.base/Contents/Resources/English.lproj/InfoPlist.strings"
	158	version (rx (and "CFBundleGetInfoString" (0+ space) ?= (0+ space)
	159	?\" (0+ space) "Emacs version" (1+ space)
	160	(submatch (1+ (in "0-9."))))))
	161	(set-version-in-file
	162	root "nextstep/GNUstep/Emacs.base/Resources/Info-gnustep.plist"
	163	version (rx (and "FullVersionID" (0+ space) ?= (0+ space)
	164	?\" (0+ space) "Emacs" (1+ space)
	165	(submatch (1+ (in "0-9.")))))))
3f4a4bdf	166
a3045b7e	167	;; Note this makes some assumptions about form of short copyright.
6916ec08	168	;; FIXME add the \year in the refcards/*.tex files.
a3045b7e GM	169	(defun set-copyright (root copyright)
	170	"Set Emacs short copyright to COPYRIGHT in relevant files under ROOT.
	171	Root must be the root of an Emacs source tree."
	172	(interactive (list
	173	(read-directory-name "Emacs root directory: " nil nil t)
	174	(read-string
	175	"Short copyright string: "
	176	(format "Copyright (C) %s Free Software Foundation, Inc."
	177	(format-time-string "%Y")))))
	178	(unless (file-exists-p (expand-file-name "src/emacs.c" root))
	179	(error "%s doesn't seem to be the root of an Emacs source tree" root))
	180	(set-version-in-file root "lisp/version.el" copyright
	181	(rx (and "emacs-copyright" (0+ space)
	182	?\" (submatch (1+ (not (in ?\")))) ?\")))
a70c9a7a GM	183	(set-version-in-file root "lib-src/ebrowse.c" copyright
	184	(rx (and "emacs_copyright" (0+ (not (in ?\")))
	185	?\" (submatch (1+ (not (in ?\")))) ?\")))
a3045b7e GM	186	(set-version-in-file root "lib-src/etags.c" copyright
	187	(rx (and "emacs_copyright" (0+ (not (in ?\")))
	188	?\" (submatch (1+ (not (in ?\")))) ?\")))
	189	(set-version-in-file root "lib-src/rcs2log" copyright
	190	(rx (and "Copyright" (0+ space) ?= (0+ space)
	191	?\' (submatch (1+ nonl)))))
a3045b7e GM	192	;; This one is a nuisance, as it needs to be split over two lines.
a3045b7e GM	193	(string-match "\\(.[0-9]\\{4\\} \\)\\(.*\\)" copyright)
d3841127 GM	194	;; nextstep.
	195	(set-version-in-file
	196	root "nextstep/Cocoa/Emacs.base/Contents/Info.plist"
	197	copyright (rx (and "CFBundleGetInfoString" (1+ anything) "Emacs" (1+ space)
	198	(1+ (in "0-9.")) (1+ space)
	199	(submatch (1+ (not (in ?\<)))))))
	200	(set-version-in-file
	201	root "nextstep/Cocoa/Emacs.base/Contents/Resources/English.lproj/InfoPlist.strings"
	202	copyright (rx (and "NSHumanReadableCopyright" (0+ space) ?\= (0+ space)
7963f8ab GM	203	?\" (submatch (1+ (not (in ?\")))))))
	204	(set-version-in-file
	205	root "nextstep/GNUstep/Emacs.base/Resources/Info-gnustep.plist"
	206	copyright (rx (and "Copyright" (0+ space) ?\= (0+ space)
	207	?\" (submatch (1+ (not (in ?\"))))))))
a3045b7e	208
69c52df1 GM	209	(provide 'admin)
69c52df1 GM	210
d3841127 GM	211	;; arch-tag: 4ea83636-2293-408b-884e-ad64f22a3bf5
d3841127 GM	212	;;; admin.el ends here