From: Glenn Morris <rgm@gnu.org>
Date: Sun, 21 Apr 2013 00:37:54 +0000 (-0700)
Subject: vc.el doc fixes
X-Git-Tag: emacs-24.3.90~173^2^2~42^2~45^2~387^2~2026^2~413
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=1b42ee4390648fa29ecc1243be6dbee4414d3d69;p=emacs.git

vc.el doc fixes

* lisp/vc/vc.el (vc-print-log-setup-buttons, vc-print-log-internal):
Add doc strings.
(vc-print-log): Clarify interactive prompt.
---

diff --git a/lisp/ChangeLog b/lisp/ChangeLog
index 07a5bb9231d..c791affe2f2 100644
--- a/lisp/ChangeLog
+++ b/lisp/ChangeLog
@@ -1,3 +1,9 @@
+2013-04-21  Glenn Morris  <rgm@gnu.org>
+
+	* vc/vc.el (vc-print-log-setup-buttons, vc-print-log-internal):
+	Add doc strings.
+	(vc-print-log): Clarify interactive prompt.
+
 2013-04-20  Glenn Morris  <rgm@gnu.org>
 
 	* emacs-lisp/bytecomp.el (byte-compile-insert-header):
diff --git a/lisp/vc/vc.el b/lisp/vc/vc.el
index a0ef6f9d6d7..7f03affb6b7 100644
--- a/lisp/vc/vc.el
+++ b/lisp/vc/vc.el
@@ -2084,6 +2084,11 @@ Not all VC backends support short logs!")
 (defvar log-view-vc-fileset)
 
 (defun vc-print-log-setup-buttons (working-revision is-start-revision limit pl-return)
+  "Insert at the end of the current buffer buttons to show more log entries.
+In the new log, leave point at WORKING-REVISION (if non-nil).
+LIMIT is the number of entries currently shown.
+Does nothing if IS-START-REVISION is non-nil, or if LIMIT is nil,
+or if PL-RETURN is 'limit-unsupported."
   (when (and limit (not (eq 'limit-unsupported pl-return))
 	     (not is-start-revision))
     (goto-char (point-max))
@@ -2104,6 +2109,17 @@ Not all VC backends support short logs!")
 
 (defun vc-print-log-internal (backend files working-revision
                                       &optional is-start-revision limit)
+  "For specified BACKEND and FILES, show the VC log.
+Leave point at WORKING-REVISION, if it is non-nil.
+If IS-START-REVISION is non-nil, start the log from WORKING-REVISION.
+Show up to LIMIT entries (non-nil means unlimited).
+\(IS-START-REVISION non-nil might not work correctly if LIMIT is not 1.)"
+  ;; The parenthetical remark is based on the commentary of vc.el for
+  ;; "print log": "At this point START-REVISION is only required to work
+  ;; in conjunction with LIMIT = 1."  The only thing that passes
+  ;; IS-START-REVISION non-nil is vc-annotate-show-log-revision-at-line,
+  ;; which sets LIMIT = 1.
+
   ;; Don't switch to the output buffer before running the command,
   ;; so that any buffer-local settings in the vc-controlled
   ;; buffer can be accessed by the command.
@@ -2189,7 +2205,7 @@ WORKING-REVISION and LIMIT."
   (interactive
    (cond
     (current-prefix-arg
-     (let ((rev (read-from-minibuffer "Log from revision (default: last revision): " nil
+     (let ((rev (read-from-minibuffer "Leave point at revision (default: last revision): " nil
 				      nil nil nil))
 	   (lim (string-to-number
 		 (read-from-minibuffer