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

This commit is contained in:
Sean Whitton 2025-07-05 09:32:29 +01:00
parent 34dad30e49
commit 3480abd67d

View file

@ -2455,6 +2455,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.
@ -2473,14 +2474,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"
@ -3377,6 +3380,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))
@ -3394,6 +3398,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))