; * lisp/vc/vc.el (vc-clone): Fix wording of doc string.
authorEli Zaretskii <eliz@gnu.org>
Tue, 27 Feb 2024 13:11:58 +0000 (15:11 +0200)
committerEli Zaretskii <eliz@gnu.org>
Tue, 27 Feb 2024 13:11:58 +0000 (15:11 +0200)
lisp/vc/vc.el

index 549eae6e66361c38d3dceefc247365491d938090..25540406b4eb28572c2dc995afb1c7caf881b44c 100644 (file)
@@ -3676,11 +3676,16 @@ to provide the `find-revision' operation instead."
   (vc-call-backend (vc-backend buffer-file-name) 'check-headers))
 
 (defun vc-clone (remote &optional backend directory rev)
-  "Use BACKEND to clone REMOTE into DIRECTORY.
-If successful, returns the string with the directory of the
-checkout.  If BACKEND is nil, iterate through every known backend
-in `vc-handled-backends' until one succeeds.  If REV is non-nil,
-it indicates a specific revision to check out."
+  "Clone repository REMOTE using version-control BACKEND, into DIRECTORY.
+If successful, return the string with the directory of the checkout;
+otherwise return nil.
+REMOTE should be a string, the URL of the remote repository or the name
+of a directory (if the repository is local).
+If DIRECTORY is nil or omitted, it defaults to `default-directory'.
+If BACKEND is nil or omitted, the function iterates through every known
+backend in `vc-handled-backends' until one succeeds to clone REMOTE.
+If REV is non-nil, it indicates a specific revision to check out after
+cloning; the syntax of REV depends on what BACKEND accepts."
   (unless directory
     (setq directory default-directory))
   (if backend