]> git.eshelyaron.com Git - emacs.git/commitdiff
Improve documentation of 'emacs-version'
authorEli Zaretskii <eliz@gnu.org>
Wed, 2 Feb 2022 17:38:56 +0000 (19:38 +0200)
committerEli Zaretskii <eliz@gnu.org>
Wed, 2 Feb 2022 17:38:56 +0000 (19:38 +0200)
* doc/emacs/trouble.texi (Checklist): Mention the possibility of
invoking 'emacs-version' with a prefix argument.

* lisp/version.el (emacs-version): Improve doc string.  (Bug#53720)

doc/emacs/trouble.texi
lisp/version.el

index e966565f0008420b444bba3182bb6e6351cdd158..93f9c779dbf9d71d783f87da0219368598a7314d 100644 (file)
@@ -782,10 +782,12 @@ Emacs, so you will have to report the bug somewhere else.
 
 @item
 The type of machine you are using, and the operating system name and
-version number (again, automatically included by @kbd{M-x
-report-emacs-bug}).  @kbd{M-x emacs-version @key{RET}} provides this
-information too.  Copy its output from the @file{*Messages*} buffer,
-so that you get it all and get it accurately.
+version number (again, automatically included by @w{@kbd{M-x
+report-emacs-bug}}).  @w{@kbd{M-x emacs-version @key{RET}}} provides
+this information too.  Copy its output from the @file{*Messages*}
+buffer, so that you get it all and get it accurately, or use
+@w{@kbd{C-u M-x emacs-version @key{RET}}} to insert the version
+information into the current buffer.
 
 @item
 The operands given to the @code{configure} command when Emacs was
index e0b74d05cc3a83b439379fe1ed93f45d19f6f4c5..fa755c78676ff71b9dfdd50693d1a2c51467de28 100644 (file)
@@ -54,8 +54,13 @@ developing Emacs.")
 (defvar cairo-version-string)
 
 (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.
+  "Display the version of Emacs that is running in this session.
+With a prefix argument, insert the Emacs version string at point
+instead of displaying it.
+If called from Lisp, by default return the version string; but
+if the optional argument HERE is non-nil, insert the string at
+point instead.
+
 Don't use this function in programs to choose actions according
 to the system configuration; look at `system-configuration' instead."
   (interactive "P")