(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."))))))
(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-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))))
(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)
;;; admin.el ends here
HCoop / bpt / emacs.git / blobdiff