diff options
author | Eli Zaretskii <eliz@gnu.org> | 2019-04-06 11:48:36 +0300 |
---|---|---|
committer | Eli Zaretskii <eliz@gnu.org> | 2019-04-06 11:48:36 +0300 |
commit | 646d33dbbced04b3454fa5f726309dd96cd089c7 (patch) | |
tree | d258eb814777d32ede90a60970921462fad8e506 /lisp/vc | |
parent | a30a6c3019ac09ede1cc47671083b2e9ecdbffdf (diff) | |
download | emacs-646d33dbbced04b3454fa5f726309dd96cd089c7.tar.gz |
Fix doc strings of 'vc-version-diff' and 'vc-version-ediff'
* lisp/vc/vc.el (vc-version-diff, vc-version-ediff): Describe
arguments in the doc strings. (Bug#35019)
Diffstat (limited to 'lisp/vc')
-rw-r--r-- | lisp/vc/vc.el | 17 |
1 files changed, 14 insertions, 3 deletions
diff --git a/lisp/vc/vc.el b/lisp/vc/vc.el index 326284f4446..353299cbed9 100644 --- a/lisp/vc/vc.el +++ b/lisp/vc/vc.el @@ -1814,7 +1814,12 @@ Return t if the buffer had changes, nil otherwise." ;;;###autoload (defun vc-version-diff (_files rev1 rev2) - "Report diffs between revisions of the fileset in the repository history." + "Report diffs between revisions REV1 and REV2 in the repository history. +This compares two revisions of the current fileset. +If REV1 is nil, it defaults to the current revision, i.e. revision +of the last commit. +If REV2 is nil, it defaults to the work tree, i.e. the current +state of each file in the fileset." (interactive (vc-diff-build-argument-list-internal)) ;; All that was just so we could do argument completion! (when (and (not rev1) rev2) @@ -1846,8 +1851,14 @@ saving the buffer." ;;;###autoload (defun vc-version-ediff (files rev1 rev2) - "Show differences between revisions of the fileset in the -repository history using ediff." + "Show differences between REV1 and REV2 of FILES using ediff. +This compares two revisions of the files in FILES. Currently, +only a single file's revisions can be compared, i.e. FILES can +specify only one file name. +If REV1 is nil, it defaults to the current revision, i.e. revision +of the last commit. +If REV2 is nil, it defaults to the work tree, i.e. the current +state of each file in FILES." (interactive (vc-diff-build-argument-list-internal)) ;; All that was just so we could do argument completion! (when (and (not rev1) rev2) |