Doc fixes for emacs-bzr-* facilities.

[bpt/emacs.git] / lisp / version.el

;;; version.el --- record version number of Emacs

;; Copyright (C) 1985, 1992, 1994-1995, 1999-2012
;;   Free Software Foundation, Inc.

;; Maintainer: FSF
;; Keywords: internal
;; Package: emacs

;; 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:

;; This file is loaded uncompiled when dumping Emacs.
;; Doc-strings should adhere to the conventions of make-docfile.

;;; Code:

(defconst emacs-major-version (progn (string-match "^[0-9]+" emacs-version) (string-to-number (match-string 0 emacs-version))) "\
Major version number of this version of Emacs.
This variable first existed in version 19.23.")

(defconst emacs-minor-version (progn (string-match "^[0-9]+\\.\\([0-9]+\\)" emacs-version) (string-to-number (match-string 1 emacs-version))) "\
Minor version number of this version of Emacs.
This variable first existed in version 19.23.")

(defconst emacs-build-time (current-time) "\
Time at which Emacs was dumped out.")

(defconst emacs-build-system (system-name) "\
Name of the system on which Emacs was built.")

(defun emacs-version (&optional here) "\
Return string describing the version of Emacs that is running.
If optional argument HERE is non-nil, insert string at point.
Don't use this function in programs to choose actions according
to the system configuration; look at `system-configuration' instead."
  (interactive "P")
  (let ((version-string
         (format (if (not (called-interactively-p 'interactive))
		     "GNU Emacs %s (%s%s%s)\n of %s on %s"
		   "GNU Emacs %s (%s%s%s) of %s on %s")
                 emacs-version
		 system-configuration
		 (cond ((featurep 'motif)
			(concat ", " (substring motif-version-string 4)))
		       ((featurep 'gtk)
			(concat ", GTK+ Version " gtk-version-string))
		       ((featurep 'x-toolkit) ", X toolkit")
		       ((featurep 'ns)
			(format ", NS %s" ns-version-string))
		       (t ""))
		 (if (and (boundp 'x-toolkit-scroll-bars)
			  (memq x-toolkit-scroll-bars '(xaw xaw3d)))
		     (format ", %s scroll bars"
			     (capitalize (symbol-name x-toolkit-scroll-bars)))
		   "")
		 (format-time-string "%Y-%m-%d" emacs-build-time)
                 emacs-build-system)))
    (if here
        (insert version-string)
      (if (called-interactively-p 'interactive)
          (message "%s" version-string)
        version-string))))

;; We hope that this alias is easier for people to find.
(defalias 'version 'emacs-version)

;; Set during dumping, this is a defvar so that it can be setq'd.
(defvar emacs-bzr-version nil "\
String giving the bzr revision from which this Emacs was built.
Value is the bzr revision number and a revision ID separated by a blank.
Value is nil if Emacs was not built from a bzr checkout, or if we could
not determine the revision.")

(defun emacs-bzr-get-version (&optional dir) "\
Try to return as a string the bzr revision number of the Emacs sources.
Value is the bzr revision number and a revision ID separated by a blank.
Value is nil if the sources do not seem to be under bzr, or if we could
not determine the revision.  Note that this reports on the current state
of the sources, which may not correspond to the running Emacs.

Optional argument DIR is a directory to use instead of `source-directory'."
  (or dir (setq dir source-directory))
  (when (file-directory-p (setq dir (expand-file-name ".bzr/branch" dir)))
    (let (file loc)
      (cond ((file-readable-p
              (setq file (expand-file-name "last-revision" dir)))
             (with-temp-buffer
               (insert-file-contents file)
               (goto-char (point-max))
               (if (looking-back "\n")
                   (delete-char -1))
               (buffer-string)))
            ;; OK, no last-revision.  Is it a lightweight checkout?
            ((file-readable-p
              (setq file (expand-file-name "location" dir)))
             ;; If the parent branch is local, try looking there for the revid.
             (if (setq loc (with-temp-buffer
                             (insert-file-contents file)
                             (if (looking-at "file://\\(.*\\)")
                                 (match-string 1))))
                 (emacs-bzr-get-version loc)))
            ;; Could fall back to eg `bzr testament' at this point.
            ))))

;; We put version info into the executable in the form that `ident' uses.
(or (eq system-type 'windows-nt)
    (purecopy (concat "\n$Id: " (subst-char-in-string ?\n ?\s (emacs-version))
		      " $\n")))

;; Local Variables:
;; version-control: never
;; no-byte-compile: t
;; End:

;;; version.el ends here