From: Sean Whitton <spwhitton@spwhitton.name>
Date: Sat, 5 Jul 2025 08:32:29 +0000 (+0100)
Subject: ; VC: Improve REMOTE-LOCATION docstrings, qualify remark in comment.
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=55855d27585fa7ce85fe00d1158ab35b132ca7a3;p=emacs.git

; VC: Improve REMOTE-LOCATION docstrings, qualify remark in comment.

(cherry picked from commit 3480abd67d1ca3b96fb314e2aca6510c18767eff)
---

diff --git a/lisp/vc/vc.el b/lisp/vc/vc.el
index 8cc0aa98f67..883aabac956 100644
--- a/lisp/vc/vc.el
+++ b/lisp/vc/vc.el
@@ -2450,6 +2450,7 @@ The merge base is a common ancestor between REV1 and REV2 revisions."
 ;;;###autoload
 (defun vc-root-diff-incoming (&optional remote-location)
   "Report diff of all changes that would be pulled from REMOTE-LOCATION.
+When unspecified REMOTE-LOCATION is the place \\[vc-update] would pull from.
 When called interactively with a prefix argument, prompt for REMOTE-LOCATION.
 In some version control systems REMOTE-LOCATION can be a remote branch name.
 
@@ -2468,14 +2469,16 @@ global binding."
 ;;;###autoload
 (defun vc-root-diff-outgoing (&optional remote-location)
   "Report diff of all changes that would be pushed to REMOTE-LOCATION.
+When unspecified REMOTE-LOCATION is the place \\[vc-push] would push to.
 When called interactively with a prefix argument, prompt for REMOTE-LOCATION.
 In some version control systems REMOTE-LOCATION can be a remote branch name.
 
 See `vc-use-incoming-outgoing-prefixes' regarding giving this command a
 global binding."
-  ;; For this command we want to ignore uncommitted changes because
-  ;; those are not outgoing, and the point is to make a comparison
-  ;; between locally committed changes and remote committed changes.
+  ;; For this command, for distributed VCS, we want to ignore
+  ;; uncommitted changes because those are not outgoing, and the point
+  ;; for those VCS is to make a comparison between locally committed
+  ;; changes and remote committed changes.
   ;; (Hence why we don't call `vc-buffer-sync-fileset'.)
   (interactive (vc--maybe-read-remote-location))
   (vc--with-backend-in-rootdir "VC root-diff"
@@ -3372,6 +3375,7 @@ The command prompts for the branch whose change log to show."
 ;;;###autoload
 (defun vc-log-incoming (&optional remote-location)
   "Show log of changes that will be received with pull from REMOTE-LOCATION.
+When unspecified REMOTE-LOCATION is the place \\[vc-update] would pull from.
 When called interactively with a prefix argument, prompt for REMOTE-LOCATION.
 In some version control systems REMOTE-LOCATION can be a remote branch name."
   (interactive (vc--maybe-read-remote-location))
@@ -3389,6 +3393,7 @@ In some version control systems REMOTE-LOCATION can be a remote branch name."
 ;;;###autoload
 (defun vc-log-outgoing (&optional remote-location)
   "Show log of changes that will be sent with a push operation to REMOTE-LOCATION.
+When unspecified REMOTE-LOCATION is the place \\[vc-push] would push to.
 When called interactively with a prefix argument, prompt for REMOTE-LOCATION.
 In some version control systems REMOTE-LOCATION can be a remote branch name."
   (interactive (vc--maybe-read-remote-location))