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

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

;; Copyright (C) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009,
;;   2010  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 "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
		       (rx (and "AC_INIT" (1+ (not (in ?,)))
                                ?, (0+ space)
                                (submatch (1+ (in "0-9."))))))
  (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/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 "lib-src/makefile.w32-in" version
		       (rx (and "VERSION" (0+ space) "=" (0+ space)
				(submatch (1+ (in "0-9."))))))
  (set-version-in-file root "nt/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+ 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.")))))))

;; 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 "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 ?\")))
				?\" (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)

;;; admin.el ends here
Commit	Line	Data
74499542 GM	1	;;; admin.el --- utilities for Emacs administration
74499542 GM	2
f7a31f11 GM	3	;; Copyright (C) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009,
f7a31f11 GM	4	;; 2010 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))
74499542 GM	62	(error "%s doesn't seem to be the root of an Emacs source tree" root))
e45b9e19 KR	63	(set-version-in-file root "src/emacs.c" version
e45b9e19 KR	64	(rx (and "emacs_version" (0+ (not (in ?\")))
74499542 GM	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."))))))
f4f358f1 GM	73	(set-version-in-file root "doc/emacs/emacsver.texi" version
	74	(rx (and "EMACSVER" (1+ space)
	75	(submatch (1+ (in "0-9."))))))
adf94aa6 GM	76	(set-version-in-file root "doc/man/emacs.1" version
	77	(rx (and ".TH EMACS" (1+ not-newline)
	78	"GNU Emacs" (1+ space)
	79	(submatch (1+ (in "0-9."))))))
1fe1ef05 JB	80	(set-version-in-file root "lib-src/makefile.w32-in" version
	81	(rx (and "VERSION" (0+ space) "=" (0+ space)
	82	(submatch (1+ (in "0-9."))))))
e3aef5c6 CS	83	(set-version-in-file root "nt/makefile.w32-in" version
	84	(rx (and "VERSION" (0+ space) "=" (0+ space)
	85	(submatch (1+ (in "0-9."))))))
95f76284 JR	86	;; nt/emacs.rc also contains the version number, but in an awkward
	87	;; format. It must contain four components, separated by commas, and
	88	;; in two places those commas are followed by space, in two other
	89	;; places they are not.
	90	(let* ((version-components (append (split-string version "\\.")
	91	'("0" "0")))
	92	(comma-version
	93	(concat (car version-components) ","
	94	(cadr version-components) ","
d0834a5c	95	(cadr (cdr version-components)) ","
95f76284 JR	96	(cadr (cdr (cdr version-components)))))
	97	(comma-space-version
	98	(concat (car version-components) ", "
	99	(cadr version-components) ", "
d0834a5c	100	(cadr (cdr version-components)) ", "
95f76284 JR	101	(cadr (cdr (cdr version-components))))))
	102	(set-version-in-file root "nt/emacs.rc" comma-version
	103	(rx (and "FILEVERSION" (1+ space)
	104	(submatch (1+ (in "0-9,"))))))
	105	(set-version-in-file root "nt/emacs.rc" comma-version
	106	(rx (and "PRODUCTVERSION" (1+ space)
	107	(submatch (1+ (in "0-9,"))))))
	108	(set-version-in-file root "nt/emacs.rc" comma-space-version
	109	(rx (and "\"FileVersion\"" (0+ space) ?, (0+ space)
	110	?\" (submatch (1+ (in "0-9, "))) "\\0\"")))
	111	(set-version-in-file root "nt/emacs.rc" comma-space-version
	112	(rx (and "\"ProductVersion\"" (0+ space) ?,
	113	(0+ space) ?\" (submatch (1+ (in "0-9, ")))
b7063e7e JR	114	"\\0\"")))
	115	;; Likewise for emacsclient.rc
	116	(set-version-in-file root "nt/emacsclient.rc" comma-version
	117	(rx (and "FILEVERSION" (1+ space)
	118	(submatch (1+ (in "0-9,"))))))
	119	(set-version-in-file root "nt/emacsclient.rc" comma-version
	120	(rx (and "PRODUCTVERSION" (1+ space)
	121	(submatch (1+ (in "0-9,"))))))
	122	(set-version-in-file root "nt/emacsclient.rc" comma-space-version
	123	(rx (and "\"FileVersion\"" (0+ space) ?, (0+ space)
	124	?\" (submatch (1+ (in "0-9, "))) "\\0\"")))
	125	(set-version-in-file root "nt/emacsclient.rc" comma-space-version
95f76284 JR	126	(rx (and "\"ProductVersion\"" (0+ space) ?,
95f76284 JR	127	(0+ space) ?\" (submatch (1+ (in "0-9, ")))
9e2a2647	128	"\\0\""))))
d3841127 GM	129	;; nextstep.
	130	(set-version-in-file
	131	root "nextstep/Cocoa/Emacs.base/Contents/Info.plist"
	132	version (rx (and "CFBundleGetInfoString" (1+ anything) "Emacs" (1+ space)
	133	(submatch (1+ (in "0-9."))))))
	134	(set-version-in-file
	135	root "nextstep/Cocoa/Emacs.base/Contents/Info.plist"
91236f63 GM	136	version (rx (and "CFBundleShortVersionString" (1+ not-newline) ?\n
91236f63 GM	137	(0+ not-newline) "<string>" (0+ space)
d3841127 GM	138	(submatch (1+ (in "0-9."))))))
	139	(set-version-in-file
	140	root "nextstep/Cocoa/Emacs.base/Contents/Resources/English.lproj/InfoPlist.strings"
	141	version (rx (and "CFBundleShortVersionString" (0+ space) ?= (0+ space)
	142	?\" (0+ space) "Version" (1+ space)
	143	(submatch (1+ (in "0-9."))))))
	144	(set-version-in-file
	145	root "nextstep/Cocoa/Emacs.base/Contents/Resources/English.lproj/InfoPlist.strings"
	146	version (rx (and "CFBundleGetInfoString" (0+ space) ?= (0+ space)
	147	?\" (0+ space) "Emacs version" (1+ space)
	148	(submatch (1+ (in "0-9."))))))
91236f63 GM	149	(set-version-in-file
	150	root "nextstep/GNUstep/Emacs.base/Resources/Info-gnustep.plist"
	151	version (rx (and "ApplicationRelease" (0+ space) ?= (0+ space)
	152	?\" (0+ space) (submatch (1+ (in "0-9."))))))
d3841127 GM	153	(set-version-in-file
	154	root "nextstep/GNUstep/Emacs.base/Resources/Info-gnustep.plist"
	155	version (rx (and "FullVersionID" (0+ space) ?= (0+ space)
	156	?\" (0+ space) "Emacs" (1+ space)
91236f63 GM	157	(submatch (1+ (in "0-9."))))))
	158	(set-version-in-file
	159	root "nextstep/GNUstep/Emacs.base/Resources/Emacs.desktop"
	160	version (rx (and "Version=" (submatch (1+ (in "0-9.")))))))
3f4a4bdf	161
a3045b7e	162	;; Note this makes some assumptions about form of short copyright.
6916ec08	163	;; FIXME add the \year in the refcards/*.tex files.
a3045b7e GM	164	(defun set-copyright (root copyright)
	165	"Set Emacs short copyright to COPYRIGHT in relevant files under ROOT.
	166	Root must be the root of an Emacs source tree."
	167	(interactive (list
	168	(read-directory-name "Emacs root directory: " nil nil t)
	169	(read-string
	170	"Short copyright string: "
	171	(format "Copyright (C) %s Free Software Foundation, Inc."
	172	(format-time-string "%Y")))))
	173	(unless (file-exists-p (expand-file-name "src/emacs.c" root))
	174	(error "%s doesn't seem to be the root of an Emacs source tree" root))
e45b9e19 KR	175	(set-version-in-file root "src/emacs.c" copyright
e45b9e19 KR	176	(rx (and "emacs_copyright" (0+ (not (in ?\")))
a3045b7e	177	?\" (submatch (1+ (not (in ?\")))) ?\")))
a70c9a7a GM	178	(set-version-in-file root "lib-src/ebrowse.c" copyright
	179	(rx (and "emacs_copyright" (0+ (not (in ?\")))
	180	?\" (submatch (1+ (not (in ?\")))) ?\")))
a3045b7e GM	181	(set-version-in-file root "lib-src/etags.c" copyright
	182	(rx (and "emacs_copyright" (0+ (not (in ?\")))
	183	?\" (submatch (1+ (not (in ?\")))) ?\")))
	184	(set-version-in-file root "lib-src/rcs2log" copyright
	185	(rx (and "Copyright" (0+ space) ?= (0+ space)
	186	?\' (submatch (1+ nonl)))))
a3045b7e GM	187	;; This one is a nuisance, as it needs to be split over two lines.
a3045b7e GM	188	(string-match "\\(.[0-9]\\{4\\} \\)\\(.*\\)" copyright)
d3841127 GM	189	;; nextstep.
	190	(set-version-in-file
	191	root "nextstep/Cocoa/Emacs.base/Contents/Info.plist"
	192	copyright (rx (and "CFBundleGetInfoString" (1+ anything) "Emacs" (1+ space)
	193	(1+ (in "0-9.")) (1+ space)
	194	(submatch (1+ (not (in ?\<)))))))
	195	(set-version-in-file
	196	root "nextstep/Cocoa/Emacs.base/Contents/Resources/English.lproj/InfoPlist.strings"
	197	copyright (rx (and "NSHumanReadableCopyright" (0+ space) ?\= (0+ space)
7963f8ab GM	198	?\" (submatch (1+ (not (in ?\")))))))
	199	(set-version-in-file
	200	root "nextstep/GNUstep/Emacs.base/Resources/Info-gnustep.plist"
	201	copyright (rx (and "Copyright" (0+ space) ?\= (0+ space)
	202	?\" (submatch (1+ (not (in ?\"))))))))
a3045b7e	203
69c52df1 GM	204	(provide 'admin)
69c52df1 GM	205
d3841127	206	;;; admin.el ends here