]> git.eshelyaron.com Git - emacs.git/commitdiff
* lisp/vc/vc.el: Update specification of print-log backend function.
authorSean Whitton <spwhitton@spwhitton.name>
Fri, 6 Jun 2025 08:49:37 +0000 (09:49 +0100)
committerEshel Yaron <me@eshelyaron.com>
Sat, 7 Jun 2025 20:01:41 +0000 (22:01 +0200)
(cherry picked from commit b3f4486b04d92fd1b34c43edb5c864f3cada234b)

lisp/vc/vc.el

index bccfecc18f9cf47c68d989b66b32d9bd92466035..44b309e784c4bae56daeb043098b4a291a216154 100644 (file)
 ;; * print-log (files buffer &optional shortlog start-revision limit)
 ;;
 ;;   Insert the revision log for FILES into BUFFER.
-;;   If SHORTLOG is true insert a short version of the log.
-;;   If LIMIT is true insert only insert LIMIT log entries.  If the
-;;   backend does not support limiting the number of entries to show
-;;   it should return `limit-unsupported'.
+;;   If SHORTLOG is non-nil insert a short version of the log.
+;;   If LIMIT is non-nil insert only insert LIMIT log entries.
+;;   When LIMIT is a string it means stop at that revision.
+;;   If the backend does not support limiting the number of entries to
+;;   show it should return `limit-unsupported'.
 ;;   If START-REVISION is given, then show the log starting from that
 ;;   revision ("starting" in the sense of it being the _newest_
 ;;   revision shown, rather than the working revision, which is normally
-;;   the case).  Not all backends support this.  At present, this is
-;;   only ever used with LIMIT = 1 (by vc-annotate-show-log-revision-at-line).
+;;   the case).  Not all backends support this.
 ;;
 ;; * log-outgoing (buffer remote-location)
 ;;