summaryrefslogtreecommitdiff
path: root/lisp/version.el
diff options
context:
space:
mode:
authorEli Zaretskii <eliz@gnu.org>2012-04-20 08:47:55 +0300
committerEli Zaretskii <eliz@gnu.org>2012-04-20 08:47:55 +0300
commit539aa513944b1e780a7981f63a0cdf8d86f2303c (patch)
tree805adb2ab9eeb2aae7541b5bb55c2e6ae9b42ad3 /lisp/version.el
parentcfc7d5da20fbfe33c1d2e6d2f3c215e324446d87 (diff)
downloademacs-539aa513944b1e780a7981f63a0cdf8d86f2303c.tar.gz
Doc fixes for emacs-bzr-* facilities.
lisp/version.el (emacs-bzr-version, emacs-bzr-get-version): Doc fixes.
Diffstat (limited to 'lisp/version.el')
-rw-r--r--lisp/version.el8
1 files changed, 5 insertions, 3 deletions
diff --git a/lisp/version.el b/lisp/version.el
index 56e19147b2c..38be0e7fd57 100644
--- a/lisp/version.el
+++ b/lisp/version.el
@@ -81,13 +81,15 @@ to the system configuration; look at `system-configuration' instead."
;; Set during dumping, this is a defvar so that it can be setq'd.
(defvar emacs-bzr-version nil "\
-String giving the bzr revision number from which this Emacs was built.
-This is nil if Emacs was not built from a bzr checkout, or if we could
+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.
-Returns nil if the sources do not seem to be under bzr, or if we could
+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.